diff --git a/.hgtags b/.hgtags index b8d857ecd41..bb92c51e18e 100644 --- a/.hgtags +++ b/.hgtags @@ -237,3 +237,5 @@ ad67c34f79c28a8e755f4a49f313868619d6702c jdk8-b112 4a4dbcf7cb7d3e1a81beaa3b11cd909f69ebc79a jdk8-b113 dfa34ab293faad9b543a24646dbb381bc3ab5586 jdk8-b114 3dd9732b17034f45d111996d1d50287b05a3998c jdk8-b115 +aaf663f591aba43ec942263b15ba62759ce26a1e jdk8-b116 +31b0e03fcad73d7886b306b4c2e57ad270780d0d jdk8-b117 diff --git a/.hgtags-top-repo b/.hgtags-top-repo index 263edf8e122..c287c936f24 100644 --- a/.hgtags-top-repo +++ b/.hgtags-top-repo @@ -237,3 +237,5 @@ d086227bfc45d124f09b3bd72a07956b4073bf71 jdk8-b111 6ba4c7cb623ec612031e05cf8bf279d8f407bd1e jdk8-b113 4f2011496393a26dcfd7b1f7787a3673ddd32599 jdk8-b114 763ada2a1d8c5962bc8c3d297e57c562d2e95338 jdk8-b115 +cbfe5da942c63ef865cab4a7159e01eff7d7fcf5 jdk8-b116 +a4afb0a8d55ef75aef5b0d77b434070468fb89f8 jdk8-b117 diff --git a/corba/.hgtags b/corba/.hgtags index db7d697f130..a4817b2887a 100644 --- a/corba/.hgtags +++ b/corba/.hgtags @@ -237,3 +237,5 @@ a4bb3b4500164748a9c33b2283cfda76d89f25ab jdk8-b108 a259ff3e42d91da68f4d4f09d7eb9dc22bc024fc jdk8-b113 0bbccf77c23e566170b88b52c2cf28e5d31ce927 jdk8-b114 8d07115924b7d703a5048adb24e8aba751442f13 jdk8-b115 +5fdc4465208933ba704825b2b05e1afd062235fb jdk8-b116 +e53d1ee4d2ae898f1cf58688d45a5afe7c482173 jdk8-b117 diff --git a/hotspot/.hgtags b/hotspot/.hgtags index 9f29bef92ea..63b77889c51 100644 --- a/hotspot/.hgtags +++ b/hotspot/.hgtags @@ -393,3 +393,7 @@ f6962730bbde82f279a0ae3a1c14bc5e58096c6e jdk8-b111 3b32d287da89a47a45d16f6d9ba5bd3cd9bf4b3e hs25-b57 9ebaac78a8a0061fb9597e07f806498cb626cdeb jdk8-b115 e510dfdec6dd701410f3398ed86ebcdff0cca63a hs25-b58 +52b076e6ffae247c1c7d8b7aba995195be2b6fc2 jdk8-b116 +c78d517c7ea47501b456e707afd4b78e7b5b202e hs25-b59 +f573d00213b7170c2ff856f9cd83cd148437f5b9 jdk8-b117 +abad3b2d905d9e1ad767c94baa94aba6ed5b207b hs25-b60 diff --git a/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/JInfo.java b/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/JInfo.java index 6f9cd0f41d2..bec93e65d9d 100644 --- a/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/JInfo.java +++ b/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/JInfo.java @@ -24,8 +24,9 @@ package sun.jvm.hotspot.tools; -import sun.jvm.hotspot.runtime.*; import sun.jvm.hotspot.debugger.JVMDebugger; +import sun.jvm.hotspot.runtime.Arguments; +import sun.jvm.hotspot.runtime.VM; public class JInfo extends Tool { public JInfo() { @@ -138,14 +139,33 @@ public class JInfo extends Tool { } private void printVMFlags() { + VM.Flag[] flags = VM.getVM().getCommandLineFlags(); + System.out.print("Non-default VM flags: "); + for (VM.Flag flag : flags) { + if (flag.getOrigin() == 0) { + // only print flags which aren't their defaults + continue; + } + if (flag.isBool()) { + String onoff = flag.getBool() ? "+" : "-"; + System.out.print("-XX:" + onoff + flag.getName() + " "); + } else { + System.out.print("-XX:" + flag.getName() + "=" + + flag.getValue() + " "); + } + } + System.out.println(); + + System.out.print("Command line: "); String str = Arguments.getJVMFlags(); if (str != null) { - System.out.println(str); + System.out.print(str + " "); } str = Arguments.getJVMArgs(); if (str != null) { - System.out.println(str); + System.out.print(str); } + System.out.println(); } private int mode; diff --git a/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/Tool.java b/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/Tool.java index 19cfb349da8..9fd86ccb347 100644 --- a/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/Tool.java +++ b/hotspot/agent/src/share/classes/sun/jvm/hotspot/tools/Tool.java @@ -25,11 +25,11 @@ package sun.jvm.hotspot.tools; import java.io.PrintStream; -import java.util.Hashtable; -import sun.jvm.hotspot.*; -import sun.jvm.hotspot.runtime.*; -import sun.jvm.hotspot.debugger.*; +import sun.jvm.hotspot.HotSpotAgent; +import sun.jvm.hotspot.debugger.DebuggerException; +import sun.jvm.hotspot.debugger.JVMDebugger; +import sun.jvm.hotspot.runtime.VM; // generic command line or GUI tool. // override run & code main as shown below. @@ -147,6 +147,7 @@ public abstract class Tool implements Runnable { } PrintStream err = System.err; + PrintStream out = System.out; int pid = 0; String coreFileName = null; @@ -180,18 +181,18 @@ public abstract class Tool implements Runnable { try { switch (debugeeType) { case DEBUGEE_PID: - err.println("Attaching to process ID " + pid + ", please wait..."); + out.println("Attaching to process ID " + pid + ", please wait..."); agent.attach(pid); break; case DEBUGEE_CORE: - err.println("Attaching to core " + coreFileName + + out.println("Attaching to core " + coreFileName + " from executable " + executableName + ", please wait..."); agent.attach(executableName, coreFileName); break; case DEBUGEE_REMOTE: - err.println("Attaching to remote server " + remoteServer + ", please wait..."); + out.println("Attaching to remote server " + remoteServer + ", please wait..."); agent.attach(remoteServer); break; } @@ -218,7 +219,7 @@ public abstract class Tool implements Runnable { return 1; } - err.println("Debugger attached successfully."); + out.println("Debugger attached successfully."); startInternal(); return 0; } @@ -237,14 +238,14 @@ public abstract class Tool implements Runnable { // Remains of the start mechanism, common to both start methods. private void startInternal() { - PrintStream err = System.err; + PrintStream out = System.out; VM vm = VM.getVM(); if (vm.isCore()) { - err.println("Core build detected."); + out.println("Core build detected."); } else if (vm.isClientCompiler()) { - err.println("Client compiler detected."); + out.println("Client compiler detected."); } else if (vm.isServerCompiler()) { - err.println("Server compiler detected."); + out.println("Server compiler detected."); } else { throw new RuntimeException("Fatal error: " + "should have been able to detect core/C1/C2 build"); @@ -252,8 +253,8 @@ public abstract class Tool implements Runnable { String version = vm.getVMRelease(); if (version != null) { - err.print("JVM version is "); - err.println(version); + out.print("JVM version is "); + out.println(version); } run(); diff --git a/hotspot/make/hotspot_version b/hotspot/make/hotspot_version index ef45285a489..501e9e62cfd 100644 --- a/hotspot/make/hotspot_version +++ b/hotspot/make/hotspot_version @@ -35,7 +35,7 @@ HOTSPOT_VM_COPYRIGHT=Copyright 2013 HS_MAJOR_VER=25 HS_MINOR_VER=0 -HS_BUILD_NUMBER=58 +HS_BUILD_NUMBER=60 JDK_MAJOR_VER=1 JDK_MINOR_VER=8 diff --git a/hotspot/src/cpu/sparc/vm/sharedRuntime_sparc.cpp b/hotspot/src/cpu/sparc/vm/sharedRuntime_sparc.cpp index 62ff0f23b2b..4b6b1c7c00d 100644 --- a/hotspot/src/cpu/sparc/vm/sharedRuntime_sparc.cpp +++ b/hotspot/src/cpu/sparc/vm/sharedRuntime_sparc.cpp @@ -1002,18 +1002,6 @@ void AdapterGenerator::gen_i2c_adapter( // and the vm will find there should this case occur. Address callee_target_addr(G2_thread, JavaThread::callee_target_offset()); __ st_ptr(G5_method, callee_target_addr); - - if (StressNonEntrant) { - // Open a big window for deopt failure - __ save_frame(0); - __ mov(G0, L0); - Label loop; - __ bind(loop); - __ sub(L0, 1, L0); - __ br_null_short(L0, Assembler::pt, loop); - __ restore(); - } - __ jmpl(G3, 0, G0); __ delayed()->nop(); } diff --git a/hotspot/src/cpu/x86/vm/sharedRuntime_x86_32.cpp b/hotspot/src/cpu/x86/vm/sharedRuntime_x86_32.cpp index 0fce7952a70..003e70b8066 100644 --- a/hotspot/src/cpu/x86/vm/sharedRuntime_x86_32.cpp +++ b/hotspot/src/cpu/x86/vm/sharedRuntime_x86_32.cpp @@ -3001,6 +3001,10 @@ void SharedRuntime::generate_deopt_blob() { // sp should be pointing at the return address to the caller (3) + // Pick up the initial fp we should save + // restore rbp before stack bang because if stack overflow is thrown it needs to be pushed (and preserved) + __ movptr(rbp, Address(rdi, Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); + // Stack bang to make sure there's enough room for these interpreter frames. if (UseStackBanging) { __ movl(rbx, Address(rdi ,Deoptimization::UnrollBlock::total_frame_sizes_offset_in_bytes())); @@ -3020,9 +3024,6 @@ void SharedRuntime::generate_deopt_blob() { __ movl(rbx, Address(rdi, Deoptimization::UnrollBlock::number_of_frames_offset_in_bytes())); __ movl(counter, rbx); - // Pick up the initial fp we should save - __ movptr(rbp, Address(rdi, Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); - // Now adjust the caller's stack to make up for the extra locals // but record the original sp so that we can save it in the skeletal interpreter // frame and the stack walking of interpreter_sender will get the unextended sp @@ -3220,6 +3221,10 @@ void SharedRuntime::generate_uncommon_trap_blob() { // sp should be pointing at the return address to the caller (3) + // Pick up the initial fp we should save + // restore rbp before stack bang because if stack overflow is thrown it needs to be pushed (and preserved) + __ movptr(rbp, Address(rdi, Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); + // Stack bang to make sure there's enough room for these interpreter frames. if (UseStackBanging) { __ movl(rbx, Address(rdi ,Deoptimization::UnrollBlock::total_frame_sizes_offset_in_bytes())); @@ -3240,9 +3245,6 @@ void SharedRuntime::generate_uncommon_trap_blob() { __ movl(rbx, Address(rdi, Deoptimization::UnrollBlock::number_of_frames_offset_in_bytes())); __ movl(counter, rbx); - // Pick up the initial fp we should save - __ movptr(rbp, Address(rdi, Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); - // Now adjust the caller's stack to make up for the extra locals // but record the original sp so that we can save it in the skeletal interpreter // frame and the stack walking of interpreter_sender will get the unextended sp diff --git a/hotspot/src/cpu/x86/vm/sharedRuntime_x86_64.cpp b/hotspot/src/cpu/x86/vm/sharedRuntime_x86_64.cpp index cbe960556dc..fbd344c57b5 100644 --- a/hotspot/src/cpu/x86/vm/sharedRuntime_x86_64.cpp +++ b/hotspot/src/cpu/x86/vm/sharedRuntime_x86_64.cpp @@ -3471,6 +3471,10 @@ void SharedRuntime::generate_deopt_blob() { // rsp should be pointing at the return address to the caller (3) + // Pick up the initial fp we should save + // restore rbp before stack bang because if stack overflow is thrown it needs to be pushed (and preserved) + __ movptr(rbp, Address(rdi, Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); + // Stack bang to make sure there's enough room for these interpreter frames. if (UseStackBanging) { __ movl(rbx, Address(rdi, Deoptimization::UnrollBlock::total_frame_sizes_offset_in_bytes())); @@ -3489,9 +3493,6 @@ void SharedRuntime::generate_deopt_blob() { // Load counter into rdx __ movl(rdx, Address(rdi, Deoptimization::UnrollBlock::number_of_frames_offset_in_bytes())); - // Pick up the initial fp we should save - __ movptr(rbp, Address(rdi, Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); - // Now adjust the caller's stack to make up for the extra locals // but record the original sp so that we can save it in the skeletal interpreter // frame and the stack walking of interpreter_sender will get the unextended sp @@ -3663,6 +3664,10 @@ void SharedRuntime::generate_uncommon_trap_blob() { // rsp should be pointing at the return address to the caller (3) + // Pick up the initial fp we should save + // restore rbp before stack bang because if stack overflow is thrown it needs to be pushed (and preserved) + __ movptr(rbp, Address(rdi, Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); + // Stack bang to make sure there's enough room for these interpreter frames. if (UseStackBanging) { __ movl(rbx, Address(rdi ,Deoptimization::UnrollBlock::total_frame_sizes_offset_in_bytes())); @@ -3670,27 +3675,16 @@ void SharedRuntime::generate_uncommon_trap_blob() { } // Load address of array of frame pcs into rcx (address*) - __ movptr(rcx, - Address(rdi, - Deoptimization::UnrollBlock::frame_pcs_offset_in_bytes())); + __ movptr(rcx, Address(rdi, Deoptimization::UnrollBlock::frame_pcs_offset_in_bytes())); // Trash the return pc __ addptr(rsp, wordSize); // Load address of array of frame sizes into rsi (intptr_t*) - __ movptr(rsi, Address(rdi, - Deoptimization::UnrollBlock:: - frame_sizes_offset_in_bytes())); + __ movptr(rsi, Address(rdi, Deoptimization::UnrollBlock:: frame_sizes_offset_in_bytes())); // Counter - __ movl(rdx, Address(rdi, - Deoptimization::UnrollBlock:: - number_of_frames_offset_in_bytes())); // (int) - - // Pick up the initial fp we should save - __ movptr(rbp, - Address(rdi, - Deoptimization::UnrollBlock::initial_info_offset_in_bytes())); + __ movl(rdx, Address(rdi, Deoptimization::UnrollBlock:: number_of_frames_offset_in_bytes())); // (int) // Now adjust the caller's stack to make up for the extra locals but // record the original sp so that we can save it in the skeletal @@ -3700,9 +3694,7 @@ void SharedRuntime::generate_uncommon_trap_blob() { const Register sender_sp = r8; __ mov(sender_sp, rsp); - __ movl(rbx, Address(rdi, - Deoptimization::UnrollBlock:: - caller_adjustment_offset_in_bytes())); // (int) + __ movl(rbx, Address(rdi, Deoptimization::UnrollBlock:: caller_adjustment_offset_in_bytes())); // (int) __ subptr(rsp, rbx); // Push interpreter frames in a loop diff --git a/hotspot/src/share/vm/c1/c1_GraphBuilder.cpp b/hotspot/src/share/vm/c1/c1_GraphBuilder.cpp index 26bb8d0227e..1bfd4bad45d 100644 --- a/hotspot/src/share/vm/c1/c1_GraphBuilder.cpp +++ b/hotspot/src/share/vm/c1/c1_GraphBuilder.cpp @@ -4338,6 +4338,11 @@ void GraphBuilder::print_stats() { #endif // PRODUCT void GraphBuilder::profile_call(ciMethod* callee, Value recv, ciKlass* known_holder, Values* obj_args, bool inlined) { + // A default method's holder is an interface + if (known_holder != NULL && known_holder->is_interface()) { + assert(known_holder->is_instance_klass() && ((ciInstanceKlass*)known_holder)->has_default_methods(), "should be default method"); + known_holder = NULL; + } append(new ProfileCall(method(), bci(), callee, recv, known_holder, obj_args, inlined)); } diff --git a/hotspot/src/share/vm/c1/c1_LIRGenerator.cpp b/hotspot/src/share/vm/c1/c1_LIRGenerator.cpp index e3098911d88..8eb0189881c 100644 --- a/hotspot/src/share/vm/c1/c1_LIRGenerator.cpp +++ b/hotspot/src/share/vm/c1/c1_LIRGenerator.cpp @@ -2574,8 +2574,25 @@ void LIRGenerator::do_Goto(Goto* x) { __ jump(x->default_sux()); } - -ciKlass* LIRGenerator::profile_arg_type(ciMethodData* md, int md_base_offset, int md_offset, intptr_t profiled_k, Value arg, LIR_Opr& mdp, bool not_null, ciKlass* signature_k) { +/** + * Emit profiling code if needed for arguments, parameters, return value types + * + * @param md MDO the code will update at runtime + * @param md_base_offset common offset in the MDO for this profile and subsequent ones + * @param md_offset offset in the MDO (on top of md_base_offset) for this profile + * @param profiled_k current profile + * @param obj IR node for the object to be profiled + * @param mdp register to hold the pointer inside the MDO (md + md_base_offset). + * Set once we find an update to make and use for next ones. + * @param not_null true if we know obj cannot be null + * @param signature_at_call_k signature at call for obj + * @param callee_signature_k signature of callee for obj + * at call and callee signatures differ at method handle call + * @return the only klass we know will ever be seen at this profile point + */ +ciKlass* LIRGenerator::profile_type(ciMethodData* md, int md_base_offset, int md_offset, intptr_t profiled_k, + Value obj, LIR_Opr& mdp, bool not_null, ciKlass* signature_at_call_k, + ciKlass* callee_signature_k) { ciKlass* result = NULL; bool do_null = !not_null && !TypeEntries::was_null_seen(profiled_k); bool do_update = !TypeEntries::is_type_unknown(profiled_k); @@ -2590,9 +2607,9 @@ ciKlass* LIRGenerator::profile_arg_type(ciMethodData* md, int md_base_offset, in if (do_update) { // try to find exact type, using CHA if possible, so that loading // the klass from the object can be avoided - ciType* type = arg->exact_type(); + ciType* type = obj->exact_type(); if (type == NULL) { - type = arg->declared_type(); + type = obj->declared_type(); type = comp->cha_exact_type(type); } assert(type == NULL || type->is_klass(), "type should be class"); @@ -2608,23 +2625,33 @@ ciKlass* LIRGenerator::profile_arg_type(ciMethodData* md, int md_base_offset, in ciKlass* exact_signature_k = NULL; if (do_update) { // Is the type from the signature exact (the only one possible)? - exact_signature_k = signature_k->exact_klass(); + exact_signature_k = signature_at_call_k->exact_klass(); if (exact_signature_k == NULL) { - exact_signature_k = comp->cha_exact_type(signature_k); + exact_signature_k = comp->cha_exact_type(signature_at_call_k); } else { result = exact_signature_k; - do_update = false; // Known statically. No need to emit any code: prevent // LIR_Assembler::emit_profile_type() from emitting useless code profiled_k = ciTypeEntries::with_status(result, profiled_k); } if (exact_signature_k != NULL && exact_klass != exact_signature_k) { - assert(exact_klass == NULL, "arg and signature disagree?"); + assert(exact_klass == NULL, "obj and signature disagree?"); // sometimes the type of the signature is better than the best type // the compiler has exact_klass = exact_signature_k; - do_update = exact_klass == NULL || ciTypeEntries::valid_ciklass(profiled_k) != exact_klass; } + if (callee_signature_k != NULL && + callee_signature_k != signature_at_call_k) { + ciKlass* improved_klass = callee_signature_k->exact_klass(); + if (improved_klass == NULL) { + improved_klass = comp->cha_exact_type(callee_signature_k); + } + if (improved_klass != NULL && exact_klass != improved_klass) { + assert(exact_klass == NULL, "obj and signature disagree?"); + exact_klass = exact_signature_k; + } + } + do_update = exact_klass == NULL || ciTypeEntries::valid_ciklass(profiled_k) != exact_klass; } if (!do_null && !do_update) { @@ -2640,7 +2667,7 @@ ciKlass* LIRGenerator::profile_arg_type(ciMethodData* md, int md_base_offset, in __ leal(LIR_OprFact::address(base_type_address), mdp); } } - LIRItem value(arg, this); + LIRItem value(obj, this); value.load_item(); __ profile_type(new LIR_Address(mdp, md_offset, T_METADATA), value.result(), exact_klass, profiled_k, new_pointer_register(), not_null, exact_signature_k != NULL); @@ -2665,9 +2692,9 @@ void LIRGenerator::profile_parameters(Base* x) { if (t == T_OBJECT || t == T_ARRAY) { intptr_t profiled_k = parameters->type(j); Local* local = x->state()->local_at(java_index)->as_Local(); - ciKlass* exact = profile_arg_type(md, md->byte_offset_of_slot(parameters_type_data, ParametersTypeData::type_offset(0)), - in_bytes(ParametersTypeData::type_offset(j)) - in_bytes(ParametersTypeData::type_offset(0)), - profiled_k, local, mdp, false, local->declared_type()->as_klass()); + ciKlass* exact = profile_type(md, md->byte_offset_of_slot(parameters_type_data, ParametersTypeData::type_offset(0)), + in_bytes(ParametersTypeData::type_offset(j)) - in_bytes(ParametersTypeData::type_offset(0)), + profiled_k, local, mdp, false, local->declared_type()->as_klass(), NULL); // If the profile is known statically set it once for all and do not emit any code if (exact != NULL) { md->set_parameter_type(j, exact); @@ -3129,19 +3156,28 @@ void LIRGenerator::profile_arguments(ProfileCall* x) { Bytecodes::Code bc = x->method()->java_code_at_bci(bci); int start = 0; int stop = data->is_CallTypeData() ? ((ciCallTypeData*)data)->number_of_arguments() : ((ciVirtualCallTypeData*)data)->number_of_arguments(); - if (x->nb_profiled_args() < stop) { - // if called through method handle invoke, some arguments may have been popped - stop = x->nb_profiled_args(); + if (x->inlined() && x->callee()->is_static() && Bytecodes::has_receiver(bc)) { + // first argument is not profiled at call (method handle invoke) + assert(x->method()->raw_code_at_bci(bci) == Bytecodes::_invokehandle, "invokehandle expected"); + start = 1; } - ciSignature* sig = x->callee()->signature(); + ciSignature* callee_signature = x->callee()->signature(); // method handle call to virtual method bool has_receiver = x->inlined() && !x->callee()->is_static() && !Bytecodes::has_receiver(bc); - ciSignatureStream sig_stream(sig, has_receiver ? x->callee()->holder() : NULL); - for (int i = 0; i < stop; i++) { + ciSignatureStream callee_signature_stream(callee_signature, has_receiver ? x->callee()->holder() : NULL); + + bool ignored_will_link; + ciSignature* signature_at_call = NULL; + x->method()->get_method_at_bci(bci, ignored_will_link, &signature_at_call); + ciSignatureStream signature_at_call_stream(signature_at_call); + + // if called through method handle invoke, some arguments may have been popped + for (int i = 0; i < stop && i+start < x->nb_profiled_args(); i++) { int off = in_bytes(TypeEntriesAtCall::argument_type_offset(i)) - in_bytes(TypeEntriesAtCall::args_data_offset()); - ciKlass* exact = profile_arg_type(md, base_offset, off, - args->type(i), x->profiled_arg_at(i+start), mdp, - !x->arg_needs_null_check(i+start), sig_stream.next_klass()); + ciKlass* exact = profile_type(md, base_offset, off, + args->type(i), x->profiled_arg_at(i+start), mdp, + !x->arg_needs_null_check(i+start), + signature_at_call_stream.next_klass(), callee_signature_stream.next_klass()); if (exact != NULL) { md->set_argument_type(bci, i, exact); } @@ -3176,8 +3212,8 @@ void LIRGenerator::profile_parameters_at_call(ProfileCall* x) { int bci = x->bci_of_invoke(); Bytecodes::Code bc = x->method()->java_code_at_bci(bci); // The first parameter is the receiver so that's what we start - // with if it exists. On exception if method handle call to - // virtual method has receiver in the args list + // with if it exists. One exception is method handle call to + // virtual method: the receiver is in the args list if (arg == NULL || !Bytecodes::has_receiver(bc)) { i = 1; arg = x->profiled_arg_at(0); @@ -3186,9 +3222,9 @@ void LIRGenerator::profile_parameters_at_call(ProfileCall* x) { int k = 0; // to iterate on the profile data for (;;) { intptr_t profiled_k = parameters->type(k); - ciKlass* exact = profile_arg_type(md, md->byte_offset_of_slot(parameters_type_data, ParametersTypeData::type_offset(0)), - in_bytes(ParametersTypeData::type_offset(k)) - in_bytes(ParametersTypeData::type_offset(0)), - profiled_k, arg, mdp, not_null, sig_stream.next_klass()); + ciKlass* exact = profile_type(md, md->byte_offset_of_slot(parameters_type_data, ParametersTypeData::type_offset(0)), + in_bytes(ParametersTypeData::type_offset(k)) - in_bytes(ParametersTypeData::type_offset(0)), + profiled_k, arg, mdp, not_null, sig_stream.next_klass(), NULL); // If the profile is known statically set it once for all and do not emit any code if (exact != NULL) { md->set_parameter_type(k, exact); @@ -3247,9 +3283,16 @@ void LIRGenerator::do_ProfileReturnType(ProfileReturnType* x) { assert(data->is_CallTypeData() || data->is_VirtualCallTypeData(), "wrong profile data type"); ciReturnTypeEntry* ret = data->is_CallTypeData() ? ((ciCallTypeData*)data)->ret() : ((ciVirtualCallTypeData*)data)->ret(); LIR_Opr mdp = LIR_OprFact::illegalOpr; - ciKlass* exact = profile_arg_type(md, 0, md->byte_offset_of_slot(data, ret->type_offset()), - ret->type(), x->ret(), mdp, - !x->needs_null_check(), x->callee()->signature()->return_type()->as_klass()); + + bool ignored_will_link; + ciSignature* signature_at_call = NULL; + x->method()->get_method_at_bci(bci, ignored_will_link, &signature_at_call); + + ciKlass* exact = profile_type(md, 0, md->byte_offset_of_slot(data, ret->type_offset()), + ret->type(), x->ret(), mdp, + !x->needs_null_check(), + signature_at_call->return_type()->as_klass(), + x->callee()->signature()->return_type()->as_klass()); if (exact != NULL) { md->set_return_type(bci, exact); } diff --git a/hotspot/src/share/vm/c1/c1_LIRGenerator.hpp b/hotspot/src/share/vm/c1/c1_LIRGenerator.hpp index f0c640da919..90b278f4356 100644 --- a/hotspot/src/share/vm/c1/c1_LIRGenerator.hpp +++ b/hotspot/src/share/vm/c1/c1_LIRGenerator.hpp @@ -434,7 +434,9 @@ class LIRGenerator: public InstructionVisitor, public BlockClosure { void do_ThreadIDIntrinsic(Intrinsic* x); void do_ClassIDIntrinsic(Intrinsic* x); #endif - ciKlass* profile_arg_type(ciMethodData* md, int md_first_offset, int md_offset, intptr_t profiled_k, Value arg, LIR_Opr& mdp, bool not_null, ciKlass* signature_k); + ciKlass* profile_type(ciMethodData* md, int md_first_offset, int md_offset, intptr_t profiled_k, + Value arg, LIR_Opr& mdp, bool not_null, ciKlass* signature_at_call_k, + ciKlass* callee_signature_k); void profile_arguments(ProfileCall* x); void profile_parameters(Base* x); void profile_parameters_at_call(ProfileCall* x); diff --git a/hotspot/src/share/vm/c1/c1_globals.hpp b/hotspot/src/share/vm/c1/c1_globals.hpp index 9cc51ede622..c7136909c40 100644 --- a/hotspot/src/share/vm/c1/c1_globals.hpp +++ b/hotspot/src/share/vm/c1/c1_globals.hpp @@ -341,9 +341,6 @@ diagnostic(bool, C1PatchInvokeDynamic, true, \ "Patch invokedynamic appendix not known at compile time") \ \ - develop(intx, MaxForceInlineLevel, 100, \ - "maximum number of nested @ForceInline calls that are inlined") \ - \ // Read default values for c1 globals diff --git a/hotspot/src/share/vm/ci/ciEnv.cpp b/hotspot/src/share/vm/ci/ciEnv.cpp index 7e61a849b0f..9cc86db9052 100644 --- a/hotspot/src/share/vm/ci/ciEnv.cpp +++ b/hotspot/src/share/vm/ci/ciEnv.cpp @@ -935,7 +935,9 @@ void ciEnv::register_method(ciMethod* target, // Prevent SystemDictionary::add_to_hierarchy from running // and invalidating our dependencies until we install this method. + // No safepoints are allowed. Otherwise, class redefinition can occur in between. MutexLocker ml(Compile_lock); + No_Safepoint_Verifier nsv; // Change in Jvmti state may invalidate compilation. if (!failing() && @@ -1001,31 +1003,15 @@ void ciEnv::register_method(ciMethod* target, // Free codeBlobs code_buffer->free_blob(); - // stress test 6243940 by immediately making the method - // non-entrant behind the system's back. This has serious - // side effects on the code cache and is not meant for - // general stress testing - if (nm != NULL && StressNonEntrant) { - MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag); - NativeJump::patch_verified_entry(nm->entry_point(), nm->verified_entry_point(), - SharedRuntime::get_handle_wrong_method_stub()); - } - - if (nm == NULL) { - // The CodeCache is full. Print out warning and disable compilation. - record_failure("code cache is full"); - { - MutexUnlocker ml(Compile_lock); - MutexUnlocker locker(MethodCompileQueue_lock); - CompileBroker::handle_full_code_cache(); - } - } else { + if (nm != NULL) { nm->set_has_unsafe_access(has_unsafe_access); nm->set_has_wide_vectors(has_wide_vectors); // Record successful registration. // (Put nm into the task handle *before* publishing to the Java heap.) - if (task() != NULL) task()->set_code(nm); + if (task() != NULL) { + task()->set_code(nm); + } if (entry_bci == InvocationEntryBci) { if (TieredCompilation) { @@ -1036,11 +1022,11 @@ void ciEnv::register_method(ciMethod* target, char *method_name = method->name_and_sig_as_C_string(); tty->print_cr("Replacing method %s", method_name); } - if (old != NULL ) { + if (old != NULL) { old->make_not_entrant(); } } - if (TraceNMethodInstalls ) { + if (TraceNMethodInstalls) { ResourceMark rm; char *method_name = method->name_and_sig_as_C_string(); ttyLocker ttyl; @@ -1051,7 +1037,7 @@ void ciEnv::register_method(ciMethod* target, // Allow the code to be executed method->set_code(method, nm); } else { - if (TraceNMethodInstalls ) { + if (TraceNMethodInstalls) { ResourceMark rm; char *method_name = method->name_and_sig_as_C_string(); ttyLocker ttyl; @@ -1061,15 +1047,18 @@ void ciEnv::register_method(ciMethod* target, entry_bci); } method->method_holder()->add_osr_nmethod(nm); - } } - } - // JVMTI -- compiled method notification (must be done outside lock) - if (nm != NULL) { - nm->post_compiled_method_load_event(); - } + } // safepoints are allowed again + if (nm != NULL) { + // JVMTI -- compiled method notification (must be done outside lock) + nm->post_compiled_method_load_event(); + } else { + // The CodeCache is full. Print out warning and disable compilation. + record_failure("code cache is full"); + CompileBroker::handle_full_code_cache(); + } } diff --git a/hotspot/src/share/vm/ci/ciMethodData.hpp b/hotspot/src/share/vm/ci/ciMethodData.hpp index 0602f85a125..0eeb510e348 100644 --- a/hotspot/src/share/vm/ci/ciMethodData.hpp +++ b/hotspot/src/share/vm/ci/ciMethodData.hpp @@ -77,7 +77,9 @@ public: static ciKlass* valid_ciklass(intptr_t k) { if (!TypeEntries::is_type_none(k) && !TypeEntries::is_type_unknown(k)) { - return (ciKlass*)TypeEntries::klass_part(k); + ciKlass* res = (ciKlass*)TypeEntries::klass_part(k); + assert(res != NULL, "invalid"); + return res; } else { return NULL; } diff --git a/hotspot/src/share/vm/classfile/classFileParser.cpp b/hotspot/src/share/vm/classfile/classFileParser.cpp index 1774ac18284..8990cc3952f 100644 --- a/hotspot/src/share/vm/classfile/classFileParser.cpp +++ b/hotspot/src/share/vm/classfile/classFileParser.cpp @@ -4080,7 +4080,7 @@ instanceKlassHandle ClassFileParser::parseClassFile(Symbol* name, // Generate any default methods - default methods are interface methods // that have a default implementation. This is new with Lambda project. - if (has_default_methods && !access_flags.is_interface() ) { + if (has_default_methods ) { DefaultMethods::generate_default_methods( this_klass(), &all_mirandas, CHECK_(nullHandle)); } diff --git a/hotspot/src/share/vm/classfile/defaultMethods.cpp b/hotspot/src/share/vm/classfile/defaultMethods.cpp index c05c58748d8..619856d69e5 100644 --- a/hotspot/src/share/vm/classfile/defaultMethods.cpp +++ b/hotspot/src/share/vm/classfile/defaultMethods.cpp @@ -171,8 +171,12 @@ class HierarchyVisitor : StackObj { } bool is_cancelled() const { return _cancelled; } + // This code used to skip interface classes because their only + // superclass was j.l.Object which would be also covered by class + // superclass hierarchy walks. Now that the starting point can be + // an interface, we must ensure we catch j.l.Object as the super. static bool has_super(InstanceKlass* cls) { - return cls->super() != NULL && !cls->is_interface(); + return cls->super() != NULL; } Node* node_at_depth(int i) const { @@ -391,16 +395,21 @@ class MethodFamily : public ResourceObj { return; } + // Qualified methods are maximally-specific methods + // These include public, instance concrete (=default) and abstract methods GrowableArray qualified_methods; int num_defaults = 0; int default_index = -1; + int qualified_index = -1; for (int i = 0; i < _members.length(); ++i) { Pair entry = _members.at(i); if (entry.second == QUALIFIED) { qualified_methods.append(entry.first); - default_index++; + qualified_index++; if (entry.first->is_default_method()) { num_defaults++; + default_index = qualified_index; + } } } @@ -408,16 +417,10 @@ class MethodFamily : public ResourceObj { if (qualified_methods.length() == 0) { _exception_message = generate_no_defaults_message(CHECK); _exception_name = vmSymbols::java_lang_AbstractMethodError(); - } else if (qualified_methods.length() == 1) { - // leave abstract methods alone, they will be found via normal search path - Method* method = qualified_methods.at(0); - if (!method->is_abstract()) { - _selected_target = qualified_methods.at(0); - } - // If only one qualified method is default, select that + // If only one qualified method is default, select that } else if (num_defaults == 1) { _selected_target = qualified_methods.at(default_index); - } else { + } else if (num_defaults > 1) { _exception_message = generate_conflicts_message(&qualified_methods,CHECK); _exception_name = vmSymbols::java_lang_IncompatibleClassChangeError(); if (TraceDefaultMethods) { @@ -425,6 +428,7 @@ class MethodFamily : public ResourceObj { tty->print_cr(""); } } + // leave abstract methods alone, they will be found via normal search path } bool contains_signature(Symbol* query) { @@ -704,8 +708,10 @@ class FindMethodsByErasedSig : public HierarchyVisitor { Method* m = iklass->find_method(_method_name, _method_signature); // private interface methods are not candidates for default methods // invokespecial to private interface methods doesn't use default method logic + // The overpasses are your supertypes' errors, we do not include them // future: take access controls into account for superclass methods - if (m != NULL && !m->is_static() && (!iklass->is_interface() || m->is_public())) { + if (m != NULL && !m->is_static() && !m->is_overpass() && + (!iklass->is_interface() || m->is_public())) { if (_family == NULL) { _family = new StatefulMethodFamily(); } @@ -781,7 +787,8 @@ void DefaultMethods::generate_default_methods( #ifndef PRODUCT if (TraceDefaultMethods) { ResourceMark rm; // be careful with these! - tty->print_cr("Class %s requires default method processing", + tty->print_cr("%s %s requires default method processing", + klass->is_interface() ? "Interface" : "Class", klass->name()->as_klass_external_name()); PrintHierarchy printer; printer.run(klass); @@ -806,7 +813,7 @@ void DefaultMethods::generate_default_methods( } #ifndef PRODUCT if (TraceDefaultMethods) { - tty->print_cr("Creating overpasses..."); + tty->print_cr("Creating defaults and overpasses..."); } #endif // ndef PRODUCT @@ -1076,7 +1083,9 @@ static void merge_in_new_methods(InstanceKlass* klass, klass->set_initial_method_idnum(new_size); ClassLoaderData* cld = klass->class_loader_data(); - MetadataFactory::free_array(cld, original_methods); + if (original_methods ->length() > 0) { + MetadataFactory::free_array(cld, original_methods); + } if (original_ordering->length() > 0) { klass->set_method_ordering(merged_ordering); MetadataFactory::free_array(cld, original_ordering); diff --git a/hotspot/src/share/vm/classfile/metadataOnStackMark.cpp b/hotspot/src/share/vm/classfile/metadataOnStackMark.cpp index 20404879adb..032c3e3fc70 100644 --- a/hotspot/src/share/vm/classfile/metadataOnStackMark.cpp +++ b/hotspot/src/share/vm/classfile/metadataOnStackMark.cpp @@ -30,6 +30,7 @@ #include "prims/jvmtiImpl.hpp" #include "runtime/synchronizer.hpp" #include "runtime/thread.hpp" +#include "services/threadService.hpp" #include "utilities/growableArray.hpp" @@ -50,6 +51,7 @@ MetadataOnStackMark::MetadataOnStackMark() { CodeCache::alive_nmethods_do(nmethod::mark_on_stack); CompileBroker::mark_on_stack(); JvmtiCurrentBreakpoints::metadata_do(Metadata::mark_on_stack); + ThreadService::metadata_do(Metadata::mark_on_stack); } MetadataOnStackMark::~MetadataOnStackMark() { diff --git a/hotspot/src/share/vm/classfile/systemDictionary.hpp b/hotspot/src/share/vm/classfile/systemDictionary.hpp index c6436364533..1bf98676f6b 100644 --- a/hotspot/src/share/vm/classfile/systemDictionary.hpp +++ b/hotspot/src/share/vm/classfile/systemDictionary.hpp @@ -141,7 +141,6 @@ class SymbolPropertyTable; /* NOTE: needed too early in bootstrapping process to have checks based on JDK version */ \ /* Universe::is_gte_jdk14x_version() is not set up by this point. */ \ /* It's okay if this turns out to be NULL in non-1.4 JDKs. */ \ - do_klass(lambda_MagicLambdaImpl_klass, java_lang_invoke_MagicLambdaImpl, Opt ) \ do_klass(reflect_MagicAccessorImpl_klass, sun_reflect_MagicAccessorImpl, Opt ) \ do_klass(reflect_MethodAccessorImpl_klass, sun_reflect_MethodAccessorImpl, Opt_Only_JDK14NewRef) \ do_klass(reflect_ConstructorAccessorImpl_klass, sun_reflect_ConstructorAccessorImpl, Opt_Only_JDK14NewRef) \ diff --git a/hotspot/src/share/vm/classfile/verifier.cpp b/hotspot/src/share/vm/classfile/verifier.cpp index 4dda936d5ac..62ccf295045 100644 --- a/hotspot/src/share/vm/classfile/verifier.cpp +++ b/hotspot/src/share/vm/classfile/verifier.cpp @@ -188,10 +188,8 @@ bool Verifier::verify(instanceKlassHandle klass, Verifier::Mode mode, bool shoul bool Verifier::is_eligible_for_verification(instanceKlassHandle klass, bool should_verify_class) { Symbol* name = klass->name(); Klass* refl_magic_klass = SystemDictionary::reflect_MagicAccessorImpl_klass(); - Klass* lambda_magic_klass = SystemDictionary::lambda_MagicLambdaImpl_klass(); bool is_reflect = refl_magic_klass != NULL && klass->is_subtype_of(refl_magic_klass); - bool is_lambda = lambda_magic_klass != NULL && klass->is_subtype_of(lambda_magic_klass); return (should_verify_for(klass->class_loader(), should_verify_class) && // return if the class is a bootstrapping class @@ -215,9 +213,7 @@ bool Verifier::is_eligible_for_verification(instanceKlassHandle klass, bool shou // NOTE: this is called too early in the bootstrapping process to be // guarded by Universe::is_gte_jdk14x_version()/UseNewReflection. // Also for lambda generated code, gte jdk8 - (!is_reflect || VerifyReflectionBytecodes) && - (!is_lambda || VerifyLambdaBytecodes) - ); + (!is_reflect || VerifyReflectionBytecodes)); } Symbol* Verifier::inference_verify( diff --git a/hotspot/src/share/vm/classfile/vmSymbols.hpp b/hotspot/src/share/vm/classfile/vmSymbols.hpp index 8ff789f81e5..5d32b159efe 100644 --- a/hotspot/src/share/vm/classfile/vmSymbols.hpp +++ b/hotspot/src/share/vm/classfile/vmSymbols.hpp @@ -273,7 +273,6 @@ template(java_lang_invoke_Stable_signature, "Ljava/lang/invoke/Stable;") \ template(java_lang_invoke_LambdaForm_Compiled_signature, "Ljava/lang/invoke/LambdaForm$Compiled;") \ template(java_lang_invoke_LambdaForm_Hidden_signature, "Ljava/lang/invoke/LambdaForm$Hidden;") \ - template(java_lang_invoke_MagicLambdaImpl, "java/lang/invoke/MagicLambdaImpl") \ /* internal up-calls made only by the JVM, via class sun.invoke.MethodHandleNatives: */ \ template(findMethodHandleType_name, "findMethodHandleType") \ template(findMethodHandleType_signature, "(Ljava/lang/Class;[Ljava/lang/Class;)Ljava/lang/invoke/MethodType;") \ diff --git a/hotspot/src/share/vm/code/nmethod.cpp b/hotspot/src/share/vm/code/nmethod.cpp index 5d74db0d38b..68718499a00 100644 --- a/hotspot/src/share/vm/code/nmethod.cpp +++ b/hotspot/src/share/vm/code/nmethod.cpp @@ -618,21 +618,18 @@ nmethod* nmethod::new_nmethod(methodHandle method, // record this nmethod as dependent on this klass InstanceKlass::cast(klass)->add_dependent_nmethod(nm); } - } - NOT_PRODUCT(if (nm != NULL) nmethod_stats.note_nmethod(nm)); - if (PrintAssembly && nm != NULL) { - Disassembler::decode(nm); + NOT_PRODUCT(nmethod_stats.note_nmethod(nm)); + if (PrintAssembly) { + Disassembler::decode(nm); + } } } - - // verify nmethod - debug_only(if (nm) nm->verify();) // might block - + // Do verification and logging outside CodeCache_lock. if (nm != NULL) { + // Safepoints in nmethod::verify aren't allowed because nm hasn't been installed yet. + DEBUG_ONLY(nm->verify();) nm->log_new_nmethod(); } - - // done return nm; } @@ -1262,7 +1259,7 @@ void nmethod::make_unloaded(BoolObjectClosure* is_alive, oop cause) { set_osr_link(NULL); //set_scavenge_root_link(NULL); // done by prune_scavenge_root_nmethods - NMethodSweeper::notify(); + NMethodSweeper::report_state_change(this); } void nmethod::invalidate_osr_method() { @@ -1296,7 +1293,9 @@ void nmethod::log_state_change() const { } } -// Common functionality for both make_not_entrant and make_zombie +/** + * Common functionality for both make_not_entrant and make_zombie + */ bool nmethod::make_not_entrant_or_zombie(unsigned int state) { assert(state == zombie || state == not_entrant, "must be zombie or not_entrant"); assert(!is_zombie(), "should not already be a zombie"); @@ -1420,9 +1419,7 @@ bool nmethod::make_not_entrant_or_zombie(unsigned int state) { tty->print_cr("nmethod <" INTPTR_FORMAT "> code made %s", this, (state == not_entrant) ? "not entrant" : "zombie"); } - // Make sweeper aware that there is a zombie method that needs to be removed - NMethodSweeper::notify(); - + NMethodSweeper::report_state_change(this); return true; } @@ -2395,20 +2392,23 @@ void nmethod::verify() { void nmethod::verify_interrupt_point(address call_site) { - // This code does not work in release mode since - // owns_lock only is available in debug mode. - CompiledIC* ic = NULL; - Thread *cur = Thread::current(); - if (CompiledIC_lock->owner() == cur || - ((cur->is_VM_thread() || cur->is_ConcurrentGC_thread()) && - SafepointSynchronize::is_at_safepoint())) { - ic = CompiledIC_at(this, call_site); - CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops()); - } else { - MutexLocker ml_verify (CompiledIC_lock); - ic = CompiledIC_at(this, call_site); + // Verify IC only when nmethod installation is finished. + bool is_installed = (method()->code() == this) // nmethod is in state 'alive' and installed + || !this->is_in_use(); // nmethod is installed, but not in 'alive' state + if (is_installed) { + Thread *cur = Thread::current(); + if (CompiledIC_lock->owner() == cur || + ((cur->is_VM_thread() || cur->is_ConcurrentGC_thread()) && + SafepointSynchronize::is_at_safepoint())) { + CompiledIC_at(this, call_site); + CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops()); + } else { + MutexLocker ml_verify (CompiledIC_lock); + CompiledIC_at(this, call_site); + } } - PcDesc* pd = pc_desc_at(ic->end_of_call()); + + PcDesc* pd = pc_desc_at(nativeCall_at(call_site)->return_address()); assert(pd != NULL, "PcDesc must exist"); for (ScopeDesc* sd = new ScopeDesc(this, pd->scope_decode_offset(), pd->obj_decode_offset(), pd->should_reexecute(), diff --git a/hotspot/src/share/vm/compiler/compileBroker.cpp b/hotspot/src/share/vm/compiler/compileBroker.cpp index fb47df28267..f8fa26ff8c2 100644 --- a/hotspot/src/share/vm/compiler/compileBroker.cpp +++ b/hotspot/src/share/vm/compiler/compileBroker.cpp @@ -126,6 +126,7 @@ HS_DTRACE_PROBE_DECL9(hotspot, method__compile__end, bool CompileBroker::_initialized = false; volatile bool CompileBroker::_should_block = false; +volatile jint CompileBroker::_print_compilation_warning = 0; volatile jint CompileBroker::_should_compile_new_jobs = run_compilation; // The installed compiler(s) @@ -2027,11 +2028,10 @@ void CompileBroker::invoke_compiler_on_method(CompileTask* task) { #endif } -// ------------------------------------------------------------------ -// CompileBroker::handle_full_code_cache -// -// The CodeCache is full. Print out warning and disable compilation or -// try code cache cleaning so compilation can continue later. +/** + * The CodeCache is full. Print out warning and disable compilation + * or try code cache cleaning so compilation can continue later. + */ void CompileBroker::handle_full_code_cache() { UseInterpreter = true; if (UseCompiler || AlwaysCompileLoopMethods ) { @@ -2048,12 +2048,9 @@ void CompileBroker::handle_full_code_cache() { xtty->stamp(); xtty->end_elem(); } - warning("CodeCache is full. Compiler has been disabled."); - warning("Try increasing the code cache size using -XX:ReservedCodeCacheSize="); CodeCache::report_codemem_full(); - #ifndef PRODUCT if (CompileTheWorld || ExitOnFullCodeCache) { codecache_print(/* detailed= */ true); @@ -2066,17 +2063,22 @@ void CompileBroker::handle_full_code_cache() { // Since code cache is full, immediately stop new compiles if (CompileBroker::set_should_compile_new_jobs(CompileBroker::stop_compilation)) { NMethodSweeper::log_sweep("disable_compiler"); - - // Switch to 'vm_state'. This ensures that possibly_sweep() can be called - // without having to consider the state in which the current thread is. - ThreadInVMfromUnknown in_vm; - NMethodSweeper::possibly_sweep(); } + // Switch to 'vm_state'. This ensures that possibly_sweep() can be called + // without having to consider the state in which the current thread is. + ThreadInVMfromUnknown in_vm; + NMethodSweeper::possibly_sweep(); } else { disable_compilation_forever(); } + + // Print warning only once + if (should_print_compiler_warning()) { + warning("CodeCache is full. Compiler has been disabled."); + warning("Try increasing the code cache size using -XX:ReservedCodeCacheSize="); + codecache_print(/* detailed= */ true); + } } - codecache_print(/* detailed= */ true); } // ------------------------------------------------------------------ diff --git a/hotspot/src/share/vm/compiler/compileBroker.hpp b/hotspot/src/share/vm/compiler/compileBroker.hpp index 19beeec9fb4..a74afb3065f 100644 --- a/hotspot/src/share/vm/compiler/compileBroker.hpp +++ b/hotspot/src/share/vm/compiler/compileBroker.hpp @@ -315,6 +315,8 @@ class CompileBroker: AllStatic { static int _sum_nmethod_code_size; static long _peak_compilation_time; + static volatile jint _print_compilation_warning; + static CompilerThread* make_compiler_thread(const char* name, CompileQueue* queue, CompilerCounters* counters, AbstractCompiler* comp, TRAPS); static void init_compiler_threads(int c1_compiler_count, int c2_compiler_count); static bool compilation_is_complete (methodHandle method, int osr_bci, int comp_level); @@ -418,7 +420,11 @@ class CompileBroker: AllStatic { return _should_compile_new_jobs == shutdown_compilaton; } static void handle_full_code_cache(); - + // Ensures that warning is only printed once. + static bool should_print_compiler_warning() { + jint old = Atomic::cmpxchg(1, &_print_compilation_warning, 0); + return old == 0; + } // Return total compilation ticks static jlong total_compilation_ticks() { return _perf_total_compilation != NULL ? _perf_total_compilation->get_value() : 0; diff --git a/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.cpp b/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.cpp index c2aafb7bc20..a236a10efb3 100644 --- a/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.cpp +++ b/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.cpp @@ -47,8 +47,9 @@ // ConcurrentMarkSweepPolicy methods // -ConcurrentMarkSweepPolicy::ConcurrentMarkSweepPolicy() { - initialize_all(); +void ConcurrentMarkSweepPolicy::initialize_alignments() { + _space_alignment = _gen_alignment = (uintx)Generation::GenGrain; + _heap_alignment = compute_heap_alignment(); } void ConcurrentMarkSweepPolicy::initialize_generations() { diff --git a/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.hpp b/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.hpp index 1483bca13eb..d26959f3d9f 100644 --- a/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.hpp +++ b/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/cmsCollectorPolicy.hpp @@ -29,10 +29,11 @@ class ConcurrentMarkSweepPolicy : public TwoGenerationCollectorPolicy { protected: + void initialize_alignments(); void initialize_generations(); public: - ConcurrentMarkSweepPolicy(); + ConcurrentMarkSweepPolicy() {} ConcurrentMarkSweepPolicy* as_concurrent_mark_sweep_policy() { return this; } diff --git a/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/concurrentMarkSweepGeneration.cpp b/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/concurrentMarkSweepGeneration.cpp index bf4ac21e346..ffe87d57c8d 100644 --- a/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/concurrentMarkSweepGeneration.cpp +++ b/hotspot/src/share/vm/gc_implementation/concurrentMarkSweep/concurrentMarkSweepGeneration.cpp @@ -594,9 +594,9 @@ CMSCollector::CMSCollector(ConcurrentMarkSweepGeneration* cmsGen, _verification_mark_bm(0, Mutex::leaf + 1, "CMS_verification_mark_bm_lock"), _completed_initialization(false), _collector_policy(cp), - _should_unload_classes(false), + _should_unload_classes(CMSClassUnloadingEnabled), _concurrent_cycles_since_last_unload(0), - _roots_scanning_options(0), + _roots_scanning_options(SharedHeap::SO_None), _inter_sweep_estimate(CMS_SweepWeight, CMS_SweepPadding), _intra_sweep_estimate(CMS_SweepWeight, CMS_SweepPadding), _gc_tracer_cm(new (ResourceObj::C_HEAP, mtGC) CMSTracer()), @@ -788,14 +788,6 @@ CMSCollector::CMSCollector(ConcurrentMarkSweepGeneration* cmsGen, && _survivor_chunk_index == 0), "Error"); - // Choose what strong roots should be scanned depending on verification options - if (!CMSClassUnloadingEnabled) { - // If class unloading is disabled we want to include all classes into the root set. - add_root_scanning_option(SharedHeap::SO_AllClasses); - } else { - add_root_scanning_option(SharedHeap::SO_SystemClasses); - } - NOT_PRODUCT(_overflow_counter = CMSMarkStackOverflowInterval;) _gc_counters = new CollectorCounters("CMS", 1); _completed_initialization = true; @@ -2532,6 +2524,9 @@ void CMSCollector::collect_in_foreground(bool clear_all_soft_refs, GCCause::Caus // Snapshot the soft reference policy to be used in this collection cycle. ref_processor()->setup_policy(clear_all_soft_refs); + // Decide if class unloading should be done + update_should_unload_classes(); + bool init_mark_was_synchronous = false; // until proven otherwise while (_collectorState != Idling) { if (TraceCMSState) { @@ -3310,7 +3305,10 @@ void CMSCollector::setup_cms_unloading_and_verification_state() { || VerifyBeforeExit; const int rso = SharedHeap::SO_Strings | SharedHeap::SO_CodeCache; + // We set the proper root for this CMS cycle here. if (should_unload_classes()) { // Should unload classes this cycle + remove_root_scanning_option(SharedHeap::SO_AllClasses); + add_root_scanning_option(SharedHeap::SO_SystemClasses); remove_root_scanning_option(rso); // Shrink the root set appropriately set_verifying(should_verify); // Set verification state for this cycle return; // Nothing else needs to be done at this time @@ -3318,6 +3316,9 @@ void CMSCollector::setup_cms_unloading_and_verification_state() { // Not unloading classes this cycle assert(!should_unload_classes(), "Inconsitency!"); + remove_root_scanning_option(SharedHeap::SO_SystemClasses); + add_root_scanning_option(SharedHeap::SO_AllClasses); + if ((!verifying() || unloaded_classes_last_cycle()) && should_verify) { // Include symbols, strings and code cache elements to prevent their resurrection. add_root_scanning_option(rso); diff --git a/hotspot/src/share/vm/gc_implementation/g1/g1CollectedHeap.cpp b/hotspot/src/share/vm/gc_implementation/g1/g1CollectedHeap.cpp index 3f53067ca8d..4b82d5bd667 100644 --- a/hotspot/src/share/vm/gc_implementation/g1/g1CollectedHeap.cpp +++ b/hotspot/src/share/vm/gc_implementation/g1/g1CollectedHeap.cpp @@ -2008,7 +2008,7 @@ jint G1CollectedHeap::initialize() { size_t init_byte_size = collector_policy()->initial_heap_byte_size(); size_t max_byte_size = collector_policy()->max_heap_byte_size(); - size_t heap_alignment = collector_policy()->max_alignment(); + size_t heap_alignment = collector_policy()->heap_alignment(); // Ensure that the sizes are properly aligned. Universe::check_alignment(init_byte_size, HeapRegion::GrainBytes, "g1 heap"); @@ -6656,13 +6656,18 @@ class RegisterNMethodOopClosure: public OopClosure { if (!oopDesc::is_null(heap_oop)) { oop obj = oopDesc::decode_heap_oop_not_null(heap_oop); HeapRegion* hr = _g1h->heap_region_containing(obj); - assert(!hr->isHumongous(), "code root in humongous region?"); + assert(!hr->continuesHumongous(), + err_msg("trying to add code root "PTR_FORMAT" in continuation of humongous region "HR_FORMAT + " starting at "HR_FORMAT, + _nm, HR_FORMAT_PARAMS(hr), HR_FORMAT_PARAMS(hr->humongous_start_region()))); // HeapRegion::add_strong_code_root() avoids adding duplicate // entries but having duplicates is OK since we "mark" nmethods // as visited when we scan the strong code root lists during the GC. hr->add_strong_code_root(_nm); - assert(hr->rem_set()->strong_code_roots_list_contains(_nm), "add failed?"); + assert(hr->rem_set()->strong_code_roots_list_contains(_nm), + err_msg("failed to add code root "PTR_FORMAT" to remembered set of region "HR_FORMAT, + _nm, HR_FORMAT_PARAMS(hr))); } } @@ -6683,9 +6688,15 @@ class UnregisterNMethodOopClosure: public OopClosure { if (!oopDesc::is_null(heap_oop)) { oop obj = oopDesc::decode_heap_oop_not_null(heap_oop); HeapRegion* hr = _g1h->heap_region_containing(obj); - assert(!hr->isHumongous(), "code root in humongous region?"); + assert(!hr->continuesHumongous(), + err_msg("trying to remove code root "PTR_FORMAT" in continuation of humongous region "HR_FORMAT + " starting at "HR_FORMAT, + _nm, HR_FORMAT_PARAMS(hr), HR_FORMAT_PARAMS(hr->humongous_start_region()))); + hr->remove_strong_code_root(_nm); - assert(!hr->rem_set()->strong_code_roots_list_contains(_nm), "remove failed?"); + assert(!hr->rem_set()->strong_code_roots_list_contains(_nm), + err_msg("failed to remove code root "PTR_FORMAT" of region "HR_FORMAT, + _nm, HR_FORMAT_PARAMS(hr))); } } @@ -6716,7 +6727,9 @@ void G1CollectedHeap::unregister_nmethod(nmethod* nm) { class MigrateCodeRootsHeapRegionClosure: public HeapRegionClosure { public: bool doHeapRegion(HeapRegion *hr) { - assert(!hr->isHumongous(), "humongous region in collection set?"); + assert(!hr->isHumongous(), + err_msg("humongous region "HR_FORMAT" should not have been added to collection set", + HR_FORMAT_PARAMS(hr))); hr->migrate_strong_code_roots(); return false; } @@ -6796,9 +6809,13 @@ public: bool doHeapRegion(HeapRegion *hr) { HeapRegionRemSet* hrrs = hr->rem_set(); - if (hr->isHumongous()) { - // Code roots should never be attached to a humongous region - assert(hrrs->strong_code_roots_list_length() == 0, "sanity"); + if (hr->continuesHumongous()) { + // Code roots should never be attached to a continuation of a humongous region + assert(hrrs->strong_code_roots_list_length() == 0, + err_msg("code roots should never be attached to continuations of humongous region "HR_FORMAT + " starting at "HR_FORMAT", but has "INT32_FORMAT, + HR_FORMAT_PARAMS(hr), HR_FORMAT_PARAMS(hr->humongous_start_region()), + hrrs->strong_code_roots_list_length())); return false; } diff --git a/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.cpp b/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.cpp index 92eee2e8eb9..b4f9a0b0007 100644 --- a/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.cpp +++ b/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.cpp @@ -313,27 +313,38 @@ G1CollectorPolicy::G1CollectorPolicy() : // for the first time during initialization. _reserve_regions = 0; - initialize_all(); _collectionSetChooser = new CollectionSetChooser(); - _young_gen_sizer = new G1YoungGenSizer(); // Must be after call to initialize_flags +} + +void G1CollectorPolicy::initialize_alignments() { + _space_alignment = HeapRegion::GrainBytes; + size_t card_table_alignment = GenRemSet::max_alignment_constraint(GenRemSet::CardTable); + size_t page_size = UseLargePages ? os::large_page_size() : os::vm_page_size(); + _heap_alignment = MAX3(card_table_alignment, _space_alignment, page_size); } void G1CollectorPolicy::initialize_flags() { - _min_alignment = HeapRegion::GrainBytes; - size_t card_table_alignment = GenRemSet::max_alignment_constraint(rem_set_name()); - size_t page_size = UseLargePages ? os::large_page_size() : os::vm_page_size(); - _max_alignment = MAX3(card_table_alignment, _min_alignment, page_size); + if (G1HeapRegionSize != HeapRegion::GrainBytes) { + FLAG_SET_ERGO(uintx, G1HeapRegionSize, HeapRegion::GrainBytes); + } + if (SurvivorRatio < 1) { vm_exit_during_initialization("Invalid survivor ratio specified"); } CollectorPolicy::initialize_flags(); + _young_gen_sizer = new G1YoungGenSizer(); // Must be after call to initialize_flags } -G1YoungGenSizer::G1YoungGenSizer() : _sizer_kind(SizerDefaults), _adaptive_size(true) { - assert(G1NewSizePercent <= G1MaxNewSizePercent, "Min larger than max"); - assert(G1NewSizePercent > 0 && G1NewSizePercent < 100, "Min out of bounds"); - assert(G1MaxNewSizePercent > 0 && G1MaxNewSizePercent < 100, "Max out of bounds"); +void G1CollectorPolicy::post_heap_initialize() { + uintx max_regions = G1CollectedHeap::heap()->max_regions(); + size_t max_young_size = (size_t)_young_gen_sizer->max_young_length(max_regions) * HeapRegion::GrainBytes; + if (max_young_size != MaxNewSize) { + FLAG_SET_ERGO(uintx, MaxNewSize, max_young_size); + } +} +G1YoungGenSizer::G1YoungGenSizer() : _sizer_kind(SizerDefaults), _adaptive_size(true), + _min_desired_young_length(0), _max_desired_young_length(0) { if (FLAG_IS_CMDLINE(NewRatio)) { if (FLAG_IS_CMDLINE(NewSize) || FLAG_IS_CMDLINE(MaxNewSize)) { warning("-XX:NewSize and -XX:MaxNewSize override -XX:NewRatio"); @@ -344,8 +355,13 @@ G1YoungGenSizer::G1YoungGenSizer() : _sizer_kind(SizerDefaults), _adaptive_size( } } - if (FLAG_IS_CMDLINE(NewSize) && FLAG_IS_CMDLINE(MaxNewSize) && NewSize > MaxNewSize) { - vm_exit_during_initialization("Initial young gen size set larger than the maximum young gen size"); + if (NewSize > MaxNewSize) { + if (FLAG_IS_CMDLINE(MaxNewSize)) { + warning("NewSize (" SIZE_FORMAT "k) is greater than the MaxNewSize (" SIZE_FORMAT "k). " + "A new max generation size of " SIZE_FORMAT "k will be used.", + NewSize/K, MaxNewSize/K, NewSize/K); + } + MaxNewSize = NewSize; } if (FLAG_IS_CMDLINE(NewSize)) { @@ -378,34 +394,48 @@ uint G1YoungGenSizer::calculate_default_max_length(uint new_number_of_heap_regio return MAX2(1U, default_value); } -void G1YoungGenSizer::heap_size_changed(uint new_number_of_heap_regions) { - assert(new_number_of_heap_regions > 0, "Heap must be initialized"); +void G1YoungGenSizer::recalculate_min_max_young_length(uint number_of_heap_regions, uint* min_young_length, uint* max_young_length) { + assert(number_of_heap_regions > 0, "Heap must be initialized"); switch (_sizer_kind) { case SizerDefaults: - _min_desired_young_length = calculate_default_min_length(new_number_of_heap_regions); - _max_desired_young_length = calculate_default_max_length(new_number_of_heap_regions); + *min_young_length = calculate_default_min_length(number_of_heap_regions); + *max_young_length = calculate_default_max_length(number_of_heap_regions); break; case SizerNewSizeOnly: - _max_desired_young_length = calculate_default_max_length(new_number_of_heap_regions); - _max_desired_young_length = MAX2(_min_desired_young_length, _max_desired_young_length); + *max_young_length = calculate_default_max_length(number_of_heap_regions); + *max_young_length = MAX2(*min_young_length, *max_young_length); break; case SizerMaxNewSizeOnly: - _min_desired_young_length = calculate_default_min_length(new_number_of_heap_regions); - _min_desired_young_length = MIN2(_min_desired_young_length, _max_desired_young_length); + *min_young_length = calculate_default_min_length(number_of_heap_regions); + *min_young_length = MIN2(*min_young_length, *max_young_length); break; case SizerMaxAndNewSize: // Do nothing. Values set on the command line, don't update them at runtime. break; case SizerNewRatio: - _min_desired_young_length = new_number_of_heap_regions / (NewRatio + 1); - _max_desired_young_length = _min_desired_young_length; + *min_young_length = number_of_heap_regions / (NewRatio + 1); + *max_young_length = *min_young_length; break; default: ShouldNotReachHere(); } - assert(_min_desired_young_length <= _max_desired_young_length, "Invalid min/max young gen size values"); + assert(*min_young_length <= *max_young_length, "Invalid min/max young gen size values"); +} + +uint G1YoungGenSizer::max_young_length(uint number_of_heap_regions) { + // We need to pass the desired values because recalculation may not update these + // values in some cases. + uint temp = _min_desired_young_length; + uint result = _max_desired_young_length; + recalculate_min_max_young_length(number_of_heap_regions, &temp, &result); + return result; +} + +void G1YoungGenSizer::heap_size_changed(uint new_number_of_heap_regions) { + recalculate_min_max_young_length(new_number_of_heap_regions, &_min_desired_young_length, + &_max_desired_young_length); } void G1CollectorPolicy::init() { diff --git a/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.hpp b/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.hpp index a497f2fa3b6..438bec82c51 100644 --- a/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.hpp +++ b/hotspot/src/share/vm/gc_implementation/g1/g1CollectorPolicy.hpp @@ -136,8 +136,16 @@ private: uint calculate_default_min_length(uint new_number_of_heap_regions); uint calculate_default_max_length(uint new_number_of_heap_regions); + // Update the given values for minimum and maximum young gen length in regions + // given the number of heap regions depending on the kind of sizing algorithm. + void recalculate_min_max_young_length(uint number_of_heap_regions, uint* min_young_length, uint* max_young_length); + public: G1YoungGenSizer(); + // Calculate the maximum length of the young gen given the number of regions + // depending on the sizing algorithm. + uint max_young_length(uint number_of_heap_regions); + void heap_size_changed(uint new_number_of_heap_regions); uint min_desired_young_length() { return _min_desired_young_length; @@ -165,13 +173,9 @@ private: G1MMUTracker* _mmu_tracker; + void initialize_alignments(); void initialize_flags(); - void initialize_all() { - initialize_flags(); - initialize_size_info(); - } - CollectionSetChooser* _collectionSetChooser; double _full_collection_start_sec; @@ -217,7 +221,6 @@ private: return _during_marking; } -private: enum PredictionConstants { TruncatedSeqLength = 10 }; @@ -665,8 +668,6 @@ public: BarrierSet::Name barrier_set_name() { return BarrierSet::G1SATBCTLogging; } - GenRemSet::Name rem_set_name() { return GenRemSet::CardTable; } - bool need_to_start_conc_mark(const char* source, size_t alloc_word_size = 0); // Record the start and end of an evacuation pause. @@ -934,6 +935,7 @@ public: // Calculates survivor space parameters. void update_survivors_policy(); + virtual void post_heap_initialize(); }; // This should move to some place more general... diff --git a/hotspot/src/share/vm/gc_implementation/g1/g1RemSet.cpp b/hotspot/src/share/vm/gc_implementation/g1/g1RemSet.cpp index 0ed37e6c5a5..a11be17ef53 100644 --- a/hotspot/src/share/vm/gc_implementation/g1/g1RemSet.cpp +++ b/hotspot/src/share/vm/gc_implementation/g1/g1RemSet.cpp @@ -377,11 +377,6 @@ void G1RemSet::prepare_for_oops_into_collection_set_do() { DirtyCardQueueSet& dcqs = JavaThread::dirty_card_queue_set(); dcqs.concatenate_logs(); - if (G1CollectedHeap::use_parallel_gc_threads()) { - // Don't set the number of workers here. It will be set - // when the task is run - // _seq_task->set_n_termination((int)n_workers()); - } guarantee( _cards_scanned == NULL, "invariant" ); _cards_scanned = NEW_C_HEAP_ARRAY(size_t, n_workers(), mtGC); for (uint i = 0; i < n_workers(); ++i) { diff --git a/hotspot/src/share/vm/gc_implementation/g1/heapRegion.cpp b/hotspot/src/share/vm/gc_implementation/g1/heapRegion.cpp index 00eec548995..47a7a7a088f 100644 --- a/hotspot/src/share/vm/gc_implementation/g1/heapRegion.cpp +++ b/hotspot/src/share/vm/gc_implementation/g1/heapRegion.cpp @@ -174,11 +174,6 @@ void HeapRegion::setup_heap_region_size(size_t initial_heap_size, size_t max_hea region_size = MAX_REGION_SIZE; } - if (region_size != G1HeapRegionSize) { - // Update the flag to make sure that PrintFlagsFinal logs the correct value - FLAG_SET_ERGO(uintx, G1HeapRegionSize, region_size); - } - // And recalculate the log. region_size_log = log2_long((jlong) region_size); @@ -606,7 +601,9 @@ void HeapRegion::remove_strong_code_root(nmethod* nm) { void HeapRegion::migrate_strong_code_roots() { assert(in_collection_set(), "only collection set regions"); - assert(!isHumongous(), "not humongous regions"); + assert(!isHumongous(), + err_msg("humongous region "HR_FORMAT" should not have been added to collection set", + HR_FORMAT_PARAMS(this))); HeapRegionRemSet* hrrs = rem_set(); hrrs->migrate_strong_code_roots(); @@ -727,12 +724,11 @@ void HeapRegion::verify_strong_code_roots(VerifyOption vo, bool* failures) const return; } - // An H-region should have an empty strong code root list - if (isHumongous()) { + if (continuesHumongous()) { if (strong_code_roots_length > 0) { - gclog_or_tty->print_cr("region ["PTR_FORMAT","PTR_FORMAT"] is humongous " - "but has "INT32_FORMAT" code root entries", - bottom(), end(), strong_code_roots_length); + gclog_or_tty->print_cr("region "HR_FORMAT" is a continuation of a humongous " + "region but has "INT32_FORMAT" code root entries", + HR_FORMAT_PARAMS(this), strong_code_roots_length); *failures = true; } return; diff --git a/hotspot/src/share/vm/gc_implementation/g1/heapRegionRemSet.cpp b/hotspot/src/share/vm/gc_implementation/g1/heapRegionRemSet.cpp index 68bdd760c2b..4308fc01873 100644 --- a/hotspot/src/share/vm/gc_implementation/g1/heapRegionRemSet.cpp +++ b/hotspot/src/share/vm/gc_implementation/g1/heapRegionRemSet.cpp @@ -1004,7 +1004,9 @@ public: void HeapRegionRemSet::migrate_strong_code_roots() { assert(hr()->in_collection_set(), "only collection set regions"); - assert(!hr()->isHumongous(), "not humongous regions"); + assert(!hr()->isHumongous(), + err_msg("humongous region "HR_FORMAT" should not have been added to the collection set", + HR_FORMAT_PARAMS(hr()))); ResourceMark rm; diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.cpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.cpp index 996a522927b..90bf630fe36 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.cpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.cpp @@ -25,6 +25,7 @@ #include "precompiled.hpp" #include "gc_implementation/parallelScavenge/adjoiningGenerations.hpp" #include "gc_implementation/parallelScavenge/adjoiningVirtualSpaces.hpp" +#include "gc_implementation/parallelScavenge/generationSizer.hpp" #include "gc_implementation/parallelScavenge/parallelScavengeHeap.hpp" // If boundary moving is being used, create the young gen and old @@ -32,15 +33,17 @@ // the old behavior otherwise (with PSYoungGen and PSOldGen). AdjoiningGenerations::AdjoiningGenerations(ReservedSpace old_young_rs, - size_t init_low_byte_size, - size_t min_low_byte_size, - size_t max_low_byte_size, - size_t init_high_byte_size, - size_t min_high_byte_size, - size_t max_high_byte_size, + GenerationSizer* policy, size_t alignment) : - _virtual_spaces(old_young_rs, min_low_byte_size, - min_high_byte_size, alignment) { + _virtual_spaces(old_young_rs, policy->min_gen1_size(), + policy->min_gen0_size(), alignment) { + size_t init_low_byte_size = policy->initial_gen1_size(); + size_t min_low_byte_size = policy->min_gen1_size(); + size_t max_low_byte_size = policy->max_gen1_size(); + size_t init_high_byte_size = policy->initial_gen0_size(); + size_t min_high_byte_size = policy->min_gen0_size(); + size_t max_high_byte_size = policy->max_gen0_size(); + assert(min_low_byte_size <= init_low_byte_size && init_low_byte_size <= max_low_byte_size, "Parameter check"); assert(min_high_byte_size <= init_high_byte_size && diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.hpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.hpp index 70afb9996ae..950baa1d53f 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.hpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/adjoiningGenerations.hpp @@ -28,6 +28,7 @@ #include "gc_implementation/parallelScavenge/adjoiningVirtualSpaces.hpp" #include "gc_implementation/parallelScavenge/asPSOldGen.hpp" #include "gc_implementation/parallelScavenge/asPSYoungGen.hpp" +#include "gc_implementation/parallelScavenge/generationSizer.hpp" // Contains two generations that both use an AdjoiningVirtualSpaces. @@ -56,14 +57,7 @@ class AdjoiningGenerations : public CHeapObj { bool request_young_gen_expansion(size_t desired_change_in_bytes); public: - AdjoiningGenerations(ReservedSpace rs, - size_t init_low_byte_size, - size_t min_low_byte_size, - size_t max_low_byte_size, - size_t init_high_byte_size, - size_t min_high_byte_size, - size_t max_high_bytes_size, - size_t alignment); + AdjoiningGenerations(ReservedSpace rs, GenerationSizer* policy, size_t alignment); // Accessors PSYoungGen* young_gen() { return _young_gen; } diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSOldGen.cpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSOldGen.cpp index 39f5835ffe5..9d2e8182e06 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSOldGen.cpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSOldGen.cpp @@ -54,7 +54,6 @@ ASPSOldGen::ASPSOldGen(size_t initial_size, int level) : PSOldGen(initial_size, min_size, size_limit, gen_name, level), _gen_size_limit(size_limit) - {} ASPSOldGen::ASPSOldGen(PSVirtualSpace* vs, @@ -65,13 +64,11 @@ ASPSOldGen::ASPSOldGen(PSVirtualSpace* vs, int level) : PSOldGen(initial_size, min_size, size_limit, gen_name, level), _gen_size_limit(size_limit) - { _virtual_space = vs; } void ASPSOldGen::initialize_work(const char* perf_data_name, int level) { - PSOldGen::initialize_work(perf_data_name, level); // The old gen can grow to gen_size_limit(). _reserve reflects only @@ -94,7 +91,7 @@ size_t ASPSOldGen::available_for_expansion() { ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); size_t result = gen_size_limit() - virtual_space()->committed_size(); - size_t result_aligned = align_size_down(result, heap->old_gen_alignment()); + size_t result_aligned = align_size_down(result, heap->generation_alignment()); return result_aligned; } @@ -105,7 +102,7 @@ size_t ASPSOldGen::available_for_contraction() { } ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - const size_t gen_alignment = heap->old_gen_alignment(); + const size_t gen_alignment = heap->generation_alignment(); PSAdaptiveSizePolicy* policy = heap->size_policy(); const size_t working_size = used_in_bytes() + (size_t) policy->avg_promoted()->padded_average(); diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSYoungGen.cpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSYoungGen.cpp index 73b63043b71..105772487c0 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSYoungGen.cpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/asPSYoungGen.cpp @@ -70,13 +70,12 @@ void ASPSYoungGen::initialize(ReservedSpace rs, size_t alignment) { } size_t ASPSYoungGen::available_for_expansion() { - size_t current_committed_size = virtual_space()->committed_size(); assert((gen_size_limit() >= current_committed_size), "generation size limit is wrong"); ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); size_t result = gen_size_limit() - current_committed_size; - size_t result_aligned = align_size_down(result, heap->young_gen_alignment()); + size_t result_aligned = align_size_down(result, heap->generation_alignment()); return result_aligned; } @@ -85,7 +84,6 @@ size_t ASPSYoungGen::available_for_expansion() { // Future implementations could check the survivors and if to_space is in the // right place (below from_space), take a chunk from to_space. size_t ASPSYoungGen::available_for_contraction() { - size_t uncommitted_bytes = virtual_space()->uncommitted_size(); if (uncommitted_bytes != 0) { return uncommitted_bytes; @@ -94,8 +92,8 @@ size_t ASPSYoungGen::available_for_contraction() { if (eden_space()->is_empty()) { // Respect the minimum size for eden and for the young gen as a whole. ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - const size_t eden_alignment = heap->intra_heap_alignment(); - const size_t gen_alignment = heap->young_gen_alignment(); + const size_t eden_alignment = heap->space_alignment(); + const size_t gen_alignment = heap->generation_alignment(); assert(eden_space()->capacity_in_bytes() >= eden_alignment, "Alignment is wrong"); @@ -121,7 +119,6 @@ size_t ASPSYoungGen::available_for_contraction() { gclog_or_tty->print_cr(" gen_avail %d K", gen_avail/K); } return result_aligned; - } return 0; @@ -132,7 +129,7 @@ size_t ASPSYoungGen::available_for_contraction() { // to_space can be. size_t ASPSYoungGen::available_to_live() { ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - const size_t alignment = heap->intra_heap_alignment(); + const size_t alignment = heap->space_alignment(); // Include any space that is committed but is not in eden. size_t available = pointer_delta(eden_space()->bottom(), @@ -296,7 +293,7 @@ void ASPSYoungGen::resize_spaces(size_t requested_eden_size, assert(eden_start < from_start, "Cannot push into from_space"); ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - const size_t alignment = heap->intra_heap_alignment(); + const size_t alignment = heap->space_alignment(); const bool maintain_minimum = (requested_eden_size + 2 * requested_survivor_size) <= min_gen_size(); diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/generationSizer.cpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/generationSizer.cpp new file mode 100644 index 00000000000..e417cd49599 --- /dev/null +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/generationSizer.cpp @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + * + */ + +#include "precompiled.hpp" +#include "gc_implementation/parallelScavenge/generationSizer.hpp" +#include "memory/collectorPolicy.hpp" + +void GenerationSizer::trace_gen_sizes(const char* const str) { + if (TracePageSizes) { + tty->print_cr("%s: " SIZE_FORMAT "," SIZE_FORMAT " " + SIZE_FORMAT "," SIZE_FORMAT " " + SIZE_FORMAT, + str, + _min_gen1_size / K, _max_gen1_size / K, + _min_gen0_size / K, _max_gen0_size / K, + _max_heap_byte_size / K); + } +} + +void GenerationSizer::initialize_alignments() { + _space_alignment = _gen_alignment = default_gen_alignment(); + _heap_alignment = compute_heap_alignment(); +} + +void GenerationSizer::initialize_flags() { + // Do basic sizing work + TwoGenerationCollectorPolicy::initialize_flags(); + + assert(UseSerialGC || + !FLAG_IS_DEFAULT(ParallelGCThreads) || + (ParallelGCThreads > 0), + "ParallelGCThreads should be set before flag initialization"); + + // The survivor ratio's are calculated "raw", unlike the + // default gc, which adds 2 to the ratio value. We need to + // make sure the values are valid before using them. + if (MinSurvivorRatio < 3) { + FLAG_SET_ERGO(uintx, MinSurvivorRatio, 3); + } + + if (InitialSurvivorRatio < 3) { + FLAG_SET_ERGO(uintx, InitialSurvivorRatio, 3); + } +} + +void GenerationSizer::initialize_size_info() { + trace_gen_sizes("ps heap raw"); + const size_t page_sz = os::page_size_for_region(_min_heap_byte_size, + _max_heap_byte_size, + 8); + + // Can a page size be something else than a power of two? + assert(is_power_of_2((intptr_t)page_sz), "must be a power of 2"); + size_t new_alignment = round_to(page_sz, _gen_alignment); + if (new_alignment != _gen_alignment) { + _gen_alignment = new_alignment; + _space_alignment = new_alignment; + // Redo everything from the start + initialize_flags(); + } + TwoGenerationCollectorPolicy::initialize_size_info(); + + trace_gen_sizes("ps heap rnd"); +} diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/generationSizer.hpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/generationSizer.hpp index f7be7671ff9..eb8c78a8c81 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/generationSizer.hpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/generationSizer.hpp @@ -31,41 +31,17 @@ // TwoGenerationCollectorPolicy. Lets reuse it! class GenerationSizer : public TwoGenerationCollectorPolicy { - public: - GenerationSizer() { - // Partial init only! - initialize_flags(); - initialize_size_info(); - } + private: - void initialize_flags() { - // Do basic sizing work - TwoGenerationCollectorPolicy::initialize_flags(); + void trace_gen_sizes(const char* const str); - assert(UseSerialGC || - !FLAG_IS_DEFAULT(ParallelGCThreads) || - (ParallelGCThreads > 0), - "ParallelGCThreads should be set before flag initialization"); + // The alignment used for boundary between young gen and old gen + static size_t default_gen_alignment() { return 64 * K * HeapWordSize; } - // The survivor ratio's are calculated "raw", unlike the - // default gc, which adds 2 to the ratio value. We need to - // make sure the values are valid before using them. - if (MinSurvivorRatio < 3) { - MinSurvivorRatio = 3; - } + protected: - if (InitialSurvivorRatio < 3) { - InitialSurvivorRatio = 3; - } - } - - size_t min_young_gen_size() { return _min_gen0_size; } - size_t young_gen_size() { return _initial_gen0_size; } - size_t max_young_gen_size() { return _max_gen0_size; } - - size_t min_old_gen_size() { return _min_gen1_size; } - size_t old_gen_size() { return _initial_gen1_size; } - size_t max_old_gen_size() { return _max_gen1_size; } + void initialize_alignments(); + void initialize_flags(); + void initialize_size_info(); }; - #endif // SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_GENERATIONSIZER_HPP diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.cpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.cpp index e5d5229d30c..f93f2e8991f 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.cpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.cpp @@ -52,76 +52,20 @@ PSGCAdaptivePolicyCounters* ParallelScavengeHeap::_gc_policy_counters = NULL; ParallelScavengeHeap* ParallelScavengeHeap::_psh = NULL; GCTaskManager* ParallelScavengeHeap::_gc_task_manager = NULL; -static void trace_gen_sizes(const char* const str, - size_t og_min, size_t og_max, - size_t yg_min, size_t yg_max) -{ - if (TracePageSizes) { - tty->print_cr("%s: " SIZE_FORMAT "," SIZE_FORMAT " " - SIZE_FORMAT "," SIZE_FORMAT " " - SIZE_FORMAT, - str, - og_min / K, og_max / K, - yg_min / K, yg_max / K, - (og_max + yg_max) / K); - } -} - jint ParallelScavengeHeap::initialize() { CollectedHeap::pre_initialize(); - // Cannot be initialized until after the flags are parsed - // GenerationSizer flag_parser; + // Initialize collector policy _collector_policy = new GenerationSizer(); + _collector_policy->initialize_all(); - size_t yg_min_size = _collector_policy->min_young_gen_size(); - size_t yg_max_size = _collector_policy->max_young_gen_size(); - size_t og_min_size = _collector_policy->min_old_gen_size(); - size_t og_max_size = _collector_policy->max_old_gen_size(); - - trace_gen_sizes("ps heap raw", - og_min_size, og_max_size, - yg_min_size, yg_max_size); - - const size_t og_page_sz = os::page_size_for_region(yg_min_size + og_min_size, - yg_max_size + og_max_size, - 8); - - const size_t og_align = set_alignment(_old_gen_alignment, og_page_sz); - const size_t yg_align = set_alignment(_young_gen_alignment, og_page_sz); - - // Update sizes to reflect the selected page size(s). - // - // NEEDS_CLEANUP. The default TwoGenerationCollectorPolicy uses NewRatio; it - // should check UseAdaptiveSizePolicy. Changes from generationSizer could - // move to the common code. - yg_min_size = align_size_up(yg_min_size, yg_align); - yg_max_size = align_size_up(yg_max_size, yg_align); - size_t yg_cur_size = - align_size_up(_collector_policy->young_gen_size(), yg_align); - yg_cur_size = MAX2(yg_cur_size, yg_min_size); - - og_min_size = align_size_up(og_min_size, og_align); - // Align old gen size down to preserve specified heap size. - assert(og_align == yg_align, "sanity"); - og_max_size = align_size_down(og_max_size, og_align); - og_max_size = MAX2(og_max_size, og_min_size); - size_t og_cur_size = - align_size_down(_collector_policy->old_gen_size(), og_align); - og_cur_size = MAX2(og_cur_size, og_min_size); - - trace_gen_sizes("ps heap rnd", - og_min_size, og_max_size, - yg_min_size, yg_max_size); - - const size_t heap_size = og_max_size + yg_max_size; - - ReservedSpace heap_rs = Universe::reserve_heap(heap_size, og_align); + const size_t heap_size = _collector_policy->max_heap_byte_size(); + ReservedSpace heap_rs = Universe::reserve_heap(heap_size, _collector_policy->heap_alignment()); MemTracker::record_virtual_memory_type((address)heap_rs.base(), mtJavaHeap); - os::trace_page_sizes("ps main", og_min_size + yg_min_size, - og_max_size + yg_max_size, og_page_sz, + os::trace_page_sizes("ps main", _collector_policy->min_heap_byte_size(), + heap_size, generation_alignment(), heap_rs.base(), heap_rs.size()); if (!heap_rs.is_reserved()) { @@ -142,12 +86,6 @@ jint ParallelScavengeHeap::initialize() { return JNI_ENOMEM; } - // Initial young gen size is 4 Mb - // - // XXX - what about flag_parser.young_gen_size()? - const size_t init_young_size = align_size_up(4 * M, yg_align); - yg_cur_size = MAX2(MIN2(init_young_size, yg_max_size), yg_cur_size); - // Make up the generations // Calculate the maximum size that a generation can grow. This // includes growth into the other generation. Note that the @@ -157,14 +95,7 @@ jint ParallelScavengeHeap::initialize() { double max_gc_pause_sec = ((double) MaxGCPauseMillis)/1000.0; double max_gc_minor_pause_sec = ((double) MaxGCMinorPauseMillis)/1000.0; - _gens = new AdjoiningGenerations(heap_rs, - og_cur_size, - og_min_size, - og_max_size, - yg_cur_size, - yg_min_size, - yg_max_size, - yg_align); + _gens = new AdjoiningGenerations(heap_rs, _collector_policy, generation_alignment()); _old_gen = _gens->old_gen(); _young_gen = _gens->young_gen(); @@ -176,7 +107,7 @@ jint ParallelScavengeHeap::initialize() { new PSAdaptiveSizePolicy(eden_capacity, initial_promo_size, young_gen()->to_space()->capacity_in_bytes(), - intra_heap_alignment(), + _collector_policy->gen_alignment(), max_gc_pause_sec, max_gc_minor_pause_sec, GCTimeRatio diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.hpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.hpp index 4e458efa903..51f40d8c62b 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.hpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/parallelScavengeHeap.hpp @@ -25,6 +25,7 @@ #ifndef SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARALLELSCAVENGEHEAP_HPP #define SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARALLELSCAVENGEHEAP_HPP +#include "gc_implementation/parallelScavenge/generationSizer.hpp" #include "gc_implementation/parallelScavenge/objectStartArray.hpp" #include "gc_implementation/parallelScavenge/psGCAdaptivePolicyCounters.hpp" #include "gc_implementation/parallelScavenge/psOldGen.hpp" @@ -32,14 +33,12 @@ #include "gc_implementation/shared/gcPolicyCounters.hpp" #include "gc_implementation/shared/gcWhen.hpp" #include "gc_interface/collectedHeap.inline.hpp" +#include "memory/collectorPolicy.hpp" #include "utilities/ostream.hpp" class AdjoiningGenerations; -class CollectorPolicy; class GCHeapSummary; class GCTaskManager; -class GenerationSizer; -class CollectorPolicy; class PSAdaptiveSizePolicy; class PSHeapSummary; @@ -50,24 +49,20 @@ class ParallelScavengeHeap : public CollectedHeap { static PSOldGen* _old_gen; // Sizing policy for entire heap - static PSAdaptiveSizePolicy* _size_policy; - static PSGCAdaptivePolicyCounters* _gc_policy_counters; + static PSAdaptiveSizePolicy* _size_policy; + static PSGCAdaptivePolicyCounters* _gc_policy_counters; static ParallelScavengeHeap* _psh; - size_t _young_gen_alignment; - size_t _old_gen_alignment; - GenerationSizer* _collector_policy; - inline size_t set_alignment(size_t& var, size_t val); - // Collection of generations that are adjacent in the // space reserved for the heap. AdjoiningGenerations* _gens; unsigned int _death_march_count; - static GCTaskManager* _gc_task_manager; // The task manager. + // The task manager + static GCTaskManager* _gc_task_manager; void trace_heap(GCWhen::Type when, GCTracer* tracer); @@ -80,16 +75,7 @@ class ParallelScavengeHeap : public CollectedHeap { HeapWord* mem_allocate_old_gen(size_t size); public: - ParallelScavengeHeap() : CollectedHeap() { - _death_march_count = 0; - set_alignment(_young_gen_alignment, intra_heap_alignment()); - set_alignment(_old_gen_alignment, intra_heap_alignment()); - } - - // Return the (conservative) maximum heap alignment - static size_t conservative_max_heap_alignment() { - return intra_heap_alignment(); - } + ParallelScavengeHeap() : CollectedHeap(), _death_march_count(0) { } // For use by VM operations enum CollectionType { @@ -103,8 +89,8 @@ class ParallelScavengeHeap : public CollectedHeap { virtual CollectorPolicy* collector_policy() const { return (CollectorPolicy*) _collector_policy; } - static PSYoungGen* young_gen() { return _young_gen; } - static PSOldGen* old_gen() { return _old_gen; } + static PSYoungGen* young_gen() { return _young_gen; } + static PSOldGen* old_gen() { return _old_gen; } virtual PSAdaptiveSizePolicy* size_policy() { return _size_policy; } @@ -121,13 +107,15 @@ class ParallelScavengeHeap : public CollectedHeap { void post_initialize(); void update_counters(); - // The alignment used for the various generations. - size_t young_gen_alignment() const { return _young_gen_alignment; } - size_t old_gen_alignment() const { return _old_gen_alignment; } - // The alignment used for eden and survivors within the young gen - // and for boundary between young gen and old gen. - static size_t intra_heap_alignment() { return 64 * K * HeapWordSize; } + // The alignment used for the various areas + size_t space_alignment() { return _collector_policy->space_alignment(); } + size_t generation_alignment() { return _collector_policy->gen_alignment(); } + + // Return the (conservative) maximum heap alignment + static size_t conservative_max_heap_alignment() { + return CollectorPolicy::compute_heap_alignment(); + } size_t capacity() const; size_t used() const; @@ -157,16 +145,15 @@ class ParallelScavengeHeap : public CollectedHeap { virtual bool is_in_partial_collection(const void *p); #endif - bool is_in_young(oop p); // reserved part - bool is_in_old(oop p); // reserved part + bool is_in_young(oop p); // reserved part + bool is_in_old(oop p); // reserved part // Memory allocation. "gc_time_limit_was_exceeded" will // be set to true if the adaptive size policy determine that // an excessive amount of time is being spent doing collections // and caused a NULL to be returned. If a NULL is not returned, // "gc_time_limit_was_exceeded" has an undefined meaning. - HeapWord* mem_allocate(size_t size, - bool* gc_overhead_limit_was_exceeded); + HeapWord* mem_allocate(size_t size, bool* gc_overhead_limit_was_exceeded); // Allocation attempt(s) during a safepoint. It should never be called // to allocate a new TLAB as this allocation might be satisfied out @@ -257,17 +244,10 @@ class ParallelScavengeHeap : public CollectedHeap { // Call these in sequential code around the processing of strong roots. class ParStrongRootsScope : public MarkingCodeBlobClosure::MarkScope { - public: + public: ParStrongRootsScope(); ~ParStrongRootsScope(); }; }; -inline size_t ParallelScavengeHeap::set_alignment(size_t& var, size_t val) -{ - assert(is_power_of_2((intptr_t)val), "must be a power of 2"); - var = round_to(val, intra_heap_alignment()); - return var; -} - #endif // SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARALLELSCAVENGEHEAP_HPP diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.cpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.cpp index 8d411811b3c..a2f2fa722bf 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.cpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.cpp @@ -37,7 +37,7 @@ PSAdaptiveSizePolicy::PSAdaptiveSizePolicy(size_t init_eden_size, size_t init_promo_size, size_t init_survivor_size, - size_t intra_generation_alignment, + size_t space_alignment, double gc_pause_goal_sec, double gc_minor_pause_goal_sec, uint gc_cost_ratio) : @@ -46,9 +46,8 @@ PSAdaptiveSizePolicy::PSAdaptiveSizePolicy(size_t init_eden_size, init_survivor_size, gc_pause_goal_sec, gc_cost_ratio), - _collection_cost_margin_fraction(AdaptiveSizePolicyCollectionCostMargin/ - 100.0), - _intra_generation_alignment(intra_generation_alignment), + _collection_cost_margin_fraction(AdaptiveSizePolicyCollectionCostMargin / 100.0), + _space_alignment(space_alignment), _live_at_last_full_gc(init_promo_size), _gc_minor_pause_goal_sec(gc_minor_pause_goal_sec), _latest_major_mutator_interval_seconds(0), @@ -353,11 +352,10 @@ void PSAdaptiveSizePolicy::compute_eden_space_size( } // Align everything and make a final limit check - const size_t alignment = _intra_generation_alignment; - desired_eden_size = align_size_up(desired_eden_size, alignment); - desired_eden_size = MAX2(desired_eden_size, alignment); + desired_eden_size = align_size_up(desired_eden_size, _space_alignment); + desired_eden_size = MAX2(desired_eden_size, _space_alignment); - eden_limit = align_size_down(eden_limit, alignment); + eden_limit = align_size_down(eden_limit, _space_alignment); // And one last limit check, now that we've aligned things. if (desired_eden_size > eden_limit) { @@ -561,11 +559,10 @@ void PSAdaptiveSizePolicy::compute_old_gen_free_space( } // Align everything and make a final limit check - const size_t alignment = _intra_generation_alignment; - desired_promo_size = align_size_up(desired_promo_size, alignment); - desired_promo_size = MAX2(desired_promo_size, alignment); + desired_promo_size = align_size_up(desired_promo_size, _space_alignment); + desired_promo_size = MAX2(desired_promo_size, _space_alignment); - promo_limit = align_size_down(promo_limit, alignment); + promo_limit = align_size_down(promo_limit, _space_alignment); // And one last limit check, now that we've aligned things. desired_promo_size = MIN2(desired_promo_size, promo_limit); @@ -650,7 +647,7 @@ void PSAdaptiveSizePolicy::adjust_promo_for_minor_pause_time(bool is_full_gc, } // If the desired eden size is as small as it will get, // try to adjust the old gen size. - if (*desired_eden_size_ptr <= _intra_generation_alignment) { + if (*desired_eden_size_ptr <= _space_alignment) { // Vary the old gen size to reduce the young gen pause. This // may not be a good idea. This is just a test. if (minor_pause_old_estimator()->decrement_will_decrease()) { @@ -755,7 +752,7 @@ void PSAdaptiveSizePolicy::adjust_eden_for_pause_time(bool is_full_gc, // If the promo size is at the minimum (i.e., the old gen // size will not actually decrease), consider changing the // young gen size. - if (*desired_promo_size_ptr < _intra_generation_alignment) { + if (*desired_promo_size_ptr < _space_alignment) { // If increasing the young generation will decrease the old gen // pause, do it. // During startup there is noise in the statistics for deciding @@ -1066,24 +1063,24 @@ size_t PSAdaptiveSizePolicy::eden_increment(size_t cur_eden) { size_t PSAdaptiveSizePolicy::eden_increment_aligned_up(size_t cur_eden) { size_t result = eden_increment(cur_eden, YoungGenerationSizeIncrement); - return align_size_up(result, _intra_generation_alignment); + return align_size_up(result, _space_alignment); } size_t PSAdaptiveSizePolicy::eden_increment_aligned_down(size_t cur_eden) { size_t result = eden_increment(cur_eden); - return align_size_down(result, _intra_generation_alignment); + return align_size_down(result, _space_alignment); } size_t PSAdaptiveSizePolicy::eden_increment_with_supplement_aligned_up( size_t cur_eden) { size_t result = eden_increment(cur_eden, YoungGenerationSizeIncrement + _young_gen_size_increment_supplement); - return align_size_up(result, _intra_generation_alignment); + return align_size_up(result, _space_alignment); } size_t PSAdaptiveSizePolicy::eden_decrement_aligned_down(size_t cur_eden) { size_t eden_heap_delta = eden_decrement(cur_eden); - return align_size_down(eden_heap_delta, _intra_generation_alignment); + return align_size_down(eden_heap_delta, _space_alignment); } size_t PSAdaptiveSizePolicy::eden_decrement(size_t cur_eden) { @@ -1105,24 +1102,24 @@ size_t PSAdaptiveSizePolicy::promo_increment(size_t cur_promo) { size_t PSAdaptiveSizePolicy::promo_increment_aligned_up(size_t cur_promo) { size_t result = promo_increment(cur_promo, TenuredGenerationSizeIncrement); - return align_size_up(result, _intra_generation_alignment); + return align_size_up(result, _space_alignment); } size_t PSAdaptiveSizePolicy::promo_increment_aligned_down(size_t cur_promo) { size_t result = promo_increment(cur_promo, TenuredGenerationSizeIncrement); - return align_size_down(result, _intra_generation_alignment); + return align_size_down(result, _space_alignment); } size_t PSAdaptiveSizePolicy::promo_increment_with_supplement_aligned_up( size_t cur_promo) { size_t result = promo_increment(cur_promo, TenuredGenerationSizeIncrement + _old_gen_size_increment_supplement); - return align_size_up(result, _intra_generation_alignment); + return align_size_up(result, _space_alignment); } size_t PSAdaptiveSizePolicy::promo_decrement_aligned_down(size_t cur_promo) { size_t promo_heap_delta = promo_decrement(cur_promo); - return align_size_down(promo_heap_delta, _intra_generation_alignment); + return align_size_down(promo_heap_delta, _space_alignment); } size_t PSAdaptiveSizePolicy::promo_decrement(size_t cur_promo) { @@ -1135,9 +1132,9 @@ uint PSAdaptiveSizePolicy::compute_survivor_space_size_and_threshold( bool is_survivor_overflow, uint tenuring_threshold, size_t survivor_limit) { - assert(survivor_limit >= _intra_generation_alignment, + assert(survivor_limit >= _space_alignment, "survivor_limit too small"); - assert((size_t)align_size_down(survivor_limit, _intra_generation_alignment) + assert((size_t)align_size_down(survivor_limit, _space_alignment) == survivor_limit, "survivor_limit not aligned"); // This method is called even if the tenuring threshold and survivor @@ -1201,8 +1198,8 @@ uint PSAdaptiveSizePolicy::compute_survivor_space_size_and_threshold( // We're trying to pad the survivor size as little as possible without // overflowing the survivor spaces. size_t target_size = align_size_up((size_t)_avg_survived->padded_average(), - _intra_generation_alignment); - target_size = MAX2(target_size, _intra_generation_alignment); + _space_alignment); + target_size = MAX2(target_size, _space_alignment); if (target_size > survivor_limit) { // Target size is bigger than we can handle. Let's also reduce diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.hpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.hpp index d88af2bf6ef..3389911876f 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.hpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/psAdaptiveSizePolicy.hpp @@ -91,7 +91,7 @@ class PSAdaptiveSizePolicy : public AdaptiveSizePolicy { // for making ergonomic decisions. double _latest_major_mutator_interval_seconds; - const size_t _intra_generation_alignment; // alignment for eden, survivors + const size_t _space_alignment; // alignment for eden, survivors const double _gc_minor_pause_goal_sec; // goal for maximum minor gc pause @@ -229,7 +229,7 @@ class PSAdaptiveSizePolicy : public AdaptiveSizePolicy { PSAdaptiveSizePolicy(size_t init_eden_size, size_t init_promo_size, size_t init_survivor_size, - size_t intra_generation_alignment, + size_t space_alignment, double gc_pause_goal_sec, double gc_minor_pause_goal_sec, uint gc_time_ratio); @@ -378,7 +378,7 @@ class PSAdaptiveSizePolicy : public AdaptiveSizePolicy { // remain almost full anyway (top() will be near end(), but there will be a // large filler object at the bottom). const size_t sz = gen_size / MinSurvivorRatio; - const size_t alignment = _intra_generation_alignment; + const size_t alignment = _space_alignment; return sz > alignment ? align_size_down(sz, alignment) : alignment; } diff --git a/hotspot/src/share/vm/gc_implementation/parallelScavenge/psYoungGen.cpp b/hotspot/src/share/vm/gc_implementation/parallelScavenge/psYoungGen.cpp index 2d8697587ac..c1f5c298794 100644 --- a/hotspot/src/share/vm/gc_implementation/parallelScavenge/psYoungGen.cpp +++ b/hotspot/src/share/vm/gc_implementation/parallelScavenge/psYoungGen.cpp @@ -103,7 +103,7 @@ void PSYoungGen::initialize_work() { // Compute maximum space sizes for performance counters ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - size_t alignment = heap->intra_heap_alignment(); + size_t alignment = heap->space_alignment(); size_t size = virtual_space()->reserved_size(); size_t max_survivor_size; @@ -156,8 +156,9 @@ void PSYoungGen::compute_initial_space_boundaries() { assert(heap->kind() == CollectedHeap::ParallelScavengeHeap, "Sanity"); // Compute sizes - size_t alignment = heap->intra_heap_alignment(); + size_t alignment = heap->space_alignment(); size_t size = virtual_space()->committed_size(); + assert(size >= 3 * alignment, "Young space is not large enough for eden + 2 survivors"); size_t survivor_size = size / InitialSurvivorRatio; survivor_size = align_size_down(survivor_size, alignment); @@ -207,7 +208,7 @@ void PSYoungGen::set_space_boundaries(size_t eden_size, size_t survivor_size) { #ifndef PRODUCT void PSYoungGen::space_invariants() { ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - const size_t alignment = heap->intra_heap_alignment(); + const size_t alignment = heap->space_alignment(); // Currently, our eden size cannot shrink to zero guarantee(eden_space()->capacity_in_bytes() >= alignment, "eden too small"); @@ -491,7 +492,7 @@ void PSYoungGen::resize_spaces(size_t requested_eden_size, char* to_end = (char*)to_space()->end(); ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - const size_t alignment = heap->intra_heap_alignment(); + const size_t alignment = heap->space_alignment(); const bool maintain_minimum = (requested_eden_size + 2 * requested_survivor_size) <= min_gen_size(); @@ -840,8 +841,8 @@ size_t PSYoungGen::available_to_min_gen() { size_t PSYoungGen::available_to_live() { size_t delta_in_survivor = 0; ParallelScavengeHeap* heap = (ParallelScavengeHeap*)Universe::heap(); - const size_t space_alignment = heap->intra_heap_alignment(); - const size_t gen_alignment = heap->young_gen_alignment(); + const size_t space_alignment = heap->space_alignment(); + const size_t gen_alignment = heap->generation_alignment(); MutableSpace* space_shrinking = NULL; if (from_space()->end() > to_space()->end()) { diff --git a/hotspot/src/share/vm/gc_interface/collectedHeap.cpp b/hotspot/src/share/vm/gc_interface/collectedHeap.cpp index bbf5419fd0f..742e3b73be8 100644 --- a/hotspot/src/share/vm/gc_interface/collectedHeap.cpp +++ b/hotspot/src/share/vm/gc_interface/collectedHeap.cpp @@ -469,6 +469,10 @@ void CollectedHeap::fill_with_objects(HeapWord* start, size_t words, bool zap) fill_with_object_impl(start, words, zap); } +void CollectedHeap::post_initialize() { + collector_policy()->post_heap_initialize(); +} + HeapWord* CollectedHeap::allocate_new_tlab(size_t size) { guarantee(false, "thread-local allocation buffers not supported"); return NULL; diff --git a/hotspot/src/share/vm/interpreter/linkResolver.cpp b/hotspot/src/share/vm/interpreter/linkResolver.cpp index f88dd153394..f829a961f44 100644 --- a/hotspot/src/share/vm/interpreter/linkResolver.cpp +++ b/hotspot/src/share/vm/interpreter/linkResolver.cpp @@ -152,11 +152,13 @@ CallInfo::CallInfo(Method* resolved_method, Klass* resolved_klass) { // Could be an Object method inherited into an interface, but still a vtable call. kind = CallInfo::vtable_call; } else if (!resolved_klass->is_interface()) { - // A miranda method. Compute the vtable index. + // A default or miranda method. Compute the vtable index. ResourceMark rm; klassVtable* vt = InstanceKlass::cast(resolved_klass)->vtable(); - index = vt->index_of_miranda(resolved_method->name(), - resolved_method->signature()); + index = LinkResolver::vtable_index_of_interface_method(resolved_klass, + resolved_method); + assert(index >= 0 , "we should have valid vtable index at this point"); + kind = CallInfo::vtable_call; } else if (resolved_method->has_vtable_index()) { // Can occur if an interface redeclares a method of Object. @@ -279,7 +281,7 @@ void LinkResolver::lookup_instance_method_in_klasses(methodHandle& result, Klass } int LinkResolver::vtable_index_of_interface_method(KlassHandle klass, - methodHandle resolved_method, TRAPS) { + methodHandle resolved_method) { int vtable_index = Method::invalid_vtable_index; Symbol* name = resolved_method->name(); @@ -295,7 +297,7 @@ int LinkResolver::vtable_index_of_interface_method(KlassHandle klass, } if (vtable_index == Method::invalid_vtable_index) { // get vtable_index for miranda methods - ResourceMark rm(THREAD); + ResourceMark rm; klassVtable *vt = InstanceKlass::cast(klass())->vtable(); vtable_index = vt->index_of_miranda(name, signature); } @@ -691,7 +693,7 @@ void LinkResolver::resolve_interface_method(methodHandle& resolved_method, ); resolved_method->access_flags().print_on(tty); if (resolved_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (resolved_method->is_overpass()) { tty->print("overpass"); @@ -937,7 +939,7 @@ void LinkResolver::linktime_resolve_special_method(methodHandle& resolved_method ); resolved_method->access_flags().print_on(tty); if (resolved_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (resolved_method->is_overpass()) { tty->print("overpass"); @@ -1017,7 +1019,7 @@ void LinkResolver::runtime_resolve_special_method(CallInfo& result, methodHandle ); sel_method->access_flags().print_on(tty); if (sel_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (sel_method->is_overpass()) { tty->print("overpass"); @@ -1081,7 +1083,7 @@ void LinkResolver::linktime_resolve_virtual_method(methodHandle &resolved_method ); resolved_method->access_flags().print_on(tty); if (resolved_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (resolved_method->is_overpass()) { tty->print("overpass"); @@ -1118,7 +1120,7 @@ void LinkResolver::runtime_resolve_virtual_method(CallInfo& result, // do lookup based on receiver klass using the vtable index if (resolved_method->method_holder()->is_interface()) { // miranda method vtable_index = vtable_index_of_interface_method(resolved_klass, - resolved_method, CHECK); + resolved_method); assert(vtable_index >= 0 , "we should have valid vtable index at this point"); InstanceKlass* inst = InstanceKlass::cast(recv_klass()); @@ -1175,7 +1177,7 @@ void LinkResolver::runtime_resolve_virtual_method(CallInfo& result, ); selected_method->access_flags().print_on(tty); if (selected_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (selected_method->is_overpass()) { tty->print("overpass"); @@ -1268,14 +1270,6 @@ void LinkResolver::runtime_resolve_interface_method(CallInfo& result, methodHand sel_method->name(), sel_method->signature())); } - // setup result - if (!resolved_method->has_itable_index()) { - int vtable_index = resolved_method->vtable_index(); - assert(vtable_index == sel_method->vtable_index(), "sanity check"); - result.set_virtual(resolved_klass, recv_klass, resolved_method, sel_method, vtable_index, CHECK); - return; - } - int itable_index = resolved_method()->itable_index(); if (TraceItables && Verbose) { ResourceMark rm(THREAD); @@ -1289,14 +1283,22 @@ void LinkResolver::runtime_resolve_interface_method(CallInfo& result, methodHand ); sel_method->access_flags().print_on(tty); if (sel_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (sel_method->is_overpass()) { tty->print("overpass"); } tty->cr(); } - result.set_interface(resolved_klass, recv_klass, resolved_method, sel_method, itable_index, CHECK); + // setup result + if (!resolved_method->has_itable_index()) { + int vtable_index = resolved_method->vtable_index(); + assert(vtable_index == sel_method->vtable_index(), "sanity check"); + result.set_virtual(resolved_klass, recv_klass, resolved_method, sel_method, vtable_index, CHECK); + } else { + int itable_index = resolved_method()->itable_index(); + result.set_interface(resolved_klass, recv_klass, resolved_method, sel_method, itable_index, CHECK); + } } diff --git a/hotspot/src/share/vm/interpreter/linkResolver.hpp b/hotspot/src/share/vm/interpreter/linkResolver.hpp index 339cb92ba29..1411d909b9c 100644 --- a/hotspot/src/share/vm/interpreter/linkResolver.hpp +++ b/hotspot/src/share/vm/interpreter/linkResolver.hpp @@ -130,7 +130,6 @@ class LinkResolver: AllStatic { static void lookup_polymorphic_method (methodHandle& result, KlassHandle klass, Symbol* name, Symbol* signature, KlassHandle current_klass, Handle *appendix_result_or_null, Handle *method_type_result, TRAPS); - static int vtable_index_of_interface_method(KlassHandle klass, methodHandle resolved_method, TRAPS); static void resolve_klass (KlassHandle& result, constantPoolHandle pool, int index, TRAPS); static void resolve_pool (KlassHandle& resolved_klass, Symbol*& method_name, Symbol*& method_signature, KlassHandle& current_klass, constantPoolHandle pool, int index, TRAPS); @@ -186,6 +185,7 @@ class LinkResolver: AllStatic { static methodHandle resolve_interface_call_or_null(KlassHandle receiver_klass, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass); static methodHandle resolve_static_call_or_null (KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass); static methodHandle resolve_special_call_or_null (KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass); + static int vtable_index_of_interface_method(KlassHandle klass, methodHandle resolved_method); // same as above for compile-time resolution; returns vtable_index if current_klass if linked static int resolve_virtual_vtable_index (KlassHandle receiver_klass, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass); diff --git a/hotspot/src/share/vm/interpreter/rewriter.cpp b/hotspot/src/share/vm/interpreter/rewriter.cpp index 249fca33afe..208f8617d5d 100644 --- a/hotspot/src/share/vm/interpreter/rewriter.cpp +++ b/hotspot/src/share/vm/interpreter/rewriter.cpp @@ -72,19 +72,21 @@ void Rewriter::compute_index_maps() { // Unrewrite the bytecodes if an error occurs. void Rewriter::restore_bytecodes() { int len = _methods->length(); + bool invokespecial_error = false; for (int i = len-1; i >= 0; i--) { Method* method = _methods->at(i); - scan_method(method, true); + scan_method(method, true, &invokespecial_error); + assert(!invokespecial_error, "reversing should not get an invokespecial error"); } } // Creates a constant pool cache given a CPC map void Rewriter::make_constant_pool_cache(TRAPS) { - const int length = _cp_cache_map.length(); ClassLoaderData* loader_data = _pool->pool_holder()->class_loader_data(); ConstantPoolCache* cache = - ConstantPoolCache::allocate(loader_data, length, _cp_cache_map, + ConstantPoolCache::allocate(loader_data, _cp_cache_map, + _invokedynamic_cp_cache_map, _invokedynamic_references_map, CHECK); // initialize object cache in constant pool @@ -154,6 +156,30 @@ void Rewriter::rewrite_member_reference(address bcp, int offset, bool reverse) { } } +// If the constant pool entry for invokespecial is InterfaceMethodref, +// we need to add a separate cpCache entry for its resolution, because it is +// different than the resolution for invokeinterface with InterfaceMethodref. +// These cannot share cpCache entries. It's unclear if all invokespecial to +// InterfaceMethodrefs would resolve to the same thing so a new cpCache entry +// is created for each one. This was added with lambda. +void Rewriter::rewrite_invokespecial(address bcp, int offset, bool reverse, bool* invokespecial_error) { + address p = bcp + offset; + if (!reverse) { + int cp_index = Bytes::get_Java_u2(p); + if (_pool->tag_at(cp_index).is_interface_method()) { + int cache_index = add_invokespecial_cp_cache_entry(cp_index); + if (cache_index != (int)(jushort) cache_index) { + *invokespecial_error = true; + } + Bytes::put_native_u2(p, cache_index); + } else { + rewrite_member_reference(bcp, offset, reverse); + } + } else { + rewrite_member_reference(bcp, offset, reverse); + } +} + // Adjust the invocation bytecode for a signature-polymorphic method (MethodHandle.invoke, etc.) void Rewriter::maybe_rewrite_invokehandle(address opc, int cp_index, int cache_index, bool reverse) { @@ -203,7 +229,7 @@ void Rewriter::rewrite_invokedynamic(address bcp, int offset, bool reverse) { if (!reverse) { int cp_index = Bytes::get_Java_u2(p); int cache_index = add_invokedynamic_cp_cache_entry(cp_index); - add_invokedynamic_resolved_references_entries(cp_index, cache_index); + int resolved_index = add_invokedynamic_resolved_references_entries(cp_index, cache_index); // Replace the trailing four bytes with a CPC index for the dynamic // call site. Unlike other CPC entries, there is one per bytecode, // not just one per distinct CP entry. In other words, the @@ -212,13 +238,20 @@ void Rewriter::rewrite_invokedynamic(address bcp, int offset, bool reverse) { // all these entries. That is the main reason invokedynamic // must have a five-byte instruction format. (Of course, other JVM // implementations can use the bytes for other purposes.) - Bytes::put_native_u4(p, ConstantPool::encode_invokedynamic_index(cache_index)); // Note: We use native_u4 format exclusively for 4-byte indexes. + Bytes::put_native_u4(p, ConstantPool::encode_invokedynamic_index(cache_index)); + // add the bcp in case we need to patch this bytecode if we also find a + // invokespecial/InterfaceMethodref in the bytecode stream + _patch_invokedynamic_bcps->push(p); + _patch_invokedynamic_refs->push(resolved_index); } else { - // callsite index int cache_index = ConstantPool::decode_invokedynamic_index( Bytes::get_native_u4(p)); - int cp_index = cp_cache_entry_pool_index(cache_index); + // We will reverse the bytecode rewriting _after_ adjusting them. + // Adjust the cache index by offset to the invokedynamic entries in the + // cpCache plus the delta if the invokedynamic bytecodes were adjusted. + cache_index = cp_cache_delta() + _first_iteration_cp_cache_limit; + int cp_index = invokedynamic_cp_cache_entry_pool_index(cache_index); assert(_pool->tag_at(cp_index).is_invoke_dynamic(), "wrong index"); // zero out 4 bytes Bytes::put_Java_u4(p, 0); @@ -226,6 +259,34 @@ void Rewriter::rewrite_invokedynamic(address bcp, int offset, bool reverse) { } } +void Rewriter::patch_invokedynamic_bytecodes() { + // If the end of the cp_cache is the same as after initializing with the + // cpool, nothing needs to be done. Invokedynamic bytecodes are at the + // correct offsets. ie. no invokespecials added + int delta = cp_cache_delta(); + if (delta > 0) { + int length = _patch_invokedynamic_bcps->length(); + assert(length == _patch_invokedynamic_refs->length(), + "lengths should match"); + for (int i = 0; i < length; i++) { + address p = _patch_invokedynamic_bcps->at(i); + int cache_index = ConstantPool::decode_invokedynamic_index( + Bytes::get_native_u4(p)); + Bytes::put_native_u4(p, ConstantPool::encode_invokedynamic_index(cache_index + delta)); + + // invokedynamic resolved references map also points to cp cache and must + // add delta to each. + int resolved_index = _patch_invokedynamic_refs->at(i); + for (int entry = 0; entry < ConstantPoolCacheEntry::_indy_resolved_references_entries; entry++) { + assert(_invokedynamic_references_map[resolved_index+entry] == cache_index, + "should be the same index"); + _invokedynamic_references_map.at_put(resolved_index+entry, + cache_index + delta); + } + } + } +} + // Rewrite some ldc bytecodes to _fast_aldc void Rewriter::maybe_rewrite_ldc(address bcp, int offset, bool is_wide, @@ -269,7 +330,7 @@ void Rewriter::maybe_rewrite_ldc(address bcp, int offset, bool is_wide, // Rewrites a method given the index_map information -void Rewriter::scan_method(Method* method, bool reverse) { +void Rewriter::scan_method(Method* method, bool reverse, bool* invokespecial_error) { int nof_jsrs = 0; bool has_monitor_bytecodes = false; @@ -329,12 +390,17 @@ void Rewriter::scan_method(Method* method, bool reverse) { #endif break; } + + case Bytecodes::_invokespecial : { + rewrite_invokespecial(bcp, prefix_length+1, reverse, invokespecial_error); + break; + } + case Bytecodes::_getstatic : // fall through case Bytecodes::_putstatic : // fall through case Bytecodes::_getfield : // fall through case Bytecodes::_putfield : // fall through case Bytecodes::_invokevirtual : // fall through - case Bytecodes::_invokespecial : // fall through case Bytecodes::_invokestatic : case Bytecodes::_invokeinterface: case Bytecodes::_invokehandle : // if reverse=true @@ -423,12 +489,26 @@ Rewriter::Rewriter(instanceKlassHandle klass, constantPoolHandle cpool, Arraylength(); + bool invokespecial_error = false; for (int i = len-1; i >= 0; i--) { Method* method = _methods->at(i); - scan_method(method); + scan_method(method, false, &invokespecial_error); + if (invokespecial_error) { + // If you get an error here, there is no reversing bytecodes + // This exception is stored for this class and no further attempt is + // made at verifying or rewriting. + THROW_MSG(vmSymbols::java_lang_InternalError(), + "This classfile overflows invokespecial for interfaces " + "and cannot be loaded"); + return; + } } + // May have to fix invokedynamic bytecodes if invokestatic/InterfaceMethodref + // entries had to be added. + patch_invokedynamic_bytecodes(); + // allocate constant pool cache, now that we've seen all the bytecodes make_constant_pool_cache(THREAD); diff --git a/hotspot/src/share/vm/interpreter/rewriter.hpp b/hotspot/src/share/vm/interpreter/rewriter.hpp index 56067983c84..2c7990fa7e5 100644 --- a/hotspot/src/share/vm/interpreter/rewriter.hpp +++ b/hotspot/src/share/vm/interpreter/rewriter.hpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -46,55 +46,102 @@ class Rewriter: public StackObj { intArray _method_handle_invokers; int _resolved_reference_limit; + // For mapping invokedynamic bytecodes, which are discovered during method + // scanning. The invokedynamic entries are added at the end of the cpCache. + // If there are any invokespecial/InterfaceMethodref special case bytecodes, + // these entries are added before invokedynamic entries so that the + // invokespecial bytecode 16 bit index doesn't overflow. + intStack _invokedynamic_cp_cache_map; + + // For patching. + GrowableArray
* _patch_invokedynamic_bcps; + GrowableArray* _patch_invokedynamic_refs; + void init_maps(int length) { _cp_map.initialize(length, -1); // Choose an initial value large enough that we don't get frequent // calls to grow(). - _cp_cache_map.initialize(length / 2); + _cp_cache_map.initialize(length/2); // Also cache resolved objects, in another different cache. _reference_map.initialize(length, -1); - _resolved_references_map.initialize(length / 2); - _invokedynamic_references_map.initialize(length / 2); + _resolved_references_map.initialize(length/2); + _invokedynamic_references_map.initialize(length/2); _resolved_reference_limit = -1; - DEBUG_ONLY(_cp_cache_index_limit = -1); + _first_iteration_cp_cache_limit = -1; + + // invokedynamic specific fields + _invokedynamic_cp_cache_map.initialize(length/4); + _patch_invokedynamic_bcps = new GrowableArray
(length/4); + _patch_invokedynamic_refs = new GrowableArray(length/4); } - int _cp_cache_index_limit; + int _first_iteration_cp_cache_limit; void record_map_limits() { -#ifdef ASSERT - // Record initial size of the two arrays generated for the CP cache: - _cp_cache_index_limit = _cp_cache_map.length(); -#endif //ASSERT + // Record initial size of the two arrays generated for the CP cache + // relative to walking the constant pool. + _first_iteration_cp_cache_limit = _cp_cache_map.length(); _resolved_reference_limit = _resolved_references_map.length(); } + int cp_cache_delta() { + // How many cp cache entries were added since recording map limits after + // cp cache initialization? + assert(_first_iteration_cp_cache_limit != -1, "only valid after first iteration"); + return _cp_cache_map.length() - _first_iteration_cp_cache_limit; + } + int cp_entry_to_cp_cache(int i) { assert(has_cp_cache(i), "oob"); return _cp_map[i]; } bool has_cp_cache(int i) { return (uint)i < (uint)_cp_map.length() && _cp_map[i] >= 0; } + int add_map_entry(int cp_index, intArray* cp_map, intStack* cp_cache_map) { + assert(cp_map->at(cp_index) == -1, "not twice on same cp_index"); + int cache_index = cp_cache_map->append(cp_index); + cp_map->at_put(cp_index, cache_index); + return cache_index; + } + int add_cp_cache_entry(int cp_index) { assert(_pool->tag_at(cp_index).value() != JVM_CONSTANT_InvokeDynamic, "use indy version"); - assert(_cp_map[cp_index] == -1, "not twice on same cp_index"); - assert(_cp_cache_index_limit == -1, "do not add cache entries after first iteration"); - int cache_index = _cp_cache_map.append(cp_index); - _cp_map.at_put(cp_index, cache_index); + assert(_first_iteration_cp_cache_limit == -1, "do not add cache entries after first iteration"); + int cache_index = add_map_entry(cp_index, &_cp_map, &_cp_cache_map); assert(cp_entry_to_cp_cache(cp_index) == cache_index, ""); assert(cp_cache_entry_pool_index(cache_index) == cp_index, ""); return cache_index; } - // add a new CP cache entry beyond the normal cache (for invokedynamic only) int add_invokedynamic_cp_cache_entry(int cp_index) { assert(_pool->tag_at(cp_index).value() == JVM_CONSTANT_InvokeDynamic, "use non-indy version"); - assert(_cp_map[cp_index] == -1, "do not map from cp_index"); - assert(_cp_cache_index_limit >= 0, "add indy cache entries after first iteration"); + assert(_first_iteration_cp_cache_limit >= 0, "add indy cache entries after first iteration"); + // add to the invokedynamic index map. + int cache_index = _invokedynamic_cp_cache_map.append(cp_index); + // do not update _cp_map, since the mapping is one-to-many + assert(invokedynamic_cp_cache_entry_pool_index(cache_index) == cp_index, ""); + // this index starts at one but in the bytecode it's appended to the end. + return cache_index + _first_iteration_cp_cache_limit; + } + + int invokedynamic_cp_cache_entry_pool_index(int cache_index) { + int cp_index = _invokedynamic_cp_cache_map[cache_index]; + return cp_index; + } + + // add a new CP cache entry beyond the normal cache for the special case of + // invokespecial with InterfaceMethodref as cpool operand. + int add_invokespecial_cp_cache_entry(int cp_index) { + assert(_first_iteration_cp_cache_limit >= 0, "add these special cache entries after first iteration"); + // Don't add InterfaceMethodref if it already exists at the end. + for (int i = _first_iteration_cp_cache_limit; i < _cp_cache_map.length(); i++) { + if (cp_cache_entry_pool_index(i) == cp_index) { + return i; + } + } int cache_index = _cp_cache_map.append(cp_index); - assert(cache_index >= _cp_cache_index_limit, ""); + assert(cache_index >= _first_iteration_cp_cache_limit, ""); // do not update _cp_map, since the mapping is one-to-many assert(cp_cache_entry_pool_index(cache_index) == cp_index, ""); return cache_index; } - // fix duplicated code later int cp_entry_to_resolved_references(int cp_index) const { assert(has_entry_in_resolved_references(cp_index), "oob"); return _reference_map[cp_index]; @@ -105,10 +152,7 @@ class Rewriter: public StackObj { // add a new entry to the resolved_references map int add_resolved_references_entry(int cp_index) { - assert(_reference_map[cp_index] == -1, "not twice on same cp_index"); - assert(_resolved_reference_limit == -1, "do not add CP refs after first iteration"); - int ref_index = _resolved_references_map.append(cp_index); - _reference_map.at_put(cp_index, ref_index); + int ref_index = add_map_entry(cp_index, &_reference_map, &_resolved_references_map); assert(cp_entry_to_resolved_references(cp_index) == ref_index, ""); return ref_index; } @@ -137,7 +181,7 @@ class Rewriter: public StackObj { // Access the contents of _cp_cache_map to determine CP cache layout. int cp_cache_entry_pool_index(int cache_index) { int cp_index = _cp_cache_map[cache_index]; - return cp_index; + return cp_index; } // All the work goes in here: @@ -145,12 +189,16 @@ class Rewriter: public StackObj { void compute_index_maps(); void make_constant_pool_cache(TRAPS); - void scan_method(Method* m, bool reverse = false); + void scan_method(Method* m, bool reverse, bool* invokespecial_error); void rewrite_Object_init(methodHandle m, TRAPS); - void rewrite_member_reference(address bcp, int offset, bool reverse = false); - void maybe_rewrite_invokehandle(address opc, int cp_index, int cache_index, bool reverse = false); - void rewrite_invokedynamic(address bcp, int offset, bool reverse = false); - void maybe_rewrite_ldc(address bcp, int offset, bool is_wide, bool reverse = false); + void rewrite_member_reference(address bcp, int offset, bool reverse); + void maybe_rewrite_invokehandle(address opc, int cp_index, int cache_index, bool reverse); + void rewrite_invokedynamic(address bcp, int offset, bool reverse); + void maybe_rewrite_ldc(address bcp, int offset, bool is_wide, bool reverse); + void rewrite_invokespecial(address bcp, int offset, bool reverse, bool* invokespecial_error); + + void patch_invokedynamic_bytecodes(); + // Revert bytecodes in case of an exception. void restore_bytecodes(); diff --git a/hotspot/src/share/vm/memory/collectorPolicy.cpp b/hotspot/src/share/vm/memory/collectorPolicy.cpp index a3c466327ef..204011b689e 100644 --- a/hotspot/src/share/vm/memory/collectorPolicy.cpp +++ b/hotspot/src/share/vm/memory/collectorPolicy.cpp @@ -47,54 +47,107 @@ // CollectorPolicy methods. -void CollectorPolicy::initialize_flags() { - assert(_max_alignment >= _min_alignment, - err_msg("max_alignment: " SIZE_FORMAT " less than min_alignment: " SIZE_FORMAT, - _max_alignment, _min_alignment)); - assert(_max_alignment % _min_alignment == 0, - err_msg("max_alignment: " SIZE_FORMAT " not aligned by min_alignment: " SIZE_FORMAT, - _max_alignment, _min_alignment)); +CollectorPolicy::CollectorPolicy() : + _space_alignment(0), + _heap_alignment(0), + _initial_heap_byte_size(InitialHeapSize), + _max_heap_byte_size(MaxHeapSize), + _min_heap_byte_size(Arguments::min_heap_size()), + _max_heap_size_cmdline(false), + _size_policy(NULL), + _should_clear_all_soft_refs(false), + _all_soft_refs_clear(false) +{} - if (MaxHeapSize < InitialHeapSize) { - vm_exit_during_initialization("Incompatible initial and maximum heap sizes specified"); - } - - MinHeapDeltaBytes = align_size_up(MinHeapDeltaBytes, _min_alignment); +#ifdef ASSERT +void CollectorPolicy::assert_flags() { + assert(InitialHeapSize <= MaxHeapSize, "Ergonomics decided on incompatible initial and maximum heap sizes"); + assert(InitialHeapSize % _heap_alignment == 0, "InitialHeapSize alignment"); + assert(MaxHeapSize % _heap_alignment == 0, "MaxHeapSize alignment"); } -void CollectorPolicy::initialize_size_info() { - // User inputs from -mx and ms must be aligned - _min_heap_byte_size = align_size_up(Arguments::min_heap_size(), _min_alignment); - _initial_heap_byte_size = align_size_up(InitialHeapSize, _min_alignment); - _max_heap_byte_size = align_size_up(MaxHeapSize, _max_alignment); +void CollectorPolicy::assert_size_info() { + assert(InitialHeapSize == _initial_heap_byte_size, "Discrepancy between InitialHeapSize flag and local storage"); + assert(MaxHeapSize == _max_heap_byte_size, "Discrepancy between MaxHeapSize flag and local storage"); + assert(_max_heap_byte_size >= _min_heap_byte_size, "Ergonomics decided on incompatible minimum and maximum heap sizes"); + assert(_initial_heap_byte_size >= _min_heap_byte_size, "Ergonomics decided on incompatible initial and minimum heap sizes"); + assert(_max_heap_byte_size >= _initial_heap_byte_size, "Ergonomics decided on incompatible initial and maximum heap sizes"); + assert(_min_heap_byte_size % _heap_alignment == 0, "min_heap_byte_size alignment"); + assert(_initial_heap_byte_size % _heap_alignment == 0, "initial_heap_byte_size alignment"); + assert(_max_heap_byte_size % _heap_alignment == 0, "max_heap_byte_size alignment"); +} +#endif // ASSERT + +void CollectorPolicy::initialize_flags() { + assert(_space_alignment != 0, "Space alignment not set up properly"); + assert(_heap_alignment != 0, "Heap alignment not set up properly"); + assert(_heap_alignment >= _space_alignment, + err_msg("heap_alignment: " SIZE_FORMAT " less than space_alignment: " SIZE_FORMAT, + _heap_alignment, _space_alignment)); + assert(_heap_alignment % _space_alignment == 0, + err_msg("heap_alignment: " SIZE_FORMAT " not aligned by space_alignment: " SIZE_FORMAT, + _heap_alignment, _space_alignment)); + + if (FLAG_IS_CMDLINE(MaxHeapSize)) { + if (FLAG_IS_CMDLINE(InitialHeapSize) && InitialHeapSize > MaxHeapSize) { + vm_exit_during_initialization("Initial heap size set to a larger value than the maximum heap size"); + } + if (_min_heap_byte_size != 0 && MaxHeapSize < _min_heap_byte_size) { + vm_exit_during_initialization("Incompatible minimum and maximum heap sizes specified"); + } + _max_heap_size_cmdline = true; + } // Check heap parameter properties - if (_initial_heap_byte_size < M) { + if (InitialHeapSize < M) { vm_exit_during_initialization("Too small initial heap"); } - // Check heap parameter properties if (_min_heap_byte_size < M) { vm_exit_during_initialization("Too small minimum heap"); } - if (_initial_heap_byte_size <= NewSize) { - // make sure there is at least some room in old space - vm_exit_during_initialization("Too small initial heap for new size specified"); + + // User inputs from -Xmx and -Xms must be aligned + _min_heap_byte_size = align_size_up(_min_heap_byte_size, _heap_alignment); + uintx aligned_initial_heap_size = align_size_up(InitialHeapSize, _heap_alignment); + uintx aligned_max_heap_size = align_size_up(MaxHeapSize, _heap_alignment); + + // Write back to flags if the values changed + if (aligned_initial_heap_size != InitialHeapSize) { + FLAG_SET_ERGO(uintx, InitialHeapSize, aligned_initial_heap_size); } - if (_max_heap_byte_size < _min_heap_byte_size) { - vm_exit_during_initialization("Incompatible minimum and maximum heap sizes specified"); - } - if (_initial_heap_byte_size < _min_heap_byte_size) { - vm_exit_during_initialization("Incompatible minimum and initial heap sizes specified"); - } - if (_max_heap_byte_size < _initial_heap_byte_size) { - vm_exit_during_initialization("Incompatible initial and maximum heap sizes specified"); + if (aligned_max_heap_size != MaxHeapSize) { + FLAG_SET_ERGO(uintx, MaxHeapSize, aligned_max_heap_size); } + if (FLAG_IS_CMDLINE(InitialHeapSize) && _min_heap_byte_size != 0 && + InitialHeapSize < _min_heap_byte_size) { + vm_exit_during_initialization("Incompatible minimum and initial heap sizes specified"); + } + if (!FLAG_IS_DEFAULT(InitialHeapSize) && InitialHeapSize > MaxHeapSize) { + FLAG_SET_ERGO(uintx, MaxHeapSize, InitialHeapSize); + } else if (!FLAG_IS_DEFAULT(MaxHeapSize) && InitialHeapSize > MaxHeapSize) { + FLAG_SET_ERGO(uintx, InitialHeapSize, MaxHeapSize); + if (InitialHeapSize < _min_heap_byte_size) { + _min_heap_byte_size = InitialHeapSize; + } + } + + _initial_heap_byte_size = InitialHeapSize; + _max_heap_byte_size = MaxHeapSize; + + FLAG_SET_ERGO(uintx, MinHeapDeltaBytes, align_size_up(MinHeapDeltaBytes, _space_alignment)); + + DEBUG_ONLY(CollectorPolicy::assert_flags();) +} + +void CollectorPolicy::initialize_size_info() { if (PrintGCDetails && Verbose) { gclog_or_tty->print_cr("Minimum heap " SIZE_FORMAT " Initial heap " SIZE_FORMAT " Maximum heap " SIZE_FORMAT, _min_heap_byte_size, _initial_heap_byte_size, _max_heap_byte_size); } + + DEBUG_ONLY(CollectorPolicy::assert_size_info();) } bool CollectorPolicy::use_should_clear_all_soft_refs(bool v) { @@ -105,7 +158,6 @@ bool CollectorPolicy::use_should_clear_all_soft_refs(bool v) { GenRemSet* CollectorPolicy::create_rem_set(MemRegion whole_heap, int max_covered_regions) { - assert(rem_set_name() == GenRemSet::CardTable, "unrecognized GenRemSet::Name"); return new CardTableRS(whole_heap, max_covered_regions); } @@ -119,7 +171,7 @@ void CollectorPolicy::cleared_all_soft_refs() { _all_soft_refs_clear = true; } -size_t CollectorPolicy::compute_max_alignment() { +size_t CollectorPolicy::compute_heap_alignment() { // The card marking array and the offset arrays for old generations are // committed in os pages as well. Make sure they are entirely full (to // avoid partial page problems), e.g. if 512 bytes heap corresponds to 1 @@ -146,18 +198,21 @@ size_t CollectorPolicy::compute_max_alignment() { // GenCollectorPolicy methods. +GenCollectorPolicy::GenCollectorPolicy() : + _min_gen0_size(0), + _initial_gen0_size(0), + _max_gen0_size(0), + _gen_alignment(0), + _generations(NULL) +{} + size_t GenCollectorPolicy::scale_by_NewRatio_aligned(size_t base_size) { - size_t x = base_size / (NewRatio+1); - size_t new_gen_size = x > _min_alignment ? - align_size_down(x, _min_alignment) : - _min_alignment; - return new_gen_size; + return align_size_down_bounded(base_size / (NewRatio + 1), _gen_alignment); } size_t GenCollectorPolicy::bound_minus_alignment(size_t desired_size, size_t maximum_size) { - size_t alignment = _min_alignment; - size_t max_minus = maximum_size - alignment; + size_t max_minus = maximum_size - _gen_alignment; return desired_size < max_minus ? desired_size : max_minus; } @@ -165,7 +220,7 @@ size_t GenCollectorPolicy::bound_minus_alignment(size_t desired_size, void GenCollectorPolicy::initialize_size_policy(size_t init_eden_size, size_t init_promo_size, size_t init_survivor_size) { - const double max_gc_pause_sec = ((double) MaxGCPauseMillis)/1000.0; + const double max_gc_pause_sec = ((double) MaxGCPauseMillis) / 1000.0; _size_policy = new AdaptiveSizePolicy(init_eden_size, init_promo_size, init_survivor_size, @@ -173,100 +228,181 @@ void GenCollectorPolicy::initialize_size_policy(size_t init_eden_size, GCTimeRatio); } -void GenCollectorPolicy::initialize_flags() { - // All sizes must be multiples of the generation granularity. - _min_alignment = (uintx) Generation::GenGrain; - _max_alignment = compute_max_alignment(); +size_t GenCollectorPolicy::young_gen_size_lower_bound() { + // The young generation must be aligned and have room for eden + two survivors + return align_size_up(3 * _space_alignment, _gen_alignment); +} +#ifdef ASSERT +void GenCollectorPolicy::assert_flags() { + CollectorPolicy::assert_flags(); + assert(NewSize >= _min_gen0_size, "Ergonomics decided on a too small young gen size"); + assert(NewSize <= MaxNewSize, "Ergonomics decided on incompatible initial and maximum young gen sizes"); + assert(FLAG_IS_DEFAULT(MaxNewSize) || MaxNewSize < MaxHeapSize, "Ergonomics decided on incompatible maximum young gen and heap sizes"); + assert(NewSize % _gen_alignment == 0, "NewSize alignment"); + assert(FLAG_IS_DEFAULT(MaxNewSize) || MaxNewSize % _gen_alignment == 0, "MaxNewSize alignment"); +} + +void TwoGenerationCollectorPolicy::assert_flags() { + GenCollectorPolicy::assert_flags(); + assert(OldSize + NewSize <= MaxHeapSize, "Ergonomics decided on incompatible generation and heap sizes"); + assert(OldSize % _gen_alignment == 0, "OldSize alignment"); +} + +void GenCollectorPolicy::assert_size_info() { + CollectorPolicy::assert_size_info(); + // GenCollectorPolicy::initialize_size_info may update the MaxNewSize + assert(MaxNewSize < MaxHeapSize, "Ergonomics decided on incompatible maximum young and heap sizes"); + assert(NewSize == _initial_gen0_size, "Discrepancy between NewSize flag and local storage"); + assert(MaxNewSize == _max_gen0_size, "Discrepancy between MaxNewSize flag and local storage"); + assert(_min_gen0_size <= _initial_gen0_size, "Ergonomics decided on incompatible minimum and initial young gen sizes"); + assert(_initial_gen0_size <= _max_gen0_size, "Ergonomics decided on incompatible initial and maximum young gen sizes"); + assert(_min_gen0_size % _gen_alignment == 0, "_min_gen0_size alignment"); + assert(_initial_gen0_size % _gen_alignment == 0, "_initial_gen0_size alignment"); + assert(_max_gen0_size % _gen_alignment == 0, "_max_gen0_size alignment"); +} + +void TwoGenerationCollectorPolicy::assert_size_info() { + GenCollectorPolicy::assert_size_info(); + assert(OldSize == _initial_gen1_size, "Discrepancy between OldSize flag and local storage"); + assert(_min_gen1_size <= _initial_gen1_size, "Ergonomics decided on incompatible minimum and initial old gen sizes"); + assert(_initial_gen1_size <= _max_gen1_size, "Ergonomics decided on incompatible initial and maximum old gen sizes"); + assert(_max_gen1_size % _gen_alignment == 0, "_max_gen1_size alignment"); + assert(_initial_gen1_size % _gen_alignment == 0, "_initial_gen1_size alignment"); + assert(_max_heap_byte_size <= (_max_gen0_size + _max_gen1_size), "Total maximum heap sizes must be sum of generation maximum sizes"); +} +#endif // ASSERT + +void GenCollectorPolicy::initialize_flags() { CollectorPolicy::initialize_flags(); - // All generational heaps have a youngest gen; handle those flags here. + assert(_gen_alignment != 0, "Generation alignment not set up properly"); + assert(_heap_alignment >= _gen_alignment, + err_msg("heap_alignment: " SIZE_FORMAT " less than gen_alignment: " SIZE_FORMAT, + _heap_alignment, _gen_alignment)); + assert(_gen_alignment % _space_alignment == 0, + err_msg("gen_alignment: " SIZE_FORMAT " not aligned by space_alignment: " SIZE_FORMAT, + _gen_alignment, _space_alignment)); + assert(_heap_alignment % _gen_alignment == 0, + err_msg("heap_alignment: " SIZE_FORMAT " not aligned by gen_alignment: " SIZE_FORMAT, + _heap_alignment, _gen_alignment)); + + // All generational heaps have a youngest gen; handle those flags here + + // Make sure the heap is large enough for two generations + uintx smallest_new_size = young_gen_size_lower_bound(); + uintx smallest_heap_size = align_size_up(smallest_new_size + align_size_up(_space_alignment, _gen_alignment), + _heap_alignment); + if (MaxHeapSize < smallest_heap_size) { + FLAG_SET_ERGO(uintx, MaxHeapSize, smallest_heap_size); + _max_heap_byte_size = MaxHeapSize; + } + // If needed, synchronize _min_heap_byte size and _initial_heap_byte_size + if (_min_heap_byte_size < smallest_heap_size) { + _min_heap_byte_size = smallest_heap_size; + if (InitialHeapSize < _min_heap_byte_size) { + FLAG_SET_ERGO(uintx, InitialHeapSize, smallest_heap_size); + _initial_heap_byte_size = smallest_heap_size; + } + } + + // Now take the actual NewSize into account. We will silently increase NewSize + // if the user specified a smaller value. + smallest_new_size = MAX2(smallest_new_size, (uintx)align_size_down(NewSize, _gen_alignment)); + if (smallest_new_size != NewSize) { + FLAG_SET_ERGO(uintx, NewSize, smallest_new_size); + } + _initial_gen0_size = NewSize; + + if (!FLAG_IS_DEFAULT(MaxNewSize)) { + uintx min_new_size = MAX2(_gen_alignment, _min_gen0_size); + + if (MaxNewSize >= MaxHeapSize) { + // Make sure there is room for an old generation + uintx smaller_max_new_size = MaxHeapSize - _gen_alignment; + if (FLAG_IS_CMDLINE(MaxNewSize)) { + warning("MaxNewSize (" SIZE_FORMAT "k) is equal to or greater than the entire " + "heap (" SIZE_FORMAT "k). A new max generation size of " SIZE_FORMAT "k will be used.", + MaxNewSize/K, MaxHeapSize/K, smaller_max_new_size/K); + } + FLAG_SET_ERGO(uintx, MaxNewSize, smaller_max_new_size); + if (NewSize > MaxNewSize) { + FLAG_SET_ERGO(uintx, NewSize, MaxNewSize); + _initial_gen0_size = NewSize; + } + } else if (MaxNewSize < min_new_size) { + FLAG_SET_ERGO(uintx, MaxNewSize, min_new_size); + } else if (!is_size_aligned(MaxNewSize, _gen_alignment)) { + FLAG_SET_ERGO(uintx, MaxNewSize, align_size_down(MaxNewSize, _gen_alignment)); + } + _max_gen0_size = MaxNewSize; + } - // Adjust max size parameters if (NewSize > MaxNewSize) { - MaxNewSize = NewSize; + // At this point this should only happen if the user specifies a large NewSize and/or + // a small (but not too small) MaxNewSize. + if (FLAG_IS_CMDLINE(MaxNewSize)) { + warning("NewSize (" SIZE_FORMAT "k) is greater than the MaxNewSize (" SIZE_FORMAT "k). " + "A new max generation size of " SIZE_FORMAT "k will be used.", + NewSize/K, MaxNewSize/K, NewSize/K); + } + FLAG_SET_ERGO(uintx, MaxNewSize, NewSize); + _max_gen0_size = MaxNewSize; } - NewSize = align_size_down(NewSize, _min_alignment); - MaxNewSize = align_size_down(MaxNewSize, _min_alignment); - // Check validity of heap flags - assert(NewSize % _min_alignment == 0, "eden space alignment"); - assert(MaxNewSize % _min_alignment == 0, "survivor space alignment"); - - if (NewSize < 3 * _min_alignment) { - // make sure there room for eden and two survivor spaces - vm_exit_during_initialization("Too small new size specified"); - } if (SurvivorRatio < 1 || NewRatio < 1) { vm_exit_during_initialization("Invalid young gen ratio specified"); } + + DEBUG_ONLY(GenCollectorPolicy::assert_flags();) } void TwoGenerationCollectorPolicy::initialize_flags() { GenCollectorPolicy::initialize_flags(); - OldSize = align_size_down(OldSize, _min_alignment); + if (!is_size_aligned(OldSize, _gen_alignment)) { + FLAG_SET_ERGO(uintx, OldSize, align_size_down(OldSize, _gen_alignment)); + } - if (FLAG_IS_CMDLINE(OldSize) && FLAG_IS_DEFAULT(NewSize)) { + if (FLAG_IS_CMDLINE(OldSize) && FLAG_IS_DEFAULT(MaxHeapSize)) { // NewRatio will be used later to set the young generation size so we use // it to calculate how big the heap should be based on the requested OldSize // and NewRatio. assert(NewRatio > 0, "NewRatio should have been set up earlier"); size_t calculated_heapsize = (OldSize / NewRatio) * (NewRatio + 1); - calculated_heapsize = align_size_up(calculated_heapsize, _max_alignment); - MaxHeapSize = calculated_heapsize; - InitialHeapSize = calculated_heapsize; + calculated_heapsize = align_size_up(calculated_heapsize, _heap_alignment); + FLAG_SET_ERGO(uintx, MaxHeapSize, calculated_heapsize); + _max_heap_byte_size = MaxHeapSize; + FLAG_SET_ERGO(uintx, InitialHeapSize, calculated_heapsize); + _initial_heap_byte_size = InitialHeapSize; } - MaxHeapSize = align_size_up(MaxHeapSize, _max_alignment); // adjust max heap size if necessary if (NewSize + OldSize > MaxHeapSize) { - if (FLAG_IS_CMDLINE(MaxHeapSize)) { + if (_max_heap_size_cmdline) { // somebody set a maximum heap size with the intention that we should not // exceed it. Adjust New/OldSize as necessary. uintx calculated_size = NewSize + OldSize; double shrink_factor = (double) MaxHeapSize / calculated_size; - // align - NewSize = align_size_down((uintx) (NewSize * shrink_factor), _min_alignment); - // OldSize is already aligned because above we aligned MaxHeapSize to - // _max_alignment, and we just made sure that NewSize is aligned to - // _min_alignment. In initialize_flags() we verified that _max_alignment - // is a multiple of _min_alignment. - OldSize = MaxHeapSize - NewSize; - } else { - MaxHeapSize = NewSize + OldSize; - } - } - // need to do this again - MaxHeapSize = align_size_up(MaxHeapSize, _max_alignment); + uintx smaller_new_size = align_size_down((uintx)(NewSize * shrink_factor), _gen_alignment); + FLAG_SET_ERGO(uintx, NewSize, MAX2(young_gen_size_lower_bound(), smaller_new_size)); + _initial_gen0_size = NewSize; - // adjust max heap size if necessary - if (NewSize + OldSize > MaxHeapSize) { - if (FLAG_IS_CMDLINE(MaxHeapSize)) { - // somebody set a maximum heap size with the intention that we should not - // exceed it. Adjust New/OldSize as necessary. - uintx calculated_size = NewSize + OldSize; - double shrink_factor = (double) MaxHeapSize / calculated_size; - // align - NewSize = align_size_down((uintx) (NewSize * shrink_factor), _min_alignment); // OldSize is already aligned because above we aligned MaxHeapSize to - // _max_alignment, and we just made sure that NewSize is aligned to - // _min_alignment. In initialize_flags() we verified that _max_alignment - // is a multiple of _min_alignment. - OldSize = MaxHeapSize - NewSize; + // _heap_alignment, and we just made sure that NewSize is aligned to + // _gen_alignment. In initialize_flags() we verified that _heap_alignment + // is a multiple of _gen_alignment. + FLAG_SET_ERGO(uintx, OldSize, MaxHeapSize - NewSize); } else { - MaxHeapSize = NewSize + OldSize; + FLAG_SET_ERGO(uintx, MaxHeapSize, align_size_up(NewSize + OldSize, _heap_alignment)); + _max_heap_byte_size = MaxHeapSize; } } - // need to do this again - MaxHeapSize = align_size_up(MaxHeapSize, _max_alignment); always_do_update_barrier = UseConcMarkSweepGC; - // Check validity of heap flags - assert(OldSize % _min_alignment == 0, "old space alignment"); - assert(MaxHeapSize % _max_alignment == 0, "maximum heap alignment"); + DEBUG_ONLY(TwoGenerationCollectorPolicy::assert_flags();) } // Values set on the command line win over any ergonomically @@ -281,7 +417,7 @@ void TwoGenerationCollectorPolicy::initialize_flags() { void GenCollectorPolicy::initialize_size_info() { CollectorPolicy::initialize_size_info(); - // _min_alignment is used for alignment within a generation. + // _space_alignment is used for alignment within a generation. // There is additional alignment done down stream for some // collectors that sometimes causes unwanted rounding up of // generations sizes. @@ -289,35 +425,8 @@ void GenCollectorPolicy::initialize_size_info() { // Determine maximum size of gen0 size_t max_new_size = 0; - if (FLAG_IS_CMDLINE(MaxNewSize) || FLAG_IS_ERGO(MaxNewSize)) { - if (MaxNewSize < _min_alignment) { - max_new_size = _min_alignment; - } - if (MaxNewSize >= _max_heap_byte_size) { - max_new_size = align_size_down(_max_heap_byte_size - _min_alignment, - _min_alignment); - warning("MaxNewSize (" SIZE_FORMAT "k) is equal to or " - "greater than the entire heap (" SIZE_FORMAT "k). A " - "new generation size of " SIZE_FORMAT "k will be used.", - MaxNewSize/K, _max_heap_byte_size/K, max_new_size/K); - } else { - max_new_size = align_size_down(MaxNewSize, _min_alignment); - } - - // The case for FLAG_IS_ERGO(MaxNewSize) could be treated - // specially at this point to just use an ergonomically set - // MaxNewSize to set max_new_size. For cases with small - // heaps such a policy often did not work because the MaxNewSize - // was larger than the entire heap. The interpretation given - // to ergonomically set flags is that the flags are set - // by different collectors for their own special needs but - // are not allowed to badly shape the heap. This allows the - // different collectors to decide what's best for themselves - // without having to factor in the overall heap shape. It - // can be the case in the future that the collectors would - // only make "wise" ergonomics choices and this policy could - // just accept those choices. The choices currently made are - // not always "wise". + if (!FLAG_IS_DEFAULT(MaxNewSize)) { + max_new_size = MaxNewSize; } else { max_new_size = scale_by_NewRatio_aligned(_max_heap_byte_size); // Bound the maximum size by NewSize below (since it historically @@ -386,11 +495,22 @@ void GenCollectorPolicy::initialize_size_info() { _min_gen0_size = MIN2(_min_gen0_size, _initial_gen0_size); } + // Write back to flags if necessary + if (NewSize != _initial_gen0_size) { + FLAG_SET_ERGO(uintx, NewSize, _initial_gen0_size); + } + + if (MaxNewSize != _max_gen0_size) { + FLAG_SET_ERGO(uintx, MaxNewSize, _max_gen0_size); + } + if (PrintGCDetails && Verbose) { gclog_or_tty->print_cr("1: Minimum gen0 " SIZE_FORMAT " Initial gen0 " SIZE_FORMAT " Maximum gen0 " SIZE_FORMAT, _min_gen0_size, _initial_gen0_size, _max_gen0_size); } + + DEBUG_ONLY(GenCollectorPolicy::assert_size_info();) } // Call this method during the sizing of the gen1 to make @@ -403,23 +523,18 @@ void GenCollectorPolicy::initialize_size_info() { // keeping it simple also seems a worthwhile goal. bool TwoGenerationCollectorPolicy::adjust_gen0_sizes(size_t* gen0_size_ptr, size_t* gen1_size_ptr, - const size_t heap_size, - const size_t min_gen1_size) { + const size_t heap_size) { bool result = false; - if ((*gen1_size_ptr + *gen0_size_ptr) > heap_size) { - if ((heap_size < (*gen0_size_ptr + min_gen1_size)) && - (heap_size >= min_gen1_size + _min_alignment)) { - // Adjust gen0 down to accommodate min_gen1_size - *gen0_size_ptr = heap_size - min_gen1_size; - *gen0_size_ptr = - MAX2((uintx)align_size_down(*gen0_size_ptr, _min_alignment), _min_alignment); - assert(*gen0_size_ptr > 0, "Min gen0 is too large"); + if ((*gen0_size_ptr + *gen1_size_ptr) > heap_size) { + uintx smallest_new_size = young_gen_size_lower_bound(); + if ((heap_size < (*gen0_size_ptr + _min_gen1_size)) && + (heap_size >= _min_gen1_size + smallest_new_size)) { + // Adjust gen0 down to accommodate _min_gen1_size + *gen0_size_ptr = align_size_down_bounded(heap_size - _min_gen1_size, _gen_alignment); result = true; } else { - *gen1_size_ptr = heap_size - *gen0_size_ptr; - *gen1_size_ptr = - MAX2((uintx)align_size_down(*gen1_size_ptr, _min_alignment), _min_alignment); + *gen1_size_ptr = align_size_down_bounded(heap_size - *gen0_size_ptr, _gen_alignment); } } return result; @@ -440,41 +555,36 @@ void TwoGenerationCollectorPolicy::initialize_size_info() { // The maximum gen1 size can be determined from the maximum gen0 // and maximum heap size since no explicit flags exits // for setting the gen1 maximum. - _max_gen1_size = _max_heap_byte_size - _max_gen0_size; - _max_gen1_size = - MAX2((uintx)align_size_down(_max_gen1_size, _min_alignment), _min_alignment); + _max_gen1_size = MAX2(_max_heap_byte_size - _max_gen0_size, _gen_alignment); + // If no explicit command line flag has been set for the // gen1 size, use what is left for gen1. - if (FLAG_IS_DEFAULT(OldSize) || FLAG_IS_ERGO(OldSize)) { - // The user has not specified any value or ergonomics - // has chosen a value (which may or may not be consistent + if (!FLAG_IS_CMDLINE(OldSize)) { + // The user has not specified any value but the ergonomics + // may have chosen a value (which may or may not be consistent // with the overall heap size). In either case make // the minimum, maximum and initial sizes consistent // with the gen0 sizes and the overall heap sizes. - assert(_min_heap_byte_size > _min_gen0_size, - "gen0 has an unexpected minimum size"); - _min_gen1_size = _min_heap_byte_size - _min_gen0_size; - _min_gen1_size = - MAX2((uintx)align_size_down(_min_gen1_size, _min_alignment), _min_alignment); - _initial_gen1_size = _initial_heap_byte_size - _initial_gen0_size; - _initial_gen1_size = - MAX2((uintx)align_size_down(_initial_gen1_size, _min_alignment), _min_alignment); + _min_gen1_size = MAX2(_min_heap_byte_size - _min_gen0_size, _gen_alignment); + _initial_gen1_size = MAX2(_initial_heap_byte_size - _initial_gen0_size, _gen_alignment); + // _max_gen1_size has already been made consistent above + FLAG_SET_ERGO(uintx, OldSize, _initial_gen1_size); } else { // It's been explicitly set on the command line. Use the // OldSize and then determine the consequences. - _min_gen1_size = OldSize; + _min_gen1_size = MIN2(OldSize, _min_heap_byte_size - _min_gen0_size); _initial_gen1_size = OldSize; // If the user has explicitly set an OldSize that is inconsistent // with other command line flags, issue a warning. // The generation minimums and the overall heap mimimum should - // be within one heap alignment. - if ((_min_gen1_size + _min_gen0_size + _min_alignment) < _min_heap_byte_size) { + // be within one generation alignment. + if ((_min_gen1_size + _min_gen0_size + _gen_alignment) < _min_heap_byte_size) { warning("Inconsistency between minimum heap size and minimum " "generation sizes: using minimum heap = " SIZE_FORMAT, _min_heap_byte_size); } - if ((OldSize > _max_gen1_size)) { + if (OldSize > _max_gen1_size) { warning("Inconsistency between maximum heap size and maximum " "generation sizes: using maximum heap = " SIZE_FORMAT " -XX:OldSize flag is being ignored", @@ -482,8 +592,7 @@ void TwoGenerationCollectorPolicy::initialize_size_info() { } // If there is an inconsistency between the OldSize and the minimum and/or // initial size of gen0, since OldSize was explicitly set, OldSize wins. - if (adjust_gen0_sizes(&_min_gen0_size, &_min_gen1_size, - _min_heap_byte_size, OldSize)) { + if (adjust_gen0_sizes(&_min_gen0_size, &_min_gen1_size, _min_heap_byte_size)) { if (PrintGCDetails && Verbose) { gclog_or_tty->print_cr("2: Minimum gen0 " SIZE_FORMAT " Initial gen0 " SIZE_FORMAT " Maximum gen0 " SIZE_FORMAT, @@ -492,7 +601,7 @@ void TwoGenerationCollectorPolicy::initialize_size_info() { } // Initial size if (adjust_gen0_sizes(&_initial_gen0_size, &_initial_gen1_size, - _initial_heap_byte_size, OldSize)) { + _initial_heap_byte_size)) { if (PrintGCDetails && Verbose) { gclog_or_tty->print_cr("3: Minimum gen0 " SIZE_FORMAT " Initial gen0 " SIZE_FORMAT " Maximum gen0 " SIZE_FORMAT, @@ -507,11 +616,26 @@ void TwoGenerationCollectorPolicy::initialize_size_info() { _initial_gen1_size = MAX2(_initial_gen1_size, _min_gen1_size); _initial_gen1_size = MIN2(_initial_gen1_size, _max_gen1_size); + // Write back to flags if necessary + if (NewSize != _initial_gen0_size) { + FLAG_SET_ERGO(uintx, NewSize, _initial_gen0_size); + } + + if (MaxNewSize != _max_gen0_size) { + FLAG_SET_ERGO(uintx, MaxNewSize, _max_gen0_size); + } + + if (OldSize != _initial_gen1_size) { + FLAG_SET_ERGO(uintx, OldSize, _initial_gen1_size); + } + if (PrintGCDetails && Verbose) { gclog_or_tty->print_cr("Minimum gen1 " SIZE_FORMAT " Initial gen1 " SIZE_FORMAT " Maximum gen1 " SIZE_FORMAT, _min_gen1_size, _initial_gen1_size, _max_gen1_size); } + + DEBUG_ONLY(TwoGenerationCollectorPolicy::assert_size_info();) } HeapWord* GenCollectorPolicy::mem_allocate_work(size_t size, @@ -605,9 +729,7 @@ HeapWord* GenCollectorPolicy::mem_allocate_work(size_t size, gc_count_before = Universe::heap()->total_collections(); } - VM_GenCollectForAllocation op(size, - is_tlab, - gc_count_before); + VM_GenCollectForAllocation op(size, is_tlab, gc_count_before); VMThread::execute(&op); if (op.prologue_succeeded()) { result = op.result(); @@ -836,14 +958,16 @@ bool GenCollectorPolicy::should_try_older_generation_allocation( // MarkSweepPolicy methods // -MarkSweepPolicy::MarkSweepPolicy() { - initialize_all(); +void MarkSweepPolicy::initialize_alignments() { + _space_alignment = _gen_alignment = (uintx)Generation::GenGrain; + _heap_alignment = compute_heap_alignment(); } void MarkSweepPolicy::initialize_generations() { _generations = NEW_C_HEAP_ARRAY3(GenerationSpecPtr, number_of_generations(), mtGC, 0, AllocFailStrategy::RETURN_NULL); - if (_generations == NULL) + if (_generations == NULL) { vm_exit_during_initialization("Unable to allocate gen spec"); + } if (UseParNewGC) { _generations[0] = new GenerationSpec(Generation::ParNew, _initial_gen0_size, _max_gen0_size); @@ -852,8 +976,9 @@ void MarkSweepPolicy::initialize_generations() { } _generations[1] = new GenerationSpec(Generation::MarkSweepCompact, _initial_gen1_size, _max_gen1_size); - if (_generations[0] == NULL || _generations[1] == NULL) + if (_generations[0] == NULL || _generations[1] == NULL) { vm_exit_during_initialization("Unable to allocate gen spec"); + } } void MarkSweepPolicy::initialize_gc_policy_counters() { diff --git a/hotspot/src/share/vm/memory/collectorPolicy.hpp b/hotspot/src/share/vm/memory/collectorPolicy.hpp index 42976b34563..b72030113c4 100644 --- a/hotspot/src/share/vm/memory/collectorPolicy.hpp +++ b/hotspot/src/share/vm/memory/collectorPolicy.hpp @@ -61,17 +61,23 @@ class CollectorPolicy : public CHeapObj { protected: GCPolicyCounters* _gc_policy_counters; - // Requires that the concrete subclass sets the alignment constraints - // before calling. + virtual void initialize_alignments() = 0; virtual void initialize_flags(); virtual void initialize_size_info(); + DEBUG_ONLY(virtual void assert_flags();) + DEBUG_ONLY(virtual void assert_size_info();) + size_t _initial_heap_byte_size; size_t _max_heap_byte_size; size_t _min_heap_byte_size; - size_t _min_alignment; - size_t _max_alignment; + size_t _space_alignment; + size_t _heap_alignment; + + // Needed to keep information if MaxHeapSize was set on the command line + // when the flag value is aligned etc by ergonomics + bool _max_heap_size_cmdline; // The sizing of the heap are controlled by a sizing policy. AdaptiveSizePolicy* _size_policy; @@ -79,6 +85,7 @@ class CollectorPolicy : public CHeapObj { // Set to true when policy wants soft refs cleared. // Reset to false by gc after it clears all soft refs. bool _should_clear_all_soft_refs; + // Set to true by the GC if the just-completed gc cleared all // softrefs. This is set to true whenever a gc clears all softrefs, and // set to false each time gc returns to the mutator. For example, in the @@ -86,23 +93,20 @@ class CollectorPolicy : public CHeapObj { // mem_allocate() where it returns op.result() bool _all_soft_refs_clear; - CollectorPolicy() : - _min_alignment(1), - _max_alignment(1), - _initial_heap_byte_size(0), - _max_heap_byte_size(0), - _min_heap_byte_size(0), - _size_policy(NULL), - _should_clear_all_soft_refs(false), - _all_soft_refs_clear(false) - {} + CollectorPolicy(); public: - // Return maximum heap alignment that may be imposed by the policy - static size_t compute_max_alignment(); + virtual void initialize_all() { + initialize_alignments(); + initialize_flags(); + initialize_size_info(); + } - size_t min_alignment() { return _min_alignment; } - size_t max_alignment() { return _max_alignment; } + // Return maximum heap alignment that may be imposed by the policy + static size_t compute_heap_alignment(); + + size_t space_alignment() { return _space_alignment; } + size_t heap_alignment() { return _heap_alignment; } size_t initial_heap_byte_size() { return _initial_heap_byte_size; } size_t max_heap_byte_size() { return _max_heap_byte_size; } @@ -151,7 +155,6 @@ class CollectorPolicy : public CHeapObj { virtual BarrierSet::Name barrier_set_name() = 0; - virtual GenRemSet::Name rem_set_name() = 0; // Create the remembered set (to cover the given reserved region, // allowing breaking up into at most "max_covered_regions"). @@ -195,6 +198,9 @@ class CollectorPolicy : public CHeapObj { return false; } + // Do any updates required to global flags that are due to heap initialization + // changes + virtual void post_heap_initialize() = 0; }; class ClearedAllSoftRefs : public StackObj { @@ -219,6 +225,10 @@ class GenCollectorPolicy : public CollectorPolicy { size_t _initial_gen0_size; size_t _max_gen0_size; + // _gen_alignment and _space_alignment will have the same value most of the + // time. When using large pages they can differ. + size_t _gen_alignment; + GenerationSpec **_generations; // Return true if an allocation should be attempted in the older @@ -229,41 +239,50 @@ class GenCollectorPolicy : public CollectorPolicy { void initialize_flags(); void initialize_size_info(); + DEBUG_ONLY(void assert_flags();) + DEBUG_ONLY(void assert_size_info();) + // Try to allocate space by expanding the heap. virtual HeapWord* expand_heap_and_allocate(size_t size, bool is_tlab); - // Scale the base_size by NewRation according to + // Compute max heap alignment + size_t compute_max_alignment(); + + // Scale the base_size by NewRatio according to // result = base_size / (NewRatio + 1) // and align by min_alignment() size_t scale_by_NewRatio_aligned(size_t base_size); - // Bound the value by the given maximum minus the - // min_alignment. + // Bound the value by the given maximum minus the min_alignment size_t bound_minus_alignment(size_t desired_size, size_t maximum_size); public: + GenCollectorPolicy(); + // Accessors size_t min_gen0_size() { return _min_gen0_size; } size_t initial_gen0_size() { return _initial_gen0_size; } size_t max_gen0_size() { return _max_gen0_size; } + size_t gen_alignment() { return _gen_alignment; } virtual int number_of_generations() = 0; - virtual GenerationSpec **generations() { + virtual GenerationSpec **generations() { assert(_generations != NULL, "Sanity check"); return _generations; } virtual GenCollectorPolicy* as_generation_policy() { return this; } - virtual void initialize_generations() = 0; + virtual void initialize_generations() { }; virtual void initialize_all() { - initialize_flags(); - initialize_size_info(); + CollectorPolicy::initialize_all(); initialize_generations(); } + size_t young_gen_size_lower_bound(); + HeapWord* mem_allocate_work(size_t size, bool is_tlab, bool* gc_overhead_limit_was_exceeded); @@ -274,6 +293,10 @@ class GenCollectorPolicy : public CollectorPolicy { virtual void initialize_size_policy(size_t init_eden_size, size_t init_promo_size, size_t init_survivor_size); + + virtual void post_heap_initialize() { + assert(_max_gen0_size == MaxNewSize, "Should be taken care of by initialize_size_info"); + } }; // All of hotspot's current collectors are subtypes of this @@ -290,9 +313,14 @@ class TwoGenerationCollectorPolicy : public GenCollectorPolicy { void initialize_flags(); void initialize_size_info(); - void initialize_generations() { ShouldNotReachHere(); } + + DEBUG_ONLY(void assert_flags();) + DEBUG_ONLY(void assert_size_info();) public: + TwoGenerationCollectorPolicy() : GenCollectorPolicy(), _min_gen1_size(0), + _initial_gen1_size(0), _max_gen1_size(0) {} + // Accessors size_t min_gen1_size() { return _min_gen1_size; } size_t initial_gen1_size() { return _initial_gen1_size; } @@ -301,25 +329,25 @@ class TwoGenerationCollectorPolicy : public GenCollectorPolicy { // Inherited methods TwoGenerationCollectorPolicy* as_two_generation_policy() { return this; } - int number_of_generations() { return 2; } - BarrierSet::Name barrier_set_name() { return BarrierSet::CardTableModRef; } - GenRemSet::Name rem_set_name() { return GenRemSet::CardTable; } + int number_of_generations() { return 2; } + BarrierSet::Name barrier_set_name() { return BarrierSet::CardTableModRef; } virtual CollectorPolicy::Name kind() { return CollectorPolicy::TwoGenerationCollectorPolicyKind; } - // Returns true is gen0 sizes were adjusted + // Returns true if gen0 sizes were adjusted bool adjust_gen0_sizes(size_t* gen0_size_ptr, size_t* gen1_size_ptr, - const size_t heap_size, const size_t min_gen1_size); + const size_t heap_size); }; class MarkSweepPolicy : public TwoGenerationCollectorPolicy { protected: + void initialize_alignments(); void initialize_generations(); public: - MarkSweepPolicy(); + MarkSweepPolicy() {} MarkSweepPolicy* as_mark_sweep_policy() { return this; } diff --git a/hotspot/src/share/vm/memory/defNewGeneration.cpp b/hotspot/src/share/vm/memory/defNewGeneration.cpp index 0b4af29a3e3..ca3ff46b167 100644 --- a/hotspot/src/share/vm/memory/defNewGeneration.cpp +++ b/hotspot/src/share/vm/memory/defNewGeneration.cpp @@ -204,7 +204,7 @@ DefNewGeneration::DefNewGeneration(ReservedSpace rs, // Compute the maximum eden and survivor space sizes. These sizes // are computed assuming the entire reserved space is committed. // These values are exported as performance counters. - uintx alignment = GenCollectedHeap::heap()->collector_policy()->min_alignment(); + uintx alignment = GenCollectedHeap::heap()->collector_policy()->space_alignment(); uintx size = _virtual_space.reserved_size(); _max_survivor_size = compute_survivor_size(size, alignment); _max_eden_size = size - (2*_max_survivor_size); @@ -235,7 +235,7 @@ void DefNewGeneration::compute_space_boundaries(uintx minimum_eden_size, bool clear_space, bool mangle_space) { uintx alignment = - GenCollectedHeap::heap()->collector_policy()->min_alignment(); + GenCollectedHeap::heap()->collector_policy()->space_alignment(); // If the spaces are being cleared (only done at heap initialization // currently), the survivor spaces need not be empty. @@ -473,7 +473,7 @@ size_t DefNewGeneration::free() const { } size_t DefNewGeneration::max_capacity() const { - const size_t alignment = GenCollectedHeap::heap()->collector_policy()->min_alignment(); + const size_t alignment = GenCollectedHeap::heap()->collector_policy()->space_alignment(); const size_t reserved_bytes = reserved().byte_size(); return reserved_bytes - compute_survivor_size(reserved_bytes, alignment); } diff --git a/hotspot/src/share/vm/memory/genCollectedHeap.cpp b/hotspot/src/share/vm/memory/genCollectedHeap.cpp index 3a5ab210c83..aa6f24bd23e 100644 --- a/hotspot/src/share/vm/memory/genCollectedHeap.cpp +++ b/hotspot/src/share/vm/memory/genCollectedHeap.cpp @@ -111,7 +111,7 @@ jint GenCollectedHeap::initialize() { int n_covered_regions = 0; ReservedSpace heap_rs; - size_t heap_alignment = collector_policy()->max_alignment(); + size_t heap_alignment = collector_policy()->heap_alignment(); heap_address = allocate(heap_alignment, &total_reserved, &n_covered_regions, &heap_rs); @@ -1053,12 +1053,6 @@ void GenCollectedHeap::save_marks() { } } -void GenCollectedHeap::compute_new_generation_sizes(int collectedGen) { - for (int i = 0; i <= collectedGen; i++) { - _gens[i]->compute_new_size(); - } -} - GenCollectedHeap* GenCollectedHeap::heap() { assert(_gch != NULL, "Uninitialized access to GenCollectedHeap::heap()"); assert(_gch->kind() == CollectedHeap::GenCollectedHeap, "not a generational heap"); diff --git a/hotspot/src/share/vm/memory/genCollectedHeap.hpp b/hotspot/src/share/vm/memory/genCollectedHeap.hpp index 8f814132a78..5cd8a71280a 100644 --- a/hotspot/src/share/vm/memory/genCollectedHeap.hpp +++ b/hotspot/src/share/vm/memory/genCollectedHeap.hpp @@ -86,10 +86,6 @@ public: NOT_PRODUCT(static size_t _skip_header_HeapWords;) protected: - // Directs each generation up to and including "collectedGen" to recompute - // its desired size. - void compute_new_generation_sizes(int collectedGen); - // Helper functions for allocation HeapWord* attempt_allocation(size_t size, bool is_tlab, diff --git a/hotspot/src/share/vm/memory/metaspace.cpp b/hotspot/src/share/vm/memory/metaspace.cpp index f9e3385eb22..826dde3838c 100644 --- a/hotspot/src/share/vm/memory/metaspace.cpp +++ b/hotspot/src/share/vm/memory/metaspace.cpp @@ -2975,11 +2975,6 @@ void Metaspace::initialize_class_space(ReservedSpace rs) { #endif -// Align down. If the aligning result in 0, return 'alignment'. -static size_t restricted_align_down(size_t size, size_t alignment) { - return MAX2(alignment, align_size_down_(size, alignment)); -} - void Metaspace::ergo_initialize() { if (DumpSharedSpaces) { // Using large pages when dumping the shared archive is currently not implemented. @@ -3002,13 +2997,13 @@ void Metaspace::ergo_initialize() { // Ideally, we would be able to set the default value of MaxMetaspaceSize in // globals.hpp to the aligned value, but this is not possible, since the // alignment depends on other flags being parsed. - MaxMetaspaceSize = restricted_align_down(MaxMetaspaceSize, _reserve_alignment); + MaxMetaspaceSize = align_size_down_bounded(MaxMetaspaceSize, _reserve_alignment); if (MetaspaceSize > MaxMetaspaceSize) { MetaspaceSize = MaxMetaspaceSize; } - MetaspaceSize = restricted_align_down(MetaspaceSize, _commit_alignment); + MetaspaceSize = align_size_down_bounded(MetaspaceSize, _commit_alignment); assert(MetaspaceSize <= MaxMetaspaceSize, "MetaspaceSize should be limited by MaxMetaspaceSize"); @@ -3016,10 +3011,10 @@ void Metaspace::ergo_initialize() { vm_exit_during_initialization("Too small initial Metaspace size"); } - MinMetaspaceExpansion = restricted_align_down(MinMetaspaceExpansion, _commit_alignment); - MaxMetaspaceExpansion = restricted_align_down(MaxMetaspaceExpansion, _commit_alignment); + MinMetaspaceExpansion = align_size_down_bounded(MinMetaspaceExpansion, _commit_alignment); + MaxMetaspaceExpansion = align_size_down_bounded(MaxMetaspaceExpansion, _commit_alignment); - CompressedClassSpaceSize = restricted_align_down(CompressedClassSpaceSize, _reserve_alignment); + CompressedClassSpaceSize = align_size_down_bounded(CompressedClassSpaceSize, _reserve_alignment); set_compressed_class_space_size(CompressedClassSpaceSize); } diff --git a/hotspot/src/share/vm/memory/sharedHeap.cpp b/hotspot/src/share/vm/memory/sharedHeap.cpp index 79455db9b6e..47ebc180c8e 100644 --- a/hotspot/src/share/vm/memory/sharedHeap.cpp +++ b/hotspot/src/share/vm/memory/sharedHeap.cpp @@ -247,6 +247,7 @@ void SharedHeap::set_barrier_set(BarrierSet* bs) { } void SharedHeap::post_initialize() { + CollectedHeap::post_initialize(); ref_processing_init(); } diff --git a/hotspot/src/share/vm/memory/universe.cpp b/hotspot/src/share/vm/memory/universe.cpp index 043962c6304..b393272e064 100644 --- a/hotspot/src/share/vm/memory/universe.cpp +++ b/hotspot/src/share/vm/memory/universe.cpp @@ -785,6 +785,7 @@ jint Universe::initialize_heap() { } else if (UseG1GC) { #if INCLUDE_ALL_GCS G1CollectorPolicy* g1p = new G1CollectorPolicy(); + g1p->initialize_all(); G1CollectedHeap* g1h = new G1CollectedHeap(g1p); Universe::_collectedHeap = g1h; #else // INCLUDE_ALL_GCS @@ -809,6 +810,7 @@ jint Universe::initialize_heap() { } else { // default old generation gc_policy = new MarkSweepPolicy(); } + gc_policy->initialize_all(); Universe::_collectedHeap = new GenCollectedHeap(gc_policy); } @@ -1041,7 +1043,7 @@ bool universe_post_init() { Universe::_virtual_machine_error_instance = InstanceKlass::cast(k)->allocate_instance(CHECK_false); - Universe::_vm_exception = InstanceKlass::cast(k)->allocate_instance(CHECK_false); + Universe::_vm_exception = InstanceKlass::cast(k)->allocate_instance(CHECK_false); if (!DumpSharedSpaces) { // These are the only Java fields that are currently set during shared space dumping. diff --git a/hotspot/src/share/vm/oops/cpCache.cpp b/hotspot/src/share/vm/oops/cpCache.cpp index 215cf7796f0..c9bbb5fc4d9 100644 --- a/hotspot/src/share/vm/oops/cpCache.cpp +++ b/hotspot/src/share/vm/oops/cpCache.cpp @@ -554,24 +554,37 @@ void ConstantPoolCacheEntry::verify(outputStream* st) const { // Implementation of ConstantPoolCache ConstantPoolCache* ConstantPoolCache::allocate(ClassLoaderData* loader_data, - int length, const intStack& index_map, + const intStack& invokedynamic_index_map, const intStack& invokedynamic_map, TRAPS) { + + const int length = index_map.length() + invokedynamic_index_map.length(); int size = ConstantPoolCache::size(length); return new (loader_data, size, false, MetaspaceObj::ConstantPoolCacheType, THREAD) - ConstantPoolCache(length, index_map, invokedynamic_map); + ConstantPoolCache(length, index_map, invokedynamic_index_map, invokedynamic_map); } void ConstantPoolCache::initialize(const intArray& inverse_index_map, + const intArray& invokedynamic_inverse_index_map, const intArray& invokedynamic_references_map) { - assert(inverse_index_map.length() == length(), "inverse index map must have same length as cache"); - for (int i = 0; i < length(); i++) { + for (int i = 0; i < inverse_index_map.length(); i++) { ConstantPoolCacheEntry* e = entry_at(i); int original_index = inverse_index_map[i]; e->initialize_entry(original_index); assert(entry_at(i) == e, "sanity"); } + + // Append invokedynamic entries at the end + int invokedynamic_offset = inverse_index_map.length(); + for (int i = 0; i < invokedynamic_inverse_index_map.length(); i++) { + int offset = i + invokedynamic_offset; + ConstantPoolCacheEntry* e = entry_at(offset); + int original_index = invokedynamic_inverse_index_map[i]; + e->initialize_entry(original_index); + assert(entry_at(offset) == e, "sanity"); + } + for (int ref = 0; ref < invokedynamic_references_map.length(); ref++) { const int cpci = invokedynamic_references_map[ref]; if (cpci >= 0) { diff --git a/hotspot/src/share/vm/oops/cpCache.hpp b/hotspot/src/share/vm/oops/cpCache.hpp index 77c0deb9d8f..26079fdfdb1 100644 --- a/hotspot/src/share/vm/oops/cpCache.hpp +++ b/hotspot/src/share/vm/oops/cpCache.hpp @@ -31,6 +31,10 @@ class PSPromotionManager; +// The ConstantPoolCache is not a cache! It is the resolution table that the +// interpreter uses to avoid going into the runtime and a way to access resolved +// values. + // A ConstantPoolCacheEntry describes an individual entry of the constant // pool cache. There's 2 principal kinds of entries: field entries for in- // stance & static field access, and method entries for invokes. Some of @@ -392,26 +396,33 @@ class ConstantPoolCache: public MetaspaceObj { friend class MetadataFactory; private: int _length; - ConstantPool* _constant_pool; // the corresponding constant pool + ConstantPool* _constant_pool; // the corresponding constant pool // Sizing debug_only(friend class ClassVerifier;) // Constructor - ConstantPoolCache(int length, const intStack& inverse_index_map, + ConstantPoolCache(int length, + const intStack& inverse_index_map, + const intStack& invokedynamic_inverse_index_map, const intStack& invokedynamic_references_map) : - _length(length), _constant_pool(NULL) { - initialize(inverse_index_map, invokedynamic_references_map); + _length(length), + _constant_pool(NULL) { + initialize(inverse_index_map, invokedynamic_inverse_index_map, + invokedynamic_references_map); for (int i = 0; i < length; i++) { assert(entry_at(i)->is_f1_null(), "Failed to clear?"); } } // Initialization - void initialize(const intArray& inverse_index_map, const intArray& invokedynamic_references_map); + void initialize(const intArray& inverse_index_map, + const intArray& invokedynamic_inverse_index_map, + const intArray& invokedynamic_references_map); public: - static ConstantPoolCache* allocate(ClassLoaderData* loader_data, int length, - const intStack& inverse_index_map, + static ConstantPoolCache* allocate(ClassLoaderData* loader_data, + const intStack& cp_cache_map, + const intStack& invokedynamic_cp_cache_map, const intStack& invokedynamic_references_map, TRAPS); bool is_constantPoolCache() const { return true; } diff --git a/hotspot/src/share/vm/oops/instanceKlass.cpp b/hotspot/src/share/vm/oops/instanceKlass.cpp index 510102d4e35..ae7ea804853 100644 --- a/hotspot/src/share/vm/oops/instanceKlass.cpp +++ b/hotspot/src/share/vm/oops/instanceKlass.cpp @@ -2211,6 +2211,10 @@ void InstanceKlass::clean_method_data(BoolObjectClosure* is_alive) { data = mdo->next_data(data)) { data->clean_weak_klass_links(is_alive); } + ParametersTypeData* parameters = mdo->parameters_type_data(); + if (parameters != NULL) { + parameters->clean_weak_klass_links(is_alive); + } } } } diff --git a/hotspot/src/share/vm/oops/klassVtable.cpp b/hotspot/src/share/vm/oops/klassVtable.cpp index 568e15ffae0..07a1c756826 100644 --- a/hotspot/src/share/vm/oops/klassVtable.cpp +++ b/hotspot/src/share/vm/oops/klassVtable.cpp @@ -86,7 +86,11 @@ void klassVtable::compute_vtable_size_and_num_mirandas( get_mirandas(&new_mirandas, all_mirandas, super, methods, NULL, local_interfaces); *num_new_mirandas = new_mirandas.length(); - vtable_length += *num_new_mirandas * vtableEntry::size(); + // Interfaces do not need interface methods in their vtables + // This includes miranda methods and during later processing, default methods + if (!class_flags.is_interface()) { + vtable_length += *num_new_mirandas * vtableEntry::size(); + } if (Universe::is_bootstrapping() && vtable_length == 0) { // array classes don't have their superclass set correctly during @@ -224,7 +228,11 @@ void klassVtable::initialize_vtable(bool checkconstraints, TRAPS) { } // add miranda methods; it will also return the updated initialized - initialized = fill_in_mirandas(initialized); + // Interfaces do not need interface methods in their vtables + // This includes miranda methods and during later processing, default methods + if (!ik()->is_interface()) { + initialized = fill_in_mirandas(initialized); + } // In class hierarchies where the accessibility is not increasing (i.e., going from private -> // package_private -> public/protected), the vtable might actually be smaller than our initial @@ -264,12 +272,12 @@ InstanceKlass* klassVtable::find_transitive_override(InstanceKlass* initialsuper _klass->internal_name(), sig, vtable_index); super_method->access_flags().print_on(tty); if (super_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } tty->print("overriders flags: "); target_method->access_flags().print_on(tty); if (target_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } } #endif /*PRODUCT*/ @@ -332,9 +340,15 @@ bool klassVtable::update_inherited_vtable(InstanceKlass* klass, methodHandle tar // An interface never allocates new vtable slots, only inherits old ones. // This method will either be assigned its own itable index later, // or be assigned an inherited vtable index in the loop below. - // default methods store their vtable indices in the inheritors default_vtable_indices - assert (default_index == -1, "interfaces don't store resolved default methods"); - target_method()->set_vtable_index(Method::pending_itable_index); + // default methods inherited by classes store their vtable indices + // in the inheritor's default_vtable_indices + // default methods inherited by interfaces may already have a + // valid itable index, if so, don't change it + // overpass methods in an interface will be assigned an itable index later + // by an inheriting class + if (!is_default || !target_method()->has_itable_index()) { + target_method()->set_vtable_index(Method::pending_itable_index); + } } // we need a new entry if there is no superclass @@ -441,7 +455,7 @@ bool klassVtable::update_inherited_vtable(InstanceKlass* klass, methodHandle tar target_klass->internal_name(), sig, i); super_method->access_flags().print_on(tty); if (super_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (super_method->is_overpass()) { tty->print("overpass"); @@ -449,7 +463,7 @@ bool klassVtable::update_inherited_vtable(InstanceKlass* klass, methodHandle tar tty->print("overriders flags: "); target_method->access_flags().print_on(tty); if (target_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (target_method->is_overpass()) { tty->print("overpass"); @@ -468,7 +482,7 @@ bool klassVtable::update_inherited_vtable(InstanceKlass* klass, methodHandle tar target_klass->internal_name(), sig,i); super_method->access_flags().print_on(tty); if (super_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (super_method->is_overpass()) { tty->print("overpass"); @@ -476,7 +490,7 @@ bool klassVtable::update_inherited_vtable(InstanceKlass* klass, methodHandle tar tty->print("overriders flags: "); target_method->access_flags().print_on(tty); if (target_method->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (target_method->is_overpass()) { tty->print("overpass"); @@ -494,8 +508,18 @@ void klassVtable::put_method_at(Method* m, int index) { #ifndef PRODUCT if (PrintVtables && Verbose) { ResourceMark rm; - tty->print_cr("adding %s::%s at index %d", _klass->internal_name(), - (m != NULL) ? m->name()->as_C_string() : "", index); + const char* sig = (m != NULL) ? m->name_and_sig_as_C_string() : ""; + tty->print("adding %s at index %d, flags: ", sig, index); + if (m != NULL) { + m->access_flags().print_on(tty); + if (m->is_default_method()) { + tty->print("default "); + } + if (m->is_overpass()) { + tty->print("overpass"); + } + } + tty->cr(); } #endif table()[index].set(m); @@ -631,8 +655,10 @@ bool klassVtable::is_miranda_entry_at(int i) { if (mhk->is_interface()) { assert(m->is_public(), "should be public"); assert(ik()->implements_interface(method_holder) , "this class should implement the interface"); - assert(is_miranda(m, ik()->methods(), ik()->default_methods(), ik()->super()), "should be a miranda_method"); - return true; + // the search could find a miranda or a default method + if (is_miranda(m, ik()->methods(), ik()->default_methods(), ik()->super())) { + return true; + } } return false; } @@ -644,9 +670,10 @@ bool klassVtable::is_miranda_entry_at(int i) { // the caller must make sure that the method belongs to an interface implemented by the class // Miranda methods only include public interface instance methods // Not private methods, not static methods, not default == concrete abstract +// Miranda methods also do not include overpass methods in interfaces bool klassVtable::is_miranda(Method* m, Array* class_methods, Array* default_methods, Klass* super) { - if (m->is_static() || m->is_private()) { + if (m->is_static() || m->is_private() || m->is_overpass()) { return false; } Symbol* name = m->name(); @@ -744,6 +771,8 @@ void klassVtable::get_mirandas(GrowableArray* new_mirandas, // Discover miranda methods ("miranda" = "interface abstract, no binding"), // and append them into the vtable starting at index initialized, // return the new value of initialized. +// Miranda methods use vtable entries, but do not get assigned a vtable_index +// The vtable_index is discovered by searching from the end of the vtable int klassVtable::fill_in_mirandas(int initialized) { GrowableArray mirandas(20); get_mirandas(&mirandas, NULL, ik()->super(), ik()->methods(), @@ -758,7 +787,7 @@ int klassVtable::fill_in_mirandas(int initialized) { sig, initialized); meth->access_flags().print_on(tty); if (meth->is_default_method()) { - tty->print("default"); + tty->print("default "); } tty->cr(); } @@ -858,7 +887,7 @@ void klassVtable::dump_vtable() { tty->print(" (%5d) ", i); m->access_flags().print_on(tty); if (m->is_default_method()) { - tty->print("default"); + tty->print("default "); } if (m->is_overpass()) { tty->print("overpass"); @@ -977,6 +1006,25 @@ int klassItable::assign_itable_indices_for_interface(Klass* klass) { if (interface_method_needs_itable_index(m)) { assert(!m->is_final_method(), "no final interface methods"); // If m is already assigned a vtable index, do not disturb it. + if (TraceItables && Verbose) { + ResourceMark rm; + const char* sig = (m != NULL) ? m->name_and_sig_as_C_string() : ""; + if (m->has_vtable_index()) { + tty->print("itable index %d for method: %s, flags: ", m->vtable_index(), sig); + } else { + tty->print("itable index %d for method: %s, flags: ", ime_num, sig); + } + if (m != NULL) { + m->access_flags().print_on(tty); + if (m->is_default_method()) { + tty->print("default "); + } + if (m->is_overpass()) { + tty->print("overpass"); + } + } + tty->cr(); + } if (!m->has_vtable_index()) { assert(m->vtable_index() == Method::pending_itable_index, "set by initialize_vtable"); m->set_itable_index(ime_num); @@ -1079,7 +1127,7 @@ void klassItable::initialize_itable_for_interface(int method_table_offset, Klass tty->print("target_method flags: "); target()->access_flags().print_on(tty); if (target()->is_default_method()) { - tty->print("default"); + tty->print("default "); } tty->cr(); } @@ -1158,7 +1206,7 @@ void klassItable::dump_itable() { tty->print(" (%5d) ", i); m->access_flags().print_on(tty); if (m->is_default_method()) { - tty->print("default"); + tty->print("default "); } tty->print(" -- "); m->print_name(tty); diff --git a/hotspot/src/share/vm/oops/methodData.cpp b/hotspot/src/share/vm/oops/methodData.cpp index 2cff5ee2c79..64c2f161377 100644 --- a/hotspot/src/share/vm/oops/methodData.cpp +++ b/hotspot/src/share/vm/oops/methodData.cpp @@ -275,23 +275,23 @@ void VirtualCallTypeData::post_initialize(BytecodeStream* stream, MethodData* md } bool TypeEntries::is_loader_alive(BoolObjectClosure* is_alive_cl, intptr_t p) { - return !is_type_none(p) && - !((Klass*)klass_part(p))->is_loader_alive(is_alive_cl); + Klass* k = (Klass*)klass_part(p); + return k != NULL && k->is_loader_alive(is_alive_cl); } void TypeStackSlotEntries::clean_weak_klass_links(BoolObjectClosure* is_alive_cl) { for (int i = 0; i < _number_of_entries; i++) { intptr_t p = type(i); - if (is_loader_alive(is_alive_cl, p)) { - set_type(i, type_none()); + if (!is_loader_alive(is_alive_cl, p)) { + set_type(i, with_status((Klass*)NULL, p)); } } } void ReturnTypeEntry::clean_weak_klass_links(BoolObjectClosure* is_alive_cl) { intptr_t p = type(); - if (is_loader_alive(is_alive_cl, p)) { - set_type(type_none()); + if (!is_loader_alive(is_alive_cl, p)) { + set_type(with_status((Klass*)NULL, p)); } } diff --git a/hotspot/src/share/vm/oops/methodData.hpp b/hotspot/src/share/vm/oops/methodData.hpp index a007708bb31..75cae3b15bb 100644 --- a/hotspot/src/share/vm/oops/methodData.hpp +++ b/hotspot/src/share/vm/oops/methodData.hpp @@ -690,7 +690,6 @@ public: // recorded type: cell without bit 0 and 1 static intptr_t klass_part(intptr_t v) { intptr_t r = v & type_klass_mask; - assert (r != 0, "invalid"); return r; } @@ -698,7 +697,9 @@ public: static Klass* valid_klass(intptr_t k) { if (!is_type_none(k) && !is_type_unknown(k)) { - return (Klass*)klass_part(k); + Klass* res = (Klass*)klass_part(k); + assert(res != NULL, "invalid"); + return res; } else { return NULL; } diff --git a/hotspot/src/share/vm/opto/bytecodeInfo.cpp b/hotspot/src/share/vm/opto/bytecodeInfo.cpp index 885ed1de643..1e875c42c50 100644 --- a/hotspot/src/share/vm/opto/bytecodeInfo.cpp +++ b/hotspot/src/share/vm/opto/bytecodeInfo.cpp @@ -389,6 +389,10 @@ bool InlineTree::try_to_inline(ciMethod* callee_method, ciMethod* caller_method, return false; } if (inline_level() > _max_inline_level) { + if (callee_method->force_inline() && inline_level() > MaxForceInlineLevel) { + set_msg("MaxForceInlineLevel"); + return false; + } if (!callee_method->force_inline() || !IncrementalInline) { set_msg("inlining too deep"); return false; diff --git a/hotspot/src/share/vm/opto/callGenerator.cpp b/hotspot/src/share/vm/opto/callGenerator.cpp index 33a13c83190..adc27ac02e4 100644 --- a/hotspot/src/share/vm/opto/callGenerator.cpp +++ b/hotspot/src/share/vm/opto/callGenerator.cpp @@ -776,7 +776,7 @@ CallGenerator* CallGenerator::for_method_handle_inline(JVMState* jvms, ciMethod* guarantee(!target->is_method_handle_intrinsic(), "should not happen"); // XXX remove const int vtable_index = Method::invalid_vtable_index; CallGenerator* cg = C->call_generator(target, vtable_index, false, jvms, true, PROB_ALWAYS, NULL, true, true); - assert(!cg->is_late_inline() || cg->is_mh_late_inline(), "no late inline here"); + assert(cg == NULL || !cg->is_late_inline() || cg->is_mh_late_inline(), "no late inline here"); if (cg != NULL && cg->is_inline()) return cg; } @@ -846,7 +846,7 @@ CallGenerator* CallGenerator::for_method_handle_inline(JVMState* jvms, ciMethod* } CallGenerator* cg = C->call_generator(target, vtable_index, call_does_dispatch, jvms, true, PROB_ALWAYS, speculative_receiver_type, true, true); - assert(!cg->is_late_inline() || cg->is_mh_late_inline(), "no late inline here"); + assert(cg == NULL || !cg->is_late_inline() || cg->is_mh_late_inline(), "no late inline here"); if (cg != NULL && cg->is_inline()) return cg; } diff --git a/hotspot/src/share/vm/opto/loopopts.cpp b/hotspot/src/share/vm/opto/loopopts.cpp index 6529d1919ab..a7bf3ad28e8 100644 --- a/hotspot/src/share/vm/opto/loopopts.cpp +++ b/hotspot/src/share/vm/opto/loopopts.cpp @@ -42,6 +42,13 @@ Node *PhaseIdealLoop::split_thru_phi( Node *n, Node *region, int policy ) { // so disable this for now return NULL; } + + if (n->is_MathExact()) { + // MathExact has projections that are not correctly handled in the code + // below. + return NULL; + } + int wins = 0; assert(!n->is_CFG(), ""); assert(region->is_Region(), ""); diff --git a/hotspot/src/share/vm/opto/matcher.cpp b/hotspot/src/share/vm/opto/matcher.cpp index 85474115f30..25a71002073 100644 --- a/hotspot/src/share/vm/opto/matcher.cpp +++ b/hotspot/src/share/vm/opto/matcher.cpp @@ -464,17 +464,17 @@ void Matcher::init_first_stack_mask() { C->FIRST_STACK_mask().Clear(); // Add in the incoming argument area - OptoReg::Name init = OptoReg::add(_old_SP, C->out_preserve_stack_slots()); - for (i = init; i < _in_arg_limit; i = OptoReg::add(i,1)) + OptoReg::Name init_in = OptoReg::add(_old_SP, C->out_preserve_stack_slots()); + for (i = init_in; i < _in_arg_limit; i = OptoReg::add(i,1)) { C->FIRST_STACK_mask().Insert(i); - + } // Add in all bits past the outgoing argument area guarantee(RegMask::can_represent_arg(OptoReg::add(_out_arg_limit,-1)), "must be able to represent all call arguments in reg mask"); - init = _out_arg_limit; - for (i = init; RegMask::can_represent(i); i = OptoReg::add(i,1)) + OptoReg::Name init = _out_arg_limit; + for (i = init; RegMask::can_represent(i); i = OptoReg::add(i,1)) { C->FIRST_STACK_mask().Insert(i); - + } // Finally, set the "infinite stack" bit. C->FIRST_STACK_mask().set_AllStack(); @@ -506,16 +506,36 @@ void Matcher::init_first_stack_mask() { idealreg2spillmask[Op_VecS]->OR(C->FIRST_STACK_mask()); } if (Matcher::vector_size_supported(T_FLOAT,2)) { + // For VecD we need dual alignment and 8 bytes (2 slots) for spills. + // RA guarantees such alignment since it is needed for Double and Long values. *idealreg2spillmask[Op_VecD] = *idealreg2regmask[Op_VecD]; idealreg2spillmask[Op_VecD]->OR(aligned_stack_mask); } if (Matcher::vector_size_supported(T_FLOAT,4)) { + // For VecX we need quadro alignment and 16 bytes (4 slots) for spills. + // + // RA can use input arguments stack slots for spills but until RA + // we don't know frame size and offset of input arg stack slots. + // + // Exclude last input arg stack slots to avoid spilling vectors there + // otherwise vector spills could stomp over stack slots in caller frame. + OptoReg::Name in = OptoReg::add(_in_arg_limit, -1); + for (int k = 1; (in >= init_in) && (k < RegMask::SlotsPerVecX); k++) { + aligned_stack_mask.Remove(in); + in = OptoReg::add(in, -1); + } aligned_stack_mask.clear_to_sets(RegMask::SlotsPerVecX); assert(aligned_stack_mask.is_AllStack(), "should be infinite stack"); *idealreg2spillmask[Op_VecX] = *idealreg2regmask[Op_VecX]; idealreg2spillmask[Op_VecX]->OR(aligned_stack_mask); } if (Matcher::vector_size_supported(T_FLOAT,8)) { + // For VecY we need octo alignment and 32 bytes (8 slots) for spills. + OptoReg::Name in = OptoReg::add(_in_arg_limit, -1); + for (int k = 1; (in >= init_in) && (k < RegMask::SlotsPerVecY); k++) { + aligned_stack_mask.Remove(in); + in = OptoReg::add(in, -1); + } aligned_stack_mask.clear_to_sets(RegMask::SlotsPerVecY); assert(aligned_stack_mask.is_AllStack(), "should be infinite stack"); *idealreg2spillmask[Op_VecY] = *idealreg2regmask[Op_VecY]; diff --git a/hotspot/src/share/vm/opto/mathexactnode.hpp b/hotspot/src/share/vm/opto/mathexactnode.hpp index 59983e10bcd..a30304ba93a 100644 --- a/hotspot/src/share/vm/opto/mathexactnode.hpp +++ b/hotspot/src/share/vm/opto/mathexactnode.hpp @@ -49,7 +49,7 @@ public: virtual Node* Identity(PhaseTransform* phase) { return this; } virtual Node* Ideal(PhaseGVN* phase, bool can_reshape) { return NULL; } virtual const Type* Value(PhaseTransform* phase) const { return bottom_type(); } - virtual uint hash() const { return Node::hash(); } + virtual uint hash() const { return NO_HASH; } virtual bool is_CFG() const { return false; } virtual uint ideal_reg() const { return NotAMachineReg; } diff --git a/hotspot/src/share/vm/prims/whitebox.cpp b/hotspot/src/share/vm/prims/whitebox.cpp index 6f6a2000a3f..1cb799b3ea9 100644 --- a/hotspot/src/share/vm/prims/whitebox.cpp +++ b/hotspot/src/share/vm/prims/whitebox.cpp @@ -53,6 +53,8 @@ #include "compiler/compileBroker.hpp" #include "runtime/compilationPolicy.hpp" +#define SIZE_T_MAX_VALUE ((size_t) -1) + bool WhiteBox::_used = false; WB_ENTRY(jlong, WB_GetObjectAddress(JNIEnv* env, jobject o, jobject obj)) @@ -105,10 +107,116 @@ WB_ENTRY(void, WB_PrintHeapSizes(JNIEnv* env, jobject o)) { gclog_or_tty->print_cr("Minimum heap "SIZE_FORMAT" Initial heap " SIZE_FORMAT" Maximum heap "SIZE_FORMAT" Min alignment "SIZE_FORMAT" Max alignment "SIZE_FORMAT, p->min_heap_byte_size(), p->initial_heap_byte_size(), p->max_heap_byte_size(), - p->min_alignment(), p->max_alignment()); + p->space_alignment(), p->heap_alignment()); } WB_END +#ifndef PRODUCT +// Forward declaration +void TestReservedSpace_test(); +void TestReserveMemorySpecial_test(); +void TestVirtualSpace_test(); +void TestMetaspaceAux_test(); +#endif + +WB_ENTRY(void, WB_RunMemoryUnitTests(JNIEnv* env, jobject o)) +#ifndef PRODUCT + TestReservedSpace_test(); + TestReserveMemorySpecial_test(); + TestVirtualSpace_test(); + TestMetaspaceAux_test(); +#endif +WB_END + +WB_ENTRY(void, WB_ReadFromNoaccessArea(JNIEnv* env, jobject o)) + size_t granularity = os::vm_allocation_granularity(); + ReservedHeapSpace rhs(100 * granularity, granularity, false, NULL); + VirtualSpace vs; + vs.initialize(rhs, 50 * granularity); + + //Check if constraints are complied + if (!( UseCompressedOops && rhs.base() != NULL && + Universe::narrow_oop_base() != NULL && + Universe::narrow_oop_use_implicit_null_checks() )) { + tty->print_cr("WB_ReadFromNoaccessArea method is useless:\n " + "\tUseCompressedOops is %d\n" + "\trhs.base() is "PTR_FORMAT"\n" + "\tUniverse::narrow_oop_base() is "PTR_FORMAT"\n" + "\tUniverse::narrow_oop_use_implicit_null_checks() is %d", + UseCompressedOops, + rhs.base(), + Universe::narrow_oop_base(), + Universe::narrow_oop_use_implicit_null_checks()); + return; + } + tty->print_cr("Reading from no access area... "); + tty->print_cr("*(vs.low_boundary() - rhs.noaccess_prefix() / 2 ) = %c", + *(vs.low_boundary() - rhs.noaccess_prefix() / 2 )); +WB_END + +static jint wb_stress_virtual_space_resize(size_t reserved_space_size, + size_t magnitude, size_t iterations) { + size_t granularity = os::vm_allocation_granularity(); + ReservedHeapSpace rhs(reserved_space_size * granularity, granularity, false, NULL); + VirtualSpace vs; + if (!vs.initialize(rhs, 0)) { + tty->print_cr("Failed to initialize VirtualSpace. Can't proceed."); + return 3; + } + + long seed = os::random(); + tty->print_cr("Random seed is %ld", seed); + os::init_random(seed); + + for (size_t i = 0; i < iterations; i++) { + + // Whether we will shrink or grow + bool shrink = os::random() % 2L == 0; + + // Get random delta to resize virtual space + size_t delta = (size_t)os::random() % magnitude; + + // If we are about to shrink virtual space below zero, then expand instead + if (shrink && vs.committed_size() < delta) { + shrink = false; + } + + // Resizing by delta + if (shrink) { + vs.shrink_by(delta); + } else { + // If expanding fails expand_by will silently return false + vs.expand_by(delta, true); + } + } + return 0; +} + +WB_ENTRY(jint, WB_StressVirtualSpaceResize(JNIEnv* env, jobject o, + jlong reserved_space_size, jlong magnitude, jlong iterations)) + tty->print_cr("reservedSpaceSize="JLONG_FORMAT", magnitude="JLONG_FORMAT", " + "iterations="JLONG_FORMAT"\n", reserved_space_size, magnitude, + iterations); + if (reserved_space_size < 0 || magnitude < 0 || iterations < 0) { + tty->print_cr("One of variables printed above is negative. Can't proceed.\n"); + return 1; + } + + // sizeof(size_t) depends on whether OS is 32bit or 64bit. sizeof(jlong) is + // always 8 byte. That's why we should avoid overflow in case of 32bit platform. + if (sizeof(size_t) < sizeof(jlong)) { + jlong size_t_max_value = (jlong) SIZE_T_MAX_VALUE; + if (reserved_space_size > size_t_max_value || magnitude > size_t_max_value + || iterations > size_t_max_value) { + tty->print_cr("One of variables printed above overflows size_t. Can't proceed.\n"); + return 2; + } + } + + return wb_stress_virtual_space_resize((size_t) reserved_space_size, + (size_t) magnitude, (size_t) iterations); +WB_END + #if INCLUDE_ALL_GCS WB_ENTRY(jboolean, WB_G1IsHumongous(JNIEnv* env, jobject o, jobject obj)) G1CollectedHeap* g1 = G1CollectedHeap::heap(); @@ -445,6 +553,9 @@ static JNINativeMethod methods[] = { {CC"getCompressedOopsMaxHeapSize", CC"()J", (void*)&WB_GetCompressedOopsMaxHeapSize}, {CC"printHeapSizes", CC"()V", (void*)&WB_PrintHeapSizes }, + {CC"runMemoryUnitTests", CC"()V", (void*)&WB_RunMemoryUnitTests}, + {CC"readFromNoaccessArea",CC"()V", (void*)&WB_ReadFromNoaccessArea}, + {CC"stressVirtualSpaceResize",CC"(JJJ)I", (void*)&WB_StressVirtualSpaceResize}, #if INCLUDE_ALL_GCS {CC"g1InConcurrentMark", CC"()Z", (void*)&WB_G1InConcurrentMark}, {CC"g1IsHumongous", CC"(Ljava/lang/Object;)Z", (void*)&WB_G1IsHumongous }, diff --git a/hotspot/src/share/vm/runtime/arguments.cpp b/hotspot/src/share/vm/runtime/arguments.cpp index 8060dae0377..51fb3f7d595 100644 --- a/hotspot/src/share/vm/runtime/arguments.cpp +++ b/hotspot/src/share/vm/runtime/arguments.cpp @@ -1132,9 +1132,6 @@ void Arguments::set_tiered_flags() { Tier3InvokeNotifyFreqLog = 0; Tier4InvocationThreshold = 0; } - if (FLAG_IS_DEFAULT(NmethodSweepFraction)) { - FLAG_SET_DEFAULT(NmethodSweepFraction, 1 + ReservedCodeCacheSize / (16 * M)); - } } #if INCLUDE_ALL_GCS @@ -1408,7 +1405,7 @@ uintx Arguments::max_heap_for_compressed_oops() { // NULL page is located before the heap, we pad the NULL page to the conservative // maximum alignment that the GC may ever impose upon the heap. size_t displacement_due_to_null_page = align_size_up_(os::vm_page_size(), - Arguments::conservative_max_heap_alignment()); + _conservative_max_heap_alignment); LP64_ONLY(return OopEncodingHeapMax - displacement_due_to_null_page); NOT_LP64(ShouldNotReachHere(); return 0); @@ -1505,7 +1502,7 @@ void Arguments::set_conservative_max_heap_alignment() { } #endif // INCLUDE_ALL_GCS _conservative_max_heap_alignment = MAX3(heap_alignment, os::max_page_size(), - CollectorPolicy::compute_max_alignment()); + CollectorPolicy::compute_heap_alignment()); } void Arguments::set_ergonomics_flags() { @@ -2165,6 +2162,10 @@ bool Arguments::check_vm_args_consistency() { #if INCLUDE_ALL_GCS if (UseG1GC) { + status = status && verify_percentage(G1NewSizePercent, "G1NewSizePercent"); + status = status && verify_percentage(G1MaxNewSizePercent, "G1MaxNewSizePercent"); + status = status && verify_interval(G1NewSizePercent, 0, G1MaxNewSizePercent, "G1NewSizePercent"); + status = status && verify_percentage(InitiatingHeapOccupancyPercent, "InitiatingHeapOccupancyPercent"); status = status && verify_min_value(G1RefProcDrainInterval, 1, @@ -2681,9 +2682,10 @@ jint Arguments::parse_each_vm_init_arg(const JavaVMInitArgs* args, describe_range_error(errcode); return JNI_EINVAL; } - FLAG_SET_CMDLINE(uintx, InitialHeapSize, (uintx)long_initial_heap_size); + set_min_heap_size((uintx)long_initial_heap_size); // Currently the minimum size and the initial heap sizes are the same. - set_min_heap_size(InitialHeapSize); + // Can be overridden with -XX:InitialHeapSize. + FLAG_SET_CMDLINE(uintx, InitialHeapSize, (uintx)long_initial_heap_size); // -Xmx } else if (match_option(option, "-Xmx", &tail) || match_option(option, "-XX:MaxHeapSize=", &tail)) { julong long_max_heap_size = 0; @@ -3643,6 +3645,11 @@ jint Arguments::apply_ergo() { "Incompatible compilation policy selected", NULL); } } + // Set NmethodSweepFraction after the size of the code cache is adapted (in case of tiered) + if (FLAG_IS_DEFAULT(NmethodSweepFraction)) { + FLAG_SET_DEFAULT(NmethodSweepFraction, 1 + ReservedCodeCacheSize / (16 * M)); + } + // Set heap size based on available physical memory set_heap_size(); diff --git a/hotspot/src/share/vm/runtime/globals.cpp b/hotspot/src/share/vm/runtime/globals.cpp index f4b3865e5d3..de6fbf70856 100644 --- a/hotspot/src/share/vm/runtime/globals.cpp +++ b/hotspot/src/share/vm/runtime/globals.cpp @@ -321,6 +321,8 @@ void Flag::print_kind(outputStream* st) { { KIND_PRODUCT, "product" }, { KIND_MANAGEABLE, "manageable" }, { KIND_DIAGNOSTIC, "diagnostic" }, + { KIND_EXPERIMENTAL, "experimental" }, + { KIND_COMMERCIAL, "commercial" }, { KIND_NOT_PRODUCT, "notproduct" }, { KIND_DEVELOP, "develop" }, { KIND_LP64_PRODUCT, "lp64_product" }, diff --git a/hotspot/src/share/vm/runtime/globals.hpp b/hotspot/src/share/vm/runtime/globals.hpp index 2fe5420be39..4967eadd076 100644 --- a/hotspot/src/share/vm/runtime/globals.hpp +++ b/hotspot/src/share/vm/runtime/globals.hpp @@ -2954,6 +2954,9 @@ class CommandLineFlags { product(intx, MaxRecursiveInlineLevel, 1, \ "maximum number of nested recursive calls that are inlined") \ \ + develop(intx, MaxForceInlineLevel, 100, \ + "maximum number of nested @ForceInline calls that are inlined") \ + \ product_pd(intx, InlineSmallCode, \ "Only inline already compiled methods if their code size is " \ "less than this") \ @@ -3019,9 +3022,6 @@ class CommandLineFlags { notproduct(intx, ZombieALotInterval, 5, \ "Number of exits until ZombieALot kicks in") \ \ - develop(bool, StressNonEntrant, false, \ - "Mark nmethods non-entrant at registration") \ - \ diagnostic(intx, MallocVerifyInterval, 0, \ "If non-zero, verify C heap after every N calls to " \ "malloc/realloc/free") \ @@ -3289,7 +3289,7 @@ class CommandLineFlags { "Exit the VM if we fill the code cache") \ \ product(bool, UseCodeCacheFlushing, true, \ - "Attempt to clean the code cache before shutting off compiler") \ + "Remove cold/old nmethods from the code cache") \ \ /* interpreter debugging */ \ develop(intx, BinarySwitchThreshold, 5, \ @@ -3622,9 +3622,6 @@ class CommandLineFlags { "Temporary flag for transition to AbstractMethodError wrapped " \ "in InvocationTargetException. See 6531596") \ \ - develop(bool, VerifyLambdaBytecodes, false, \ - "Force verification of jdk 8 lambda metafactory bytecodes") \ - \ develop(intx, FastSuperclassLimit, 8, \ "Depth of hardwired instanceof accelerator array") \ \ diff --git a/hotspot/src/share/vm/runtime/reflection.cpp b/hotspot/src/share/vm/runtime/reflection.cpp index be29fdecfcf..0a51b097e11 100644 --- a/hotspot/src/share/vm/runtime/reflection.cpp +++ b/hotspot/src/share/vm/runtime/reflection.cpp @@ -470,12 +470,6 @@ bool Reflection::verify_class_access(Klass* current_class, Klass* new_class, boo return true; } - // Also allow all accesses from - // java/lang/invoke/MagicLambdaImpl subclasses to succeed trivially. - if (current_class->is_subclass_of(SystemDictionary::lambda_MagicLambdaImpl_klass())) { - return true; - } - return can_relax_access_check_for(current_class, new_class, classloader_only); } @@ -570,12 +564,6 @@ bool Reflection::verify_field_access(Klass* current_class, return true; } - // Also allow all accesses from - // java/lang/invoke/MagicLambdaImpl subclasses to succeed trivially. - if (current_class->is_subclass_of(SystemDictionary::lambda_MagicLambdaImpl_klass())) { - return true; - } - return can_relax_access_check_for( current_class, field_class, classloader_only); } diff --git a/hotspot/src/share/vm/runtime/sharedRuntime.cpp b/hotspot/src/share/vm/runtime/sharedRuntime.cpp index f0a332a0055..d963c352078 100644 --- a/hotspot/src/share/vm/runtime/sharedRuntime.cpp +++ b/hotspot/src/share/vm/runtime/sharedRuntime.cpp @@ -84,6 +84,7 @@ // Shared stub locations RuntimeStub* SharedRuntime::_wrong_method_blob; +RuntimeStub* SharedRuntime::_wrong_method_abstract_blob; RuntimeStub* SharedRuntime::_ic_miss_blob; RuntimeStub* SharedRuntime::_resolve_opt_virtual_call_blob; RuntimeStub* SharedRuntime::_resolve_virtual_call_blob; @@ -101,11 +102,12 @@ UncommonTrapBlob* SharedRuntime::_uncommon_trap_blob; //----------------------------generate_stubs----------------------------------- void SharedRuntime::generate_stubs() { - _wrong_method_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::handle_wrong_method), "wrong_method_stub"); - _ic_miss_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::handle_wrong_method_ic_miss), "ic_miss_stub"); - _resolve_opt_virtual_call_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::resolve_opt_virtual_call_C), "resolve_opt_virtual_call"); - _resolve_virtual_call_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::resolve_virtual_call_C), "resolve_virtual_call"); - _resolve_static_call_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::resolve_static_call_C), "resolve_static_call"); + _wrong_method_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::handle_wrong_method), "wrong_method_stub"); + _wrong_method_abstract_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::handle_wrong_method_abstract), "wrong_method_abstract_stub"); + _ic_miss_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::handle_wrong_method_ic_miss), "ic_miss_stub"); + _resolve_opt_virtual_call_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::resolve_opt_virtual_call_C), "resolve_opt_virtual_call"); + _resolve_virtual_call_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::resolve_virtual_call_C), "resolve_virtual_call"); + _resolve_static_call_blob = generate_resolve_blob(CAST_FROM_FN_PTR(address, SharedRuntime::resolve_static_call_C), "resolve_static_call"); #ifdef COMPILER2 // Vectors are generated only by C2. @@ -1345,6 +1347,11 @@ JRT_BLOCK_ENTRY(address, SharedRuntime::handle_wrong_method(JavaThread* thread)) return callee_method->verified_code_entry(); JRT_END +// Handle abstract method call +JRT_BLOCK_ENTRY(address, SharedRuntime::handle_wrong_method_abstract(JavaThread* thread)) + return StubRoutines::throw_AbstractMethodError_entry(); +JRT_END + // resolve a static call and patch code JRT_BLOCK_ENTRY(address, SharedRuntime::resolve_static_call_C(JavaThread *thread )) @@ -2341,12 +2348,13 @@ void AdapterHandlerLibrary::initialize() { // Create a special handler for abstract methods. Abstract methods // are never compiled so an i2c entry is somewhat meaningless, but - // fill it in with something appropriate just in case. Pass handle - // wrong method for the c2i transitions. - address wrong_method = SharedRuntime::get_handle_wrong_method_stub(); + // throw AbstractMethodError just in case. + // Pass wrong_method_abstract for the c2i transitions to return + // AbstractMethodError for invalid invocations. + address wrong_method_abstract = SharedRuntime::get_handle_wrong_method_abstract_stub(); _abstract_method_handler = AdapterHandlerLibrary::new_entry(new AdapterFingerPrint(0, NULL), StubRoutines::throw_AbstractMethodError_entry(), - wrong_method, wrong_method); + wrong_method_abstract, wrong_method_abstract); } AdapterHandlerEntry* AdapterHandlerLibrary::new_entry(AdapterFingerPrint* fingerprint, diff --git a/hotspot/src/share/vm/runtime/sharedRuntime.hpp b/hotspot/src/share/vm/runtime/sharedRuntime.hpp index a7f0d92a1fb..9641bbc7dd4 100644 --- a/hotspot/src/share/vm/runtime/sharedRuntime.hpp +++ b/hotspot/src/share/vm/runtime/sharedRuntime.hpp @@ -56,6 +56,7 @@ class SharedRuntime: AllStatic { // Shared stub locations static RuntimeStub* _wrong_method_blob; + static RuntimeStub* _wrong_method_abstract_blob; static RuntimeStub* _ic_miss_blob; static RuntimeStub* _resolve_opt_virtual_call_blob; static RuntimeStub* _resolve_virtual_call_blob; @@ -206,6 +207,11 @@ class SharedRuntime: AllStatic { return _wrong_method_blob->entry_point(); } + static address get_handle_wrong_method_abstract_stub() { + assert(_wrong_method_abstract_blob!= NULL, "oops"); + return _wrong_method_abstract_blob->entry_point(); + } + #ifdef COMPILER2 static void generate_uncommon_trap_blob(void); static UncommonTrapBlob* uncommon_trap_blob() { return _uncommon_trap_blob; } @@ -481,6 +487,7 @@ class SharedRuntime: AllStatic { // handle ic miss with caller being compiled code // wrong method handling (inline cache misses, zombie methods) static address handle_wrong_method(JavaThread* thread); + static address handle_wrong_method_abstract(JavaThread* thread); static address handle_wrong_method_ic_miss(JavaThread* thread); #ifndef PRODUCT diff --git a/hotspot/src/share/vm/runtime/sweeper.cpp b/hotspot/src/share/vm/runtime/sweeper.cpp index eab7636fac1..b1eba6798f6 100644 --- a/hotspot/src/share/vm/runtime/sweeper.cpp +++ b/hotspot/src/share/vm/runtime/sweeper.cpp @@ -112,14 +112,13 @@ void NMethodSweeper::record_sweep(nmethod* nm, int line) { if (_records != NULL) { _records[_sweep_index].traversal = _traversals; _records[_sweep_index].traversal_mark = nm->_stack_traversal_mark; - _records[_sweep_index].invocation = _invocations; + _records[_sweep_index].invocation = _sweep_fractions_left; _records[_sweep_index].compile_id = nm->compile_id(); _records[_sweep_index].kind = nm->compile_kind(); _records[_sweep_index].state = nm->_state; _records[_sweep_index].vep = nm->verified_entry_point(); _records[_sweep_index].uep = nm->entry_point(); _records[_sweep_index].line = line; - _sweep_index = (_sweep_index + 1) % SweeperLogEntries; } } @@ -127,26 +126,29 @@ void NMethodSweeper::record_sweep(nmethod* nm, int line) { #define SWEEP(nm) #endif -nmethod* NMethodSweeper::_current = NULL; // Current nmethod -long NMethodSweeper::_traversals = 0; // Nof. stack traversals performed -int NMethodSweeper::_seen = 0; // Nof. nmethods we have currently processed in current pass of CodeCache -int NMethodSweeper::_flushed_count = 0; // Nof. nmethods flushed in current sweep -int NMethodSweeper::_zombified_count = 0; // Nof. nmethods made zombie in current sweep -int NMethodSweeper::_marked_count = 0; // Nof. nmethods marked for reclaim in current sweep +nmethod* NMethodSweeper::_current = NULL; // Current nmethod +long NMethodSweeper::_traversals = 0; // Stack scan count, also sweep ID. +long NMethodSweeper::_time_counter = 0; // Virtual time used to periodically invoke sweeper +long NMethodSweeper::_last_sweep = 0; // Value of _time_counter when the last sweep happened +int NMethodSweeper::_seen = 0; // Nof. nmethod we have currently processed in current pass of CodeCache +int NMethodSweeper::_flushed_count = 0; // Nof. nmethods flushed in current sweep +int NMethodSweeper::_zombified_count = 0; // Nof. nmethods made zombie in current sweep +int NMethodSweeper::_marked_for_reclamation_count = 0; // Nof. nmethods marked for reclaim in current sweep -volatile int NMethodSweeper::_invocations = 0; // Nof. invocations left until we are completed with this pass -volatile int NMethodSweeper::_sweep_started = 0; // Whether a sweep is in progress. +volatile bool NMethodSweeper::_should_sweep = true; // Indicates if we should invoke the sweeper +volatile int NMethodSweeper::_sweep_fractions_left = 0; // Nof. invocations left until we are completed with this pass +volatile int NMethodSweeper::_sweep_started = 0; // Flag to control conc sweeper +volatile int NMethodSweeper::_bytes_changed = 0; // Counts the total nmethod size if the nmethod changed from: + // 1) alive -> not_entrant + // 2) not_entrant -> zombie + // 3) zombie -> marked_for_reclamation -jint NMethodSweeper::_locked_seen = 0; -jint NMethodSweeper::_not_entrant_seen_on_stack = 0; -bool NMethodSweeper::_request_mark_phase = false; - -int NMethodSweeper::_total_nof_methods_reclaimed = 0; -jlong NMethodSweeper::_total_time_sweeping = 0; -jlong NMethodSweeper::_total_time_this_sweep = 0; -jlong NMethodSweeper::_peak_sweep_time = 0; -jlong NMethodSweeper::_peak_sweep_fraction_time = 0; -int NMethodSweeper::_hotness_counter_reset_val = 0; +int NMethodSweeper::_total_nof_methods_reclaimed = 0; // Accumulated nof methods flushed +jlong NMethodSweeper::_total_time_sweeping = 0; // Accumulated time sweeping +jlong NMethodSweeper::_total_time_this_sweep = 0; // Total time this sweep +jlong NMethodSweeper::_peak_sweep_time = 0; // Peak time for a full sweep +jlong NMethodSweeper::_peak_sweep_fraction_time = 0; // Peak time sweeping one fraction +int NMethodSweeper::_hotness_counter_reset_val = 0; class MarkActivationClosure: public CodeBlobClosure { @@ -197,13 +199,16 @@ void NMethodSweeper::mark_active_nmethods() { return; } + // Increase time so that we can estimate when to invoke the sweeper again. + _time_counter++; + // Check for restart assert(CodeCache::find_blob_unsafe(_current) == _current, "Sweeper nmethod cached state invalid"); - if (!sweep_in_progress() && need_marking_phase()) { - _seen = 0; - _invocations = NmethodSweepFraction; - _current = CodeCache::first_nmethod(); - _traversals += 1; + if (!sweep_in_progress()) { + _seen = 0; + _sweep_fractions_left = NmethodSweepFraction; + _current = CodeCache::first_nmethod(); + _traversals += 1; _total_time_this_sweep = 0; if (PrintMethodFlushing) { @@ -211,10 +216,6 @@ void NMethodSweeper::mark_active_nmethods() { } Threads::nmethods_do(&mark_activation_closure); - // reset the flags since we started a scan from the beginning. - reset_nmethod_marking(); - _locked_seen = 0; - _not_entrant_seen_on_stack = 0; } else { // Only set hotness counter Threads::nmethods_do(&set_hotness_closure); @@ -222,14 +223,49 @@ void NMethodSweeper::mark_active_nmethods() { OrderAccess::storestore(); } - +/** + * This function invokes the sweeper if at least one of the three conditions is met: + * (1) The code cache is getting full + * (2) There are sufficient state changes in/since the last sweep. + * (3) We have not been sweeping for 'some time' + */ void NMethodSweeper::possibly_sweep() { assert(JavaThread::current()->thread_state() == _thread_in_vm, "must run in vm mode"); - if (!MethodFlushing || !sweep_in_progress()) { + // Only compiler threads are allowed to sweep + if (!MethodFlushing || !sweep_in_progress() || !Thread::current()->is_Compiler_thread()) { return; } - if (_invocations > 0) { + // If there was no state change while nmethod sweeping, 'should_sweep' will be false. + // This is one of the two places where should_sweep can be set to true. The general + // idea is as follows: If there is enough free space in the code cache, there is no + // need to invoke the sweeper. The following formula (which determines whether to invoke + // the sweeper or not) depends on the assumption that for larger ReservedCodeCacheSizes + // we need less frequent sweeps than for smaller ReservedCodecCacheSizes. Furthermore, + // the formula considers how much space in the code cache is currently used. Here are + // some examples that will (hopefully) help in understanding. + // + // Small ReservedCodeCacheSizes: (e.g., < 16M) We invoke the sweeper every time, since + // the result of the division is 0. This + // keeps the used code cache size small + // (important for embedded Java) + // Large ReservedCodeCacheSize : (e.g., 256M + code cache is 10% full). The formula + // computes: (256 / 16) - 1 = 15 + // As a result, we invoke the sweeper after + // 15 invocations of 'mark_active_nmethods. + // Large ReservedCodeCacheSize: (e.g., 256M + code Cache is 90% full). The formula + // computes: (256 / 16) - 10 = 6. + if (!_should_sweep) { + int time_since_last_sweep = _time_counter - _last_sweep; + double wait_until_next_sweep = (ReservedCodeCacheSize / (16 * M)) - time_since_last_sweep - + CodeCache::reverse_free_ratio(); + + if ((wait_until_next_sweep <= 0.0) || !CompileBroker::should_compile_new_jobs()) { + _should_sweep = true; + } + } + + if (_should_sweep && _sweep_fractions_left > 0) { // Only one thread at a time will sweep jint old = Atomic::cmpxchg( 1, &_sweep_started, 0 ); if (old != 0) { @@ -242,31 +278,46 @@ void NMethodSweeper::possibly_sweep() { memset(_records, 0, sizeof(SweeperRecord) * SweeperLogEntries); } #endif - if (_invocations > 0) { + + if (_sweep_fractions_left > 0) { sweep_code_cache(); - _invocations--; + _sweep_fractions_left--; + } + + // We are done with sweeping the code cache once. + if (_sweep_fractions_left == 0) { + _last_sweep = _time_counter; + // Reset flag; temporarily disables sweeper + _should_sweep = false; + // If there was enough state change, 'possibly_enable_sweeper()' + // sets '_should_sweep' to true + possibly_enable_sweeper(); + // Reset _bytes_changed only if there was enough state change. _bytes_changed + // can further increase by calls to 'report_state_change'. + if (_should_sweep) { + _bytes_changed = 0; + } } _sweep_started = 0; } } void NMethodSweeper::sweep_code_cache() { - jlong sweep_start_counter = os::elapsed_counter(); - _flushed_count = 0; - _zombified_count = 0; - _marked_count = 0; + _flushed_count = 0; + _zombified_count = 0; + _marked_for_reclamation_count = 0; if (PrintMethodFlushing && Verbose) { - tty->print_cr("### Sweep at %d out of %d. Invocations left: %d", _seen, CodeCache::nof_nmethods(), _invocations); + tty->print_cr("### Sweep at %d out of %d. Invocations left: %d", _seen, CodeCache::nof_nmethods(), _sweep_fractions_left); } if (!CompileBroker::should_compile_new_jobs()) { // If we have turned off compilations we might as well do full sweeps // in order to reach the clean state faster. Otherwise the sleeping compiler // threads will slow down sweeping. - _invocations = 1; + _sweep_fractions_left = 1; } // We want to visit all nmethods after NmethodSweepFraction @@ -274,7 +325,7 @@ void NMethodSweeper::sweep_code_cache() { // remaining number of invocations. This is only an estimate since // the number of nmethods changes during the sweep so the final // stage must iterate until it there are no more nmethods. - int todo = (CodeCache::nof_nmethods() - _seen) / _invocations; + int todo = (CodeCache::nof_nmethods() - _seen) / _sweep_fractions_left; int swept_count = 0; @@ -286,11 +337,11 @@ void NMethodSweeper::sweep_code_cache() { MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag); // The last invocation iterates until there are no more nmethods - for (int i = 0; (i < todo || _invocations == 1) && _current != NULL; i++) { + for (int i = 0; (i < todo || _sweep_fractions_left == 1) && _current != NULL; i++) { swept_count++; if (SafepointSynchronize::is_synchronizing()) { // Safepoint request if (PrintMethodFlushing && Verbose) { - tty->print_cr("### Sweep at %d out of %d, invocation: %d, yielding to safepoint", _seen, CodeCache::nof_nmethods(), _invocations); + tty->print_cr("### Sweep at %d out of %d, invocation: %d, yielding to safepoint", _seen, CodeCache::nof_nmethods(), _sweep_fractions_left); } MutexUnlockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag); @@ -314,19 +365,7 @@ void NMethodSweeper::sweep_code_cache() { } } - assert(_invocations > 1 || _current == NULL, "must have scanned the whole cache"); - - if (!sweep_in_progress() && !need_marking_phase() && (_locked_seen || _not_entrant_seen_on_stack)) { - // we've completed a scan without making progress but there were - // nmethods we were unable to process either because they were - // locked or were still on stack. We don't have to aggressively - // clean them up so just stop scanning. We could scan once more - // but that complicates the control logic and it's unlikely to - // matter much. - if (PrintMethodFlushing) { - tty->print_cr("### Couldn't make progress on some nmethods so stopping sweep"); - } - } + assert(_sweep_fractions_left > 1 || _current == NULL, "must have scanned the whole cache"); jlong sweep_end_counter = os::elapsed_counter(); jlong sweep_time = sweep_end_counter - sweep_start_counter; @@ -340,21 +379,21 @@ void NMethodSweeper::sweep_code_cache() { event.set_starttime(sweep_start_counter); event.set_endtime(sweep_end_counter); event.set_sweepIndex(_traversals); - event.set_sweepFractionIndex(NmethodSweepFraction - _invocations + 1); + event.set_sweepFractionIndex(NmethodSweepFraction - _sweep_fractions_left + 1); event.set_sweptCount(swept_count); event.set_flushedCount(_flushed_count); - event.set_markedCount(_marked_count); + event.set_markedCount(_marked_for_reclamation_count); event.set_zombifiedCount(_zombified_count); event.commit(); } #ifdef ASSERT if(PrintMethodFlushing) { - tty->print_cr("### sweeper: sweep time(%d): " INT64_FORMAT, _invocations, (jlong)sweep_time); + tty->print_cr("### sweeper: sweep time(%d): " INT64_FORMAT, _sweep_fractions_left, (jlong)sweep_time); } #endif - if (_invocations == 1) { + if (_sweep_fractions_left == 1) { _peak_sweep_time = MAX2(_peak_sweep_time, _total_time_this_sweep); log_sweep("finished"); } @@ -368,12 +407,37 @@ void NMethodSweeper::sweep_code_cache() { // it only makes sense to re-enable compilation if we have actually freed memory. // Note that typically several kB are released for sweeping 16MB of the code // cache. As a result, 'freed_memory' > 0 to restart the compiler. - if (UseCodeCacheFlushing && (!CompileBroker::should_compile_new_jobs() && (freed_memory > 0))) { + if (!CompileBroker::should_compile_new_jobs() && (freed_memory > 0)) { CompileBroker::set_should_compile_new_jobs(CompileBroker::run_compilation); log_sweep("restart_compiler"); } } +/** + * This function updates the sweeper statistics that keep track of nmethods + * state changes. If there is 'enough' state change, the sweeper is invoked + * as soon as possible. There can be data races on _bytes_changed. The data + * races are benign, since it does not matter if we loose a couple of bytes. + * In the worst case we call the sweeper a little later. Also, we are guaranteed + * to invoke the sweeper if the code cache gets full. + */ +void NMethodSweeper::report_state_change(nmethod* nm) { + _bytes_changed += nm->total_size(); + possibly_enable_sweeper(); +} + +/** + * Function determines if there was 'enough' state change in the code cache to invoke + * the sweeper again. Currently, we determine 'enough' as more than 1% state change in + * the code cache since the last sweep. + */ +void NMethodSweeper::possibly_enable_sweeper() { + double percent_changed = ((double)_bytes_changed / (double)ReservedCodeCacheSize) * 100; + if (percent_changed > 1.0) { + _should_sweep = true; + } +} + class NMethodMarker: public StackObj { private: CompilerThread* _thread; @@ -424,9 +488,6 @@ int NMethodSweeper::process_nmethod(nmethod *nm) { MutexLocker cl(CompiledIC_lock); nm->cleanup_inline_caches(); SWEEP(nm); - } else { - _locked_seen++; - SWEEP(nm); } return freed_memory; } @@ -448,8 +509,9 @@ int NMethodSweeper::process_nmethod(nmethod *nm) { tty->print_cr("### Nmethod %3d/" PTR_FORMAT " (zombie) being marked for reclamation", nm->compile_id(), nm); } nm->mark_for_reclamation(); - request_nmethod_marking(); - _marked_count++; + // Keep track of code cache state change + _bytes_changed += nm->total_size(); + _marked_for_reclamation_count++; SWEEP(nm); } } else if (nm->is_not_entrant()) { @@ -459,18 +521,14 @@ int NMethodSweeper::process_nmethod(nmethod *nm) { if (PrintMethodFlushing && Verbose) { tty->print_cr("### Nmethod %3d/" PTR_FORMAT " (not entrant) being made zombie", nm->compile_id(), nm); } + // Code cache state change is tracked in make_zombie() nm->make_zombie(); - request_nmethod_marking(); _zombified_count++; SWEEP(nm); } else { // Still alive, clean up its inline caches MutexLocker cl(CompiledIC_lock); nm->cleanup_inline_caches(); - // we coudn't transition this nmethod so don't immediately - // request a rescan. If this method stays on the stack for a - // long time we don't want to keep rescanning the code cache. - _not_entrant_seen_on_stack++; SWEEP(nm); } } else if (nm->is_unloaded()) { @@ -485,8 +543,8 @@ int NMethodSweeper::process_nmethod(nmethod *nm) { release_nmethod(nm); _flushed_count++; } else { + // Code cache state change is tracked in make_zombie() nm->make_zombie(); - request_nmethod_marking(); _zombified_count++; SWEEP(nm); } @@ -514,7 +572,11 @@ int NMethodSweeper::process_nmethod(nmethod *nm) { // The second condition ensures that methods are not immediately made not-entrant // after compilation. nm->make_not_entrant(); - request_nmethod_marking(); + // Code cache state change is tracked in make_not_entrant() + if (PrintMethodFlushing && Verbose) { + tty->print_cr("### Nmethod %d/" PTR_FORMAT "made not-entrant: hotness counter %d/%d threshold %f", + nm->compile_id(), nm, nm->hotness_counter(), reset_val, threshold); + } } } } diff --git a/hotspot/src/share/vm/runtime/sweeper.hpp b/hotspot/src/share/vm/runtime/sweeper.hpp index bd351760769..83040c72c4b 100644 --- a/hotspot/src/share/vm/runtime/sweeper.hpp +++ b/hotspot/src/share/vm/runtime/sweeper.hpp @@ -53,22 +53,22 @@ // is full. class NMethodSweeper : public AllStatic { - static long _traversals; // Stack scan count, also sweep ID. - static nmethod* _current; // Current nmethod - static int _seen; // Nof. nmethod we have currently processed in current pass of CodeCache - static int _flushed_count; // Nof. nmethods flushed in current sweep - static int _zombified_count; // Nof. nmethods made zombie in current sweep - static int _marked_count; // Nof. nmethods marked for reclaim in current sweep - - static volatile int _invocations; // No. of invocations left until we are completed with this pass - static volatile int _sweep_started; // Flag to control conc sweeper - - //The following are reset in mark_active_nmethods and synchronized by the safepoint - static bool _request_mark_phase; // Indicates that a change has happend and we need another mark pahse, - // always checked and reset at a safepoint so memory will be in sync. - static int _locked_seen; // Number of locked nmethods encountered during the scan - static int _not_entrant_seen_on_stack; // Number of not entrant nmethod were are still on stack + static long _traversals; // Stack scan count, also sweep ID. + static long _time_counter; // Virtual time used to periodically invoke sweeper + static long _last_sweep; // Value of _time_counter when the last sweep happened + static nmethod* _current; // Current nmethod + static int _seen; // Nof. nmethod we have currently processed in current pass of CodeCache + static int _flushed_count; // Nof. nmethods flushed in current sweep + static int _zombified_count; // Nof. nmethods made zombie in current sweep + static int _marked_for_reclamation_count; // Nof. nmethods marked for reclaim in current sweep + static volatile int _sweep_fractions_left; // Nof. invocations left until we are completed with this pass + static volatile int _sweep_started; // Flag to control conc sweeper + static volatile bool _should_sweep; // Indicates if we should invoke the sweeper + static volatile int _bytes_changed; // Counts the total nmethod size if the nmethod changed from: + // 1) alive -> not_entrant + // 2) not_entrant -> zombie + // 3) zombie -> marked_for_reclamation // Stat counters static int _total_nof_methods_reclaimed; // Accumulated nof methods flushed static jlong _total_time_sweeping; // Accumulated time sweeping @@ -81,9 +81,6 @@ class NMethodSweeper : public AllStatic { static bool sweep_in_progress(); static void sweep_code_cache(); - static void request_nmethod_marking() { _request_mark_phase = true; } - static void reset_nmethod_marking() { _request_mark_phase = false; } - static bool need_marking_phase() { return _request_mark_phase; } static int _hotness_counter_reset_val; @@ -109,13 +106,8 @@ class NMethodSweeper : public AllStatic { static int sort_nmethods_by_hotness(nmethod** nm1, nmethod** nm2); static int hotness_counter_reset_val(); - - static void notify() { - // Request a new sweep of the code cache from the beginning. No - // need to synchronize the setting of this flag since it only - // changes to false at safepoint so we can never overwrite it with false. - request_nmethod_marking(); - } + static void report_state_change(nmethod* nm); + static void possibly_enable_sweeper(); }; #endif // SHARE_VM_RUNTIME_SWEEPER_HPP diff --git a/hotspot/src/share/vm/services/threadService.cpp b/hotspot/src/share/vm/services/threadService.cpp index 222ae383cd1..3295580bd5d 100644 --- a/hotspot/src/share/vm/services/threadService.cpp +++ b/hotspot/src/share/vm/services/threadService.cpp @@ -200,6 +200,12 @@ void ThreadService::oops_do(OopClosure* f) { } } +void ThreadService::metadata_do(void f(Metadata*)) { + for (ThreadDumpResult* dump = _threaddump_list; dump != NULL; dump = dump->next()) { + dump->metadata_do(f); + } +} + void ThreadService::add_thread_dump(ThreadDumpResult* dump) { MutexLocker ml(Management_lock); if (_threaddump_list == NULL) { @@ -451,9 +457,16 @@ void ThreadDumpResult::oops_do(OopClosure* f) { } } +void ThreadDumpResult::metadata_do(void f(Metadata*)) { + for (ThreadSnapshot* ts = _snapshots; ts != NULL; ts = ts->next()) { + ts->metadata_do(f); + } +} + StackFrameInfo::StackFrameInfo(javaVFrame* jvf, bool with_lock_info) { _method = jvf->method(); _bci = jvf->bci(); + _class_holder = _method->method_holder()->klass_holder(); _locked_monitors = NULL; if (with_lock_info) { ResourceMark rm; @@ -477,6 +490,11 @@ void StackFrameInfo::oops_do(OopClosure* f) { f->do_oop((oop*) _locked_monitors->adr_at(i)); } } + f->do_oop(&_class_holder); +} + +void StackFrameInfo::metadata_do(void f(Metadata*)) { + f(_method); } void StackFrameInfo::print_on(outputStream* st) const { @@ -620,6 +638,14 @@ void ThreadStackTrace::oops_do(OopClosure* f) { } } +void ThreadStackTrace::metadata_do(void f(Metadata*)) { + int length = _frames->length(); + for (int i = 0; i < length; i++) { + _frames->at(i)->metadata_do(f); + } +} + + ConcurrentLocksDump::~ConcurrentLocksDump() { if (_retain_map_on_free) { return; @@ -823,6 +849,13 @@ void ThreadSnapshot::oops_do(OopClosure* f) { } } +void ThreadSnapshot::metadata_do(void f(Metadata*)) { + if (_stack_trace != NULL) { + _stack_trace->metadata_do(f); + } +} + + DeadlockCycle::DeadlockCycle() { _is_deadlock = false; _threads = new (ResourceObj::C_HEAP, mtInternal) GrowableArray(INITIAL_ARRAY_SIZE, true); diff --git a/hotspot/src/share/vm/services/threadService.hpp b/hotspot/src/share/vm/services/threadService.hpp index 2ae61a70657..9098c0fa9a4 100644 --- a/hotspot/src/share/vm/services/threadService.hpp +++ b/hotspot/src/share/vm/services/threadService.hpp @@ -113,6 +113,7 @@ public: // GC support static void oops_do(OopClosure* f); + static void metadata_do(void f(Metadata*)); }; // Per-thread Statistics for synchronization @@ -242,6 +243,7 @@ public: void dump_stack_at_safepoint(int max_depth, bool with_locked_monitors); void set_concurrent_locks(ThreadConcurrentLocks* l) { _concurrent_locks = l; } void oops_do(OopClosure* f); + void metadata_do(void f(Metadata*)); }; class ThreadStackTrace : public CHeapObj { @@ -265,6 +267,7 @@ class ThreadStackTrace : public CHeapObj { void dump_stack_at_safepoint(int max_depth); Handle allocate_fill_stack_trace_element_array(TRAPS); void oops_do(OopClosure* f); + void metadata_do(void f(Metadata*)); GrowableArray* jni_locked_monitors() { return _jni_locked_monitors; } int num_jni_locked_monitors() { return (_jni_locked_monitors != NULL ? _jni_locked_monitors->length() : 0); } @@ -280,6 +283,9 @@ class StackFrameInfo : public CHeapObj { Method* _method; int _bci; GrowableArray* _locked_monitors; // list of object monitors locked by this frame + // We need to save the mirrors in the backtrace to keep the class + // from being unloaded while we still have this stack trace. + oop _class_holder; public: @@ -289,9 +295,10 @@ class StackFrameInfo : public CHeapObj { delete _locked_monitors; } }; - Method* method() const { return _method; } + Method* method() const { return _method; } int bci() const { return _bci; } void oops_do(OopClosure* f); + void metadata_do(void f(Metadata*)); int num_locked_monitors() { return (_locked_monitors != NULL ? _locked_monitors->length() : 0); } GrowableArray* locked_monitors() { return _locked_monitors; } @@ -354,6 +361,7 @@ class ThreadDumpResult : public StackObj { int num_snapshots() { return _num_snapshots; } ThreadSnapshot* snapshots() { return _snapshots; } void oops_do(OopClosure* f); + void metadata_do(void f(Metadata*)); }; class DeadlockCycle : public CHeapObj { diff --git a/hotspot/src/share/vm/utilities/globalDefinitions.hpp b/hotspot/src/share/vm/utilities/globalDefinitions.hpp index 7806cdc0811..ecb5429c783 100644 --- a/hotspot/src/share/vm/utilities/globalDefinitions.hpp +++ b/hotspot/src/share/vm/utilities/globalDefinitions.hpp @@ -456,6 +456,13 @@ inline void* align_pointer_up(const void* addr, size_t size) { return (void*) align_size_up_((uintptr_t)addr, size); } +// Align down with a lower bound. If the aligning results in 0, return 'alignment'. + +inline size_t align_size_down_bounded(size_t size, size_t alignment) { + size_t aligned_size = align_size_down_(size, alignment); + return aligned_size > 0 ? aligned_size : alignment; +} + // Clamp an address to be within a specific page // 1. If addr is on the page it is returned as is // 2. If addr is above the page_address the start of the *next* page will be returned diff --git a/hotspot/test/compiler/intrinsics/mathexact/GVNTest.java b/hotspot/test/compiler/intrinsics/mathexact/GVNTest.java new file mode 100644 index 00000000000..23fba15d433 --- /dev/null +++ b/hotspot/test/compiler/intrinsics/mathexact/GVNTest.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 8028207 + * @summary Verify that GVN doesn't mess up the two addExacts + * @compile GVNTest.java + * @run main GVNTest + * + */ + +public class GVNTest { + public static int result = 0; + public static int value = 93; + public static void main(String[] args) { + for (int i = 0; i < 50000; ++i) { + result = runTest(value + i); + result = runTest(value + i); + result = runTest(value + i); + result = runTest(value + i); + result = runTest(value + i); + } + } + + public static int runTest(int value) { + int v = value + value; + int sum = 0; + if (v < 4032) { + for (int i = 0; i < 1023; ++i) { + sum += Math.addExact(value, value); + } + } else { + for (int i = 0; i < 321; ++i) { + sum += Math.addExact(value, value); + } + } + return sum + v; + } +} diff --git a/hotspot/test/compiler/intrinsics/mathexact/SplitThruPhiTest.java b/hotspot/test/compiler/intrinsics/mathexact/SplitThruPhiTest.java new file mode 100644 index 00000000000..b3b0c0d7417 --- /dev/null +++ b/hotspot/test/compiler/intrinsics/mathexact/SplitThruPhiTest.java @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 8028198 + * @summary Verify that split through phi does the right thing + * @compile SplitThruPhiTest.java + * @run main SplitThruPhiTest + * + */ + +public class SplitThruPhiTest { + public static volatile int value = 19; + public static int store = 0; + public static void main(String[] args) { + for (int i = 0; i < 150000; ++i) { + store = runTest(value); + } + } + + public static int runTest(int val) { + int result = Math.addExact(val, 1); + int total = 0; + for (int i = val; i < 200; i = Math.addExact(i, 1)) { + total += i; + } + return total; + } +} diff --git a/hotspot/test/compiler/jsr292/ConcurrentClassLoadingTest.java b/hotspot/test/compiler/jsr292/ConcurrentClassLoadingTest.java index 35430c0274d..b87c067a98a 100644 --- a/hotspot/test/compiler/jsr292/ConcurrentClassLoadingTest.java +++ b/hotspot/test/compiler/jsr292/ConcurrentClassLoadingTest.java @@ -172,7 +172,6 @@ public class ConcurrentClassLoadingTest { "java.lang.invoke.LambdaConversionException", "java.lang.invoke.LambdaForm", "java.lang.invoke.LambdaMetafactory", - "java.lang.invoke.MagicLambdaImpl", "java.lang.invoke.MemberName", "java.lang.invoke.MethodHandle", "java.lang.invoke.MethodHandleImpl", diff --git a/hotspot/test/compiler/profiling/TestUnexpectedProfilingMismatch.java b/hotspot/test/compiler/profiling/TestUnexpectedProfilingMismatch.java new file mode 100644 index 00000000000..b118027b5aa --- /dev/null +++ b/hotspot/test/compiler/profiling/TestUnexpectedProfilingMismatch.java @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 8027631 + * @summary profiling of arguments at calls cannot rely on signature of callee for types + * @run main/othervm -XX:-BackgroundCompilation -XX:TieredStopAtLevel=3 -XX:TypeProfileLevel=111 -XX:Tier3InvocationThreshold=200 -XX:Tier0InvokeNotifyFreqLog=7 TestUnexpectedProfilingMismatch + * + */ + +import java.lang.invoke.*; + +public class TestUnexpectedProfilingMismatch { + + static class A { + } + + static class B { + } + + static void mA(A a) { + } + + static void mB(B b) { + } + + static final MethodHandle mhA; + static final MethodHandle mhB; + static { + MethodHandles.Lookup lookup = MethodHandles.lookup(); + MethodType mt = MethodType.methodType(void.class, A.class); + MethodHandle res = null; + try { + res = lookup.findStatic(TestUnexpectedProfilingMismatch.class, "mA", mt); + } catch(NoSuchMethodException ex) { + } catch(IllegalAccessException ex) { + } + mhA = res; + mt = MethodType.methodType(void.class, B.class); + try { + res = lookup.findStatic(TestUnexpectedProfilingMismatch.class, "mB", mt); + } catch(NoSuchMethodException ex) { + } catch(IllegalAccessException ex) { + } + mhB = res; + } + + void m1(A a, boolean doit) throws Throwable { + if (doit) { + mhA.invoke(a); + } + } + + void m2(B b) throws Throwable { + mhB.invoke(b); + } + + static public void main(String[] args) { + TestUnexpectedProfilingMismatch tih = new TestUnexpectedProfilingMismatch(); + A a = new A(); + B b = new B(); + try { + for (int i = 0; i < 256 - 1; i++) { + tih.m1(a, true); + } + // Will trigger the compilation but will also run once + // more interpreted with a non null MDO which it will + // update. Make it skip the body of the method. + tih.m1(a, false); + // Compile this one as well and do the profiling + for (int i = 0; i < 256; i++) { + tih.m2(b); + } + // Will run and see a conflict + tih.m1(a, true); + } catch(Throwable ex) { + ex.printStackTrace(); + } + System.out.println("TEST PASSED"); + } +} diff --git a/langtools/test/tools/javac/diags/examples/InterfaceOrArrayExpected.java b/hotspot/test/compiler/profiling/unloadingconflict/B.java similarity index 89% rename from langtools/test/tools/javac/diags/examples/InterfaceOrArrayExpected.java rename to hotspot/test/compiler/profiling/unloadingconflict/B.java index 4c57562958e..c37eb867648 100644 --- a/langtools/test/tools/javac/diags/examples/InterfaceOrArrayExpected.java +++ b/hotspot/test/compiler/profiling/unloadingconflict/B.java @@ -21,8 +21,5 @@ * questions. */ -// key: compiler.err.intf.or.array.expected.here - -import java.util.List; - -class InterfaceExpected { } +public class B { +} diff --git a/hotspot/test/compiler/profiling/unloadingconflict/TestProfileConflictClassUnloading.java b/hotspot/test/compiler/profiling/unloadingconflict/TestProfileConflictClassUnloading.java new file mode 100644 index 00000000000..c074e18a2a8 --- /dev/null +++ b/hotspot/test/compiler/profiling/unloadingconflict/TestProfileConflictClassUnloading.java @@ -0,0 +1,88 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 8027572 + * @summary class unloading resets profile, method compiled after the profile is first set and before class loading sets unknown bit with not recorded class + * @build B + * @run main/othervm -XX:TypeProfileLevel=222 -XX:-BackgroundCompilation TestProfileConflictClassUnloading + * + */ + +import java.net.MalformedURLException; +import java.net.URL; +import java.net.URLClassLoader; +import java.nio.file.Paths; + +public class TestProfileConflictClassUnloading { + static class A { + } + + + static void m1(Object o) { + } + + static void m2(Object o) { + m1(o); + } + + static void m3(A a, boolean do_call) { + if (!do_call) { + return; + } + m2(a); + } + + public static ClassLoader newClassLoader() { + try { + return new URLClassLoader(new URL[] { + Paths.get(System.getProperty("test.classes",".")).toUri().toURL(), + }, null); + } catch (MalformedURLException e){ + throw new RuntimeException("Unexpected URL conversion failure", e); + } + } + + public static void main(String[] args) throws Exception { + ClassLoader loader = newClassLoader(); + Object o = loader.loadClass("B").newInstance(); + // collect conflicting profiles + for (int i = 0; i < 5000; i++) { + m2(o); + } + // prepare for conflict + A a = new A(); + for (int i = 0; i < 5000; i++) { + m3(a, false); + } + // unload class in profile + o = null; + loader = null; + System.gc(); + // record the conflict + m3(a, true); + // trigger another GC + System.gc(); + } +} diff --git a/hotspot/test/compiler/uncommontrap/TestStackBangRbp.java b/hotspot/test/compiler/uncommontrap/TestStackBangRbp.java new file mode 100644 index 00000000000..38d4e206e01 --- /dev/null +++ b/hotspot/test/compiler/uncommontrap/TestStackBangRbp.java @@ -0,0 +1,294 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @bug 8028308 + * @summary rbp not restored when stack overflow is thrown from deopt/uncommon trap blobs + * @run main/othervm -XX:-BackgroundCompilation -XX:CompileCommand=dontinline,TestStackBangRbp::m1 -XX:CompileCommand=exclude,TestStackBangRbp::m2 -Xss256K -XX:-UseOnStackReplacement TestStackBangRbp + * + */ +public class TestStackBangRbp { + + static class UnloadedClass1 { + } + + static class UnloadedClass2 { + } + + static Object m1(boolean deopt) { + long l0, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, + l13, l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, + l25, l26, l27, l28, l29, l30, l31, l32, l33, l34, l35, l36, + l37, l38, l39, l40, l41, l42, l43, l44, l45, l46, l47, l48, + l49, l50, l51, l52, l53, l54, l55, l56, l57, l58, l59, l60, + l61, l62, l63, l64, l65, l66, l67, l68, l69, l70, l71, l72, + l73, l74, l75, l76, l77, l78, l79, l80, l81, l82, l83, l84, + l85, l86, l87, l88, l89, l90, l91, l92, l93, l94, l95, l96, + l97, l98, l99, l100, l101, l102, l103, l104, l105, l106, l107, + l108, l109, l110, l111, l112, l113, l114, l115, l116, l117, + l118, l119, l120, l121, l122, l123, l124, l125, l126, l127, + l128, l129, l130, l131, l132, l133, l134, l135, l136, l137, + l138, l139, l140, l141, l142, l143, l144, l145, l146, l147, + l148, l149, l150, l151, l152, l153, l154, l155, l156, l157, + l158, l159, l160, l161, l162, l163, l164, l165, l166, l167, + l168, l169, l170, l171, l172, l173, l174, l175, l176, l177, + l178, l179, l180, l181, l182, l183, l184, l185, l186, l187, + l188, l189, l190, l191, l192, l193, l194, l195, l196, l197, + l198, l199, l200, l201, l202, l203, l204, l205, l206, l207, + l208, l209, l210, l211, l212, l213, l214, l215, l216, l217, + l218, l219, l220, l221, l222, l223, l224, l225, l226, l227, + l228, l229, l230, l231, l232, l233, l234, l235, l236, l237, + l238, l239, l240, l241, l242, l243, l244, l245, l246, l247, + l248, l249, l250, l251, l252, l253, l254, l255, l256, l257, + l258, l259, l260, l261, l262, l263, l264, l265, l266, l267, + l268, l269, l270, l271, l272, l273, l274, l275, l276, l277, + l278, l279, l280, l281, l282, l283, l284, l285, l286, l287, + l288, l289, l290, l291, l292, l293, l294, l295, l296, l297, + l298, l299, l300, l301, l302, l303, l304, l305, l306, l307, + l308, l309, l310, l311, l312, l313, l314, l315, l316, l317, + l318, l319, l320, l321, l322, l323, l324, l325, l326, l327, + l328, l329, l330, l331, l332, l333, l334, l335, l336, l337, + l338, l339, l340, l341, l342, l343, l344, l345, l346, l347, + l348, l349, l350, l351, l352, l353, l354, l355, l356, l357, + l358, l359, l360, l361, l362, l363, l364, l365, l366, l367, + l368, l369, l370, l371, l372, l373, l374, l375, l376, l377, + l378, l379, l380, l381, l382, l383, l384, l385, l386, l387, + l388, l389, l390, l391, l392, l393, l394, l395, l396, l397, + l398, l399, l400, l401, l402, l403, l404, l405, l406, l407, + l408, l409, l410, l411, l412, l413, l414, l415, l416, l417, + l418, l419, l420, l421, l422, l423, l424, l425, l426, l427, + l428, l429, l430, l431, l432, l433, l434, l435, l436, l437, + l438, l439, l440, l441, l442, l443, l444, l445, l446, l447, + l448, l449, l450, l451, l452, l453, l454, l455, l456, l457, + l458, l459, l460, l461, l462, l463, l464, l465, l466, l467, + l468, l469, l470, l471, l472, l473, l474, l475, l476, l477, + l478, l479, l480, l481, l482, l483, l484, l485, l486, l487, + l488, l489, l490, l491, l492, l493, l494, l495, l496, l497, + l498, l499, l500, l501, l502, l503, l504, l505, l506, l507, + l508, l509, l510, l511; + + long ll0, ll1, ll2, ll3, ll4, ll5, ll6, ll7, ll8, ll9, ll10, ll11, ll12, + ll13, ll14, ll15, ll16, ll17, ll18, ll19, ll20, ll21, ll22, ll23, ll24, + ll25, ll26, ll27, ll28, ll29, ll30, ll31, ll32, ll33, ll34, ll35, ll36, + ll37, ll38, ll39, ll40, ll41, ll42, ll43, ll44, ll45, ll46, ll47, ll48, + ll49, ll50, ll51, ll52, ll53, ll54, ll55, ll56, ll57, ll58, ll59, ll60, + ll61, ll62, ll63, ll64, ll65, ll66, ll67, ll68, ll69, ll70, ll71, ll72, + ll73, ll74, ll75, ll76, ll77, ll78, ll79, ll80, ll81, ll82, ll83, ll84, + ll85, ll86, ll87, ll88, ll89, ll90, ll91, ll92, ll93, ll94, ll95, ll96, + ll97, ll98, ll99, ll100, ll101, ll102, ll103, ll104, ll105, ll106, ll107, + ll108, ll109, ll110, ll111, ll112, ll113, ll114, ll115, ll116, ll117, + ll118, ll119, ll120, ll121, ll122, ll123, ll124, ll125, ll126, ll127, + ll128, ll129, ll130, ll131, ll132, ll133, ll134, ll135, ll136, ll137, + ll138, ll139, ll140, ll141, ll142, ll143, ll144, ll145, ll146, ll147, + ll148, ll149, ll150, ll151, ll152, ll153, ll154, ll155, ll156, ll157, + ll158, ll159, ll160, ll161, ll162, ll163, ll164, ll165, ll166, ll167, + ll168, ll169, ll170, ll171, ll172, ll173, ll174, ll175, ll176, ll177, + ll178, ll179, ll180, ll181, ll182, ll183, ll184, ll185, ll186, ll187, + ll188, ll189, ll190, ll191, ll192, ll193, ll194, ll195, ll196, ll197, + ll198, ll199, ll200, ll201, ll202, ll203, ll204, ll205, ll206, ll207, + ll208, ll209, ll210, ll211, ll212, ll213, ll214, ll215, ll216, ll217, + ll218, ll219, ll220, ll221, ll222, ll223, ll224, ll225, ll226, ll227, + ll228, ll229, ll230, ll231, ll232, ll233, ll234, ll235, ll236, ll237, + ll238, ll239, ll240, ll241, ll242, ll243, ll244, ll245, ll246, ll247, + ll248, ll249, ll250, ll251, ll252, ll253, ll254, ll255, ll256, ll257, + ll258, ll259, ll260, ll261, ll262, ll263, ll264, ll265, ll266, ll267, + ll268, ll269, ll270, ll271, ll272, ll273, ll274, ll275, ll276, ll277, + ll278, ll279, ll280, ll281, ll282, ll283, ll284, ll285, ll286, ll287, + ll288, ll289, ll290, ll291, ll292, ll293, ll294, ll295, ll296, ll297, + ll298, ll299, ll300, ll301, ll302, ll303, ll304, ll305, ll306, ll307, + ll308, ll309, ll310, ll311, ll312, ll313, ll314, ll315, ll316, ll317, + ll318, ll319, ll320, ll321, ll322, ll323, ll324, ll325, ll326, ll327, + ll328, ll329, ll330, ll331, ll332, ll333, ll334, ll335, ll336, ll337, + ll338, ll339, ll340, ll341, ll342, ll343, ll344, ll345, ll346, ll347, + ll348, ll349, ll350, ll351, ll352, ll353, ll354, ll355, ll356, ll357, + ll358, ll359, ll360, ll361, ll362, ll363, ll364, ll365, ll366, ll367, + ll368, ll369, ll370, ll371, ll372, ll373, ll374, ll375, ll376, ll377, + ll378, ll379, ll380, ll381, ll382, ll383, ll384, ll385, ll386, ll387, + ll388, ll389, ll390, ll391, ll392, ll393, ll394, ll395, ll396, ll397, + ll398, ll399, ll400, ll401, ll402, ll403, ll404, ll405, ll406, ll407, + ll408, ll409, ll410, ll411, ll412, ll413, ll414, ll415, ll416, ll417, + ll418, ll419, ll420, ll421, ll422, ll423, ll424, ll425, ll426, ll427, + ll428, ll429, ll430, ll431, ll432, ll433, ll434, ll435, ll436, ll437, + ll438, ll439, ll440, ll441, ll442, ll443, ll444, ll445, ll446, ll447, + ll448, ll449, ll450, ll451, ll452, ll453, ll454, ll455, ll456, ll457, + ll458, ll459, ll460, ll461, ll462, ll463, ll464, ll465, ll466, ll467, + ll468, ll469, ll470, ll471, ll472, ll473, ll474, ll475, ll476, ll477, + ll478, ll479, ll480, ll481, ll482, ll483, ll484, ll485, ll486, ll487, + ll488, ll489, ll490, ll491, ll492, ll493, ll494, ll495, ll496, ll497, + ll498, ll499, ll500, ll501, ll502, ll503, ll504, ll505, ll506, ll507, + ll508, ll509, ll510, ll511; + + int i1 = TestStackBangRbp.i1; + int i2 = TestStackBangRbp.i2; + int i3 = TestStackBangRbp.i3; + int i4 = TestStackBangRbp.i4; + int i5 = TestStackBangRbp.i5; + int i6 = TestStackBangRbp.i6; + int i7 = TestStackBangRbp.i7; + int i8 = TestStackBangRbp.i8; + int i9 = TestStackBangRbp.i9; + int i10 = TestStackBangRbp.i10; + int i11 = TestStackBangRbp.i11; + int i12 = TestStackBangRbp.i12; + int i13 = TestStackBangRbp.i13; + int i14 = TestStackBangRbp.i14; + int i15 = TestStackBangRbp.i15; + int i16 = TestStackBangRbp.i16; + + TestStackBangRbp.i1 = i1; + TestStackBangRbp.i2 = i2; + TestStackBangRbp.i3 = i3; + TestStackBangRbp.i4 = i4; + TestStackBangRbp.i5 = i5; + TestStackBangRbp.i6 = i6; + TestStackBangRbp.i7 = i7; + TestStackBangRbp.i8 = i8; + TestStackBangRbp.i9 = i9; + TestStackBangRbp.i10 = i10; + TestStackBangRbp.i11 = i11; + TestStackBangRbp.i12 = i12; + TestStackBangRbp.i13 = i13; + TestStackBangRbp.i14 = i14; + TestStackBangRbp.i15 = i15; + TestStackBangRbp.i16 = i16; + + if (deopt) { + // deoptimize with integer in rbp + UnloadedClass1 res = new UnloadedClass1(); // forces deopt with c2 + return res; + } + return null; + } + + static boolean m2(boolean deopt) { + // call m2 recursively until stack overflow. Then call m3 that + // will call m1 and trigger and deopt in m1 while keeping a + // lot of objects live in registers at the call to m1 + + long l0, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, + l13, l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, + l25, l26, l27, l28, l29, l30, l31, l32, l33, l34, l35, l36, + l37, l38, l39, l40, l41, l42, l43, l44, l45, l46, l47, l48, + l49, l50, l51, l52, l53, l54, l55, l56, l57, l58, l59, l60, + l61, l62, l63, l64, l65, l66, l67, l68, l69, l70, l71, l72, + l73, l74, l75, l76, l77, l78, l79, l80, l81, l82, l83, l84, + l85, l86, l87, l88, l89, l90, l91, l92, l93, l94, l95, l96, + l97, l98, l99, l100, l101, l102, l103, l104, l105, l106, l107, + l108, l109, l110, l111, l112, l113, l114, l115, l116, l117, + l118, l119, l120, l121, l122, l123, l124, l125, l126, l127, + l128, l129, l130, l131, l132, l133, l134, l135, l136, l137, + l138, l139, l140, l141, l142, l143, l144, l145, l146, l147, + l148, l149, l150, l151, l152, l153, l154, l155, l156, l157, + l158, l159, l160, l161, l162, l163, l164, l165, l166, l167, + l168, l169, l170, l171, l172, l173, l174, l175, l176, l177, + l178, l179, l180, l181, l182, l183, l184, l185, l186, l187, + l188, l189, l190, l191, l192, l193, l194, l195, l196, l197, + l198, l199, l200, l201, l202, l203, l204, l205, l206, l207, + l208, l209, l210, l211, l212, l213, l214, l215, l216, l217, + l218, l219, l220, l221, l222, l223, l224, l225, l226, l227, + l228, l229, l230, l231, l232, l233, l234, l235, l236, l237, + l238, l239, l240, l241, l242, l243, l244, l245, l246, l247, + l248, l249, l250, l251, l252, l253, l254, l255, l256, l257, + l258, l259, l260, l261, l262, l263, l264, l265, l266, l267, + l268, l269, l270, l271, l272, l273, l274, l275, l276, l277, + l278, l279, l280, l281, l282, l283, l284, l285, l286, l287, + l288, l289, l290, l291, l292, l293, l294, l295, l296, l297, + l298, l299, l300, l301, l302, l303, l304, l305, l306, l307, + l308, l309, l310, l311, l312, l313, l314, l315, l316, l317, + l318, l319, l320, l321, l322, l323, l324, l325, l326, l327, + l328, l329, l330, l331, l332, l333, l334, l335, l336, l337, + l338, l339, l340, l341, l342, l343, l344, l345, l346, l347, + l348, l349, l350, l351, l352, l353, l354, l355, l356, l357, + l358, l359, l360, l361, l362, l363, l364, l365, l366, l367, + l368, l369, l370, l371, l372, l373, l374, l375, l376, l377, + l378, l379, l380, l381, l382, l383, l384, l385, l386, l387, + l388, l389, l390, l391, l392, l393, l394, l395, l396, l397, + l398, l399, l400, l401, l402, l403, l404, l405, l406, l407, + l408, l409, l410, l411, l412, l413, l414, l415, l416, l417, + l418, l419, l420, l421, l422, l423, l424, l425, l426, l427, + l428, l429, l430, l431, l432, l433, l434, l435, l436, l437, + l438, l439, l440, l441, l442, l443, l444, l445, l446, l447, + l448, l449, l450, l451, l452, l453, l454, l455, l456, l457, + l458, l459, l460, l461, l462, l463, l464, l465, l466, l467, + l468, l469, l470, l471, l472, l473, l474, l475, l476, l477, + l478, l479, l480, l481, l482, l483, l484, l485, l486, l487, + l488, l489, l490, l491, l492, l493, l494, l495, l496, l497, + l498, l499, l500, l501, l502, l503, l504, l505, l506, l507, + l508, l509, l510, l511; + + boolean do_m3 = false; + try { + do_m3 = m2(deopt); + } catch (StackOverflowError e) { + return true; + } + if (do_m3) { + m3(deopt); + } + return false; + } + + static volatile Object o1 = new Object(); + + static volatile int i1 = 1; + static volatile int i2 = 2; + static volatile int i3 = 3; + static volatile int i4 = 4; + static volatile int i5 = 5; + static volatile int i6 = 6; + static volatile int i7 = 7; + static volatile int i8 = 8; + static volatile int i9 = 9; + static volatile int i10 = 10; + static volatile int i11 = 11; + static volatile int i12 = 12; + static volatile int i13 = 13; + static volatile int i14 = 14; + static volatile int i15 = 15; + static volatile int i16 = 16; + + static void m3(boolean deopt) { + Object o1 = TestStackBangRbp.o1; + TestStackBangRbp.o1 = o1; + + try { + m1(deopt); + } catch (StackOverflowError e) { + // deoptimize again. rbp holds an integer. It should have an object. + UnloadedClass2 res = new UnloadedClass2(); // forces deopt with c2 + } + TestStackBangRbp.o1 = o1; + } + + static public void main(String[] args) { + // get m1 & m3 compiled + for (int i = 0; i < 20000; i++) { + m1(false); + m3(false); + } + m2(true); + + System.out.println("TEST PASSED"); + } +} diff --git a/hotspot/test/gc/arguments/TestMaxHeapSizeTools.java b/hotspot/test/gc/arguments/TestMaxHeapSizeTools.java index cb7d841355e..0e07f794194 100644 --- a/hotspot/test/gc/arguments/TestMaxHeapSizeTools.java +++ b/hotspot/test/gc/arguments/TestMaxHeapSizeTools.java @@ -64,32 +64,29 @@ class TestMaxHeapSizeTools { long newPlusOldSize = values[0] + values[1]; long smallValue = newPlusOldSize / 2; long largeValue = newPlusOldSize * 2; + long maxHeapSize = largeValue + (2 * 1024 * 1024); // -Xms is not set - checkErgonomics(new String[] { gcflag, "-Xmx16M" }, values, -1, -1); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-XX:InitialHeapSize=" + largeValue }, values, -1, largeValue); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-XX:InitialHeapSize=0" }, values, -1, -1); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize }, values, -1, -1); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-XX:InitialHeapSize=" + smallValue }, values, -1, smallValue); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-XX:InitialHeapSize=" + largeValue }, values, -1, largeValue); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-XX:InitialHeapSize=0" }, values, -1, -1); // -Xms is set to zero - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0" }, values, -1, -1); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0", "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0", "-XX:InitialHeapSize=" + largeValue }, values, -1, largeValue); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0", "-XX:InitialHeapSize=0" }, values, -1, -1); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms0" }, values, -1, -1); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms0", "-XX:InitialHeapSize=" + smallValue }, values, -1, smallValue); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms0", "-XX:InitialHeapSize=" + largeValue }, values, -1, largeValue); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms0", "-XX:InitialHeapSize=0" }, values, -1, -1); // -Xms is set to small value - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue }, values, -1, -1); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue, "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue, "-XX:InitialHeapSize=" + largeValue }, values, smallValue, largeValue); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue, "-XX:InitialHeapSize=0" }, values, smallValue, -1); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms" + smallValue }, values, -1, -1); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms" + smallValue, "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms" + smallValue, "-XX:InitialHeapSize=" + largeValue }, values, smallValue, largeValue); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms" + smallValue, "-XX:InitialHeapSize=0" }, values, smallValue, -1); // -Xms is set to large value - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue }, values, largeValue, largeValue); - // the next case has already been checked elsewhere and gives an error - // checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue, "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue); - // the next case has already been checked elsewhere too - // checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue, "-XX:InitialHeapSize=" + largeValue }, values, values[0], largeValue); - checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue, "-XX:InitialHeapSize=0" }, values, largeValue, -1); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms" + largeValue }, values, largeValue, largeValue); + checkErgonomics(new String[] { gcflag, "-Xmx" + maxHeapSize, "-Xms" + largeValue, "-XX:InitialHeapSize=0" }, values, largeValue, -1); } private static long align_up(long value, long alignment) { diff --git a/hotspot/test/gc/arguments/TestMaxNewSize.java b/hotspot/test/gc/arguments/TestMaxNewSize.java new file mode 100644 index 00000000000..af20cb819e3 --- /dev/null +++ b/hotspot/test/gc/arguments/TestMaxNewSize.java @@ -0,0 +1,122 @@ +/* +* Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. +* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +* +* This code is free software; you can redistribute it and/or modify it +* under the terms of the GNU General Public License version 2 only, as +* published by the Free Software Foundation. +* +* This code is distributed in the hope that it will be useful, but WITHOUT +* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +* version 2 for more details (a copy is included in the LICENSE file that +* accompanied this code). +* +* You should have received a copy of the GNU General Public License version +* 2 along with this work; if not, write to the Free Software Foundation, +* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +* +* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +* or visit www.oracle.com if you need additional information or have any +* questions. +*/ + +/* + * @test TestMaxNewSize + * @key gc + * @bug 7057939 + * @summary Make sure that MaxNewSize always has a useful value after argument + * processing. + * @library /testlibrary + * @build TestMaxNewSize + * @run main TestMaxNewSize -XX:+UseSerialGC + * @run main TestMaxNewSize -XX:+UseParallelGC + * @run main TestMaxNewSize -XX:+UseConcMarkSweepGC + * @run main TestMaxNewSize -XX:+UseG1GC + * @author thomas.schatzl@oracle.com, jesper.wilhelmsson@oracle.com + */ + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import java.math.BigInteger; + +import java.util.ArrayList; +import java.util.Arrays; + +import com.oracle.java.testlibrary.*; + +public class TestMaxNewSize { + + private static void checkMaxNewSize(String[] flags, int heapsize) throws Exception { + BigInteger actual = new BigInteger(getMaxNewSize(flags)); + System.out.println(actual); + if (actual.compareTo(new BigInteger((new Long(heapsize)).toString())) == 1) { + throw new RuntimeException("MaxNewSize value set to \"" + actual + + "\", expected otherwise when running with the following flags: " + Arrays.asList(flags).toString()); + } + } + + private static void checkIncompatibleNewSize(String[] flags) throws Exception { + ArrayList finalargs = new ArrayList(); + finalargs.addAll(Arrays.asList(flags)); + finalargs.add("-version"); + + ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(finalargs.toArray(new String[0])); + OutputAnalyzer output = new OutputAnalyzer(pb.start()); + output.shouldContain("Initial young gen size set larger than the maximum young gen size"); + } + + private static boolean isRunningG1(String[] args) { + for (int i = 0; i < args.length; i++) { + if (args[i].contains("+UseG1GC")) { + return true; + } + } + return false; + } + + private static String getMaxNewSize(String[] flags) throws Exception { + ArrayList finalargs = new ArrayList(); + finalargs.addAll(Arrays.asList(flags)); + if (isRunningG1(flags)) { + finalargs.add("-XX:G1HeapRegionSize=1M"); + } + finalargs.add("-XX:+PrintFlagsFinal"); + finalargs.add("-version"); + + ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(finalargs.toArray(new String[0])); + OutputAnalyzer output = new OutputAnalyzer(pb.start()); + output.shouldHaveExitValue(0); + String stdout = output.getStdout(); + //System.out.println(stdout); + return getFlagValue("MaxNewSize", stdout); + } + + private static String getFlagValue(String flag, String where) { + Matcher m = Pattern.compile(flag + "\\s+:?=\\s+\\d+").matcher(where); + if (!m.find()) { + throw new RuntimeException("Could not find value for flag " + flag + " in output string"); + } + String match = m.group(); + return match.substring(match.lastIndexOf(" ") + 1, match.length()); + } + + public static void main(String args[]) throws Exception { + String gcName = args[0]; + final int M32 = 32 * 1024 * 1024; + final int M64 = 64 * 1024 * 1024; + final int M96 = 96 * 1024 * 1024; + final int M128 = 128 * 1024 * 1024; + checkMaxNewSize(new String[] { gcName, "-Xmx128M" }, M128); + checkMaxNewSize(new String[] { gcName, "-Xmx128M", "-XX:NewRatio=5" }, M128); + checkMaxNewSize(new String[] { gcName, "-Xmx128M", "-XX:NewSize=32M" }, M128); + checkMaxNewSize(new String[] { gcName, "-Xmx128M", "-XX:OldSize=96M" }, M128); + checkMaxNewSize(new String[] { gcName, "-Xmx128M", "-XX:MaxNewSize=32M" }, M32); + checkMaxNewSize(new String[] { gcName, "-Xmx128M", "-XX:NewSize=32M", "-XX:MaxNewSize=32M" }, M32); + checkMaxNewSize(new String[] { gcName, "-Xmx128M", "-XX:NewRatio=6", "-XX:MaxNewSize=32M" }, M32); + checkMaxNewSize(new String[] { gcName, "-Xmx128M", "-Xms96M" }, M128); + checkMaxNewSize(new String[] { gcName, "-Xmx96M", "-Xms96M" }, M96); + checkMaxNewSize(new String[] { gcName, "-XX:NewSize=128M", "-XX:MaxNewSize=50M"}, M128); + } +} diff --git a/hotspot/test/gc/g1/TestHumongousCodeCacheRoots.java b/hotspot/test/gc/g1/TestHumongousCodeCacheRoots.java new file mode 100644 index 00000000000..0d3ad500a87 --- /dev/null +++ b/hotspot/test/gc/g1/TestHumongousCodeCacheRoots.java @@ -0,0 +1,143 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @key regression + * @key gc + * @bug 8027756 + * @library /testlibrary /testlibrary/whitebox + * @build TestHumongousCodeCacheRoots + * @run main ClassFileInstaller sun.hotspot.WhiteBox + * @summary Humongous objects may have references from the code cache + * @run main TestHumongousCodeCacheRoots +*/ + +import com.oracle.java.testlibrary.*; +import sun.hotspot.WhiteBox; + +import java.util.ArrayList; +import java.util.Arrays; + +class TestHumongousCodeCacheRootsHelper { + + static final int n = 1000000; + static final int[] AA = new int[n]; + static final int[] BB = new int[n]; + + public static void main(String args[]) throws Exception { + // do some work so that the compiler compiles this method, inlining the + // reference to the integer array (which is a humonguous object) into + // the code cache. + for(int i = 0; i < n; i++) { + AA[i] = 0; + BB[i] = 0; + } + // trigger a GC that checks that the verification code allows humongous + // objects with code cache roots; objects should be all live here. + System.gc(); + + // deoptimize everyhing: this should make all compiled code zombies. + WhiteBox wb = WhiteBox.getWhiteBox(); + wb.deoptimizeAll(); + + // trigger a GC that checks that the verification code allows humongous + // objects with code cache roots; objects should be all live here. + System.gc(); + + // wait a little for the code cache sweeper to try to clean up zombie nmethods + // and unregister the code roots. + try { Thread.sleep(5000); } catch (InterruptedException ex) { } + + // do some work on the arrays to make sure that they need to be live after the GCs + for(int i = 0; i < n; i++) { + AA[i] = 1; + BB[i] = 10; + } + + System.out.println(); + } +} + +public class TestHumongousCodeCacheRoots { + + /** + * Executes a class in a new VM process with the given parameters. + * @param vmargs Arguments to the VM to run + * @param classname Name of the class to run + * @param arguments Arguments to the class + * @param useTestDotJavaDotOpts Use test.java.opts as part of the VM argument string + * @return The OutputAnalyzer with the results for the invocation. + */ + public static OutputAnalyzer runWhiteBoxTest(String[] vmargs, String classname, String[] arguments, boolean useTestDotJavaDotOpts) throws Exception { + ArrayList finalargs = new ArrayList(); + + String[] whiteboxOpts = new String[] { + "-Xbootclasspath/a:.", + "-XX:+UnlockDiagnosticVMOptions", "-XX:+WhiteBoxAPI", + "-cp", System.getProperty("java.class.path"), + }; + + if (useTestDotJavaDotOpts) { + // System.getProperty("test.java.opts") is '' if no options is set, + // we need to skip such a result + String[] externalVMOpts = new String[0]; + if (System.getProperty("test.java.opts") != null && System.getProperty("test.java.opts").length() != 0) { + externalVMOpts = System.getProperty("test.java.opts").split(" "); + } + finalargs.addAll(Arrays.asList(externalVMOpts)); + } + + finalargs.addAll(Arrays.asList(vmargs)); + finalargs.addAll(Arrays.asList(whiteboxOpts)); + finalargs.add(classname); + finalargs.addAll(Arrays.asList(arguments)); + + ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(finalargs.toArray(new String[0])); + OutputAnalyzer output = new OutputAnalyzer(pb.start()); + output.shouldHaveExitValue(0); + + return output; + } + + public static void runTest(String compiler, String[] other) throws Exception { + ArrayList joined = new ArrayList(); + joined.add(compiler); + joined.addAll(Arrays.asList(other)); + runWhiteBoxTest(joined.toArray(new String[0]), TestHumongousCodeCacheRootsHelper.class.getName(), + new String[] {}, false); + } + + public static void main(String[] args) throws Exception { + final String[] baseArguments = new String[] { + "-XX:+UseG1GC", "-XX:G1HeapRegionSize=1M", "-Xmx100M", // make sure we get a humongous region + "-XX:+UnlockDiagnosticVMOptions", + "-XX:InitiatingHeapOccupancyPercent=1", // strong code root marking + "-XX:+G1VerifyHeapRegionCodeRoots", "-XX:+VerifyAfterGC", // make sure that verification is run + "-XX:NmethodSweepFraction=1", "-XX:NmethodSweepCheckInterval=1", // make the code cache sweep more predictable + }; + runTest("-client", baseArguments); + runTest("-server", baseArguments); + } +} + diff --git a/hotspot/test/runtime/memory/ReadFromNoaccessArea.java b/hotspot/test/runtime/memory/ReadFromNoaccessArea.java new file mode 100644 index 00000000000..1078dd2e4ea --- /dev/null +++ b/hotspot/test/runtime/memory/ReadFromNoaccessArea.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @summary Test that touching noaccess area in class ReservedHeapSpace results in SIGSEGV/ACCESS_VIOLATION + * @library /testlibrary /testlibrary/whitebox + * @build ReadFromNoaccessArea + * @run main ClassFileInstaller sun.hotspot.WhiteBox + * @run main ReadFromNoaccessArea + */ + +import com.oracle.java.testlibrary.*; +import sun.hotspot.WhiteBox; + +public class ReadFromNoaccessArea { + + public static void main(String args[]) throws Exception { + if (!Platform.is64bit()) { + System.out.println("ReadFromNoaccessArea tests is useful only on 64bit architecture. Passing silently."); + return; + } + + ProcessBuilder pb = ProcessTools.createJavaProcessBuilder( + "-Xbootclasspath/a:.", + "-XX:+UnlockDiagnosticVMOptions", + "-XX:+WhiteBoxAPI", + "-XX:+UseCompressedOops", + "-XX:HeapBaseMinAddress=33G", + DummyClassWithMainTryingToReadFromNoaccessArea.class.getName()); + + OutputAnalyzer output = new OutputAnalyzer(pb.start()); + System.out.println("******* Printing stdout for analysis in case of failure *******"); + System.out.println(output.getStdout()); + System.out.println("******* Printing stderr for analysis in case of failure *******"); + System.out.println(output.getStderr()); + System.out.println("***************************************************************"); + if (output.getStdout() != null && output.getStdout().contains("WB_ReadFromNoaccessArea method is useless")) { + // Test conditions broken. There is no protected page in ReservedHeapSpace in these circumstances. Silently passing test. + return; + } + if (Platform.isWindows()) { + output.shouldContain("EXCEPTION_ACCESS_VIOLATION"); + } else if (Platform.isOSX()) { + output.shouldContain("SIGBUS"); + } else { + output.shouldContain("SIGSEGV"); + } + } + + public static class DummyClassWithMainTryingToReadFromNoaccessArea { + + // This method calls whitebox method reading from noaccess area + public static void main(String args[]) throws Exception { + WhiteBox.getWhiteBox().readFromNoaccessArea(); + throw new Exception("Call of readFromNoaccessArea succeeded! This is wrong. Crash expected. Test failed."); + } + } + +} diff --git a/hotspot/test/runtime/memory/RunUnitTestsConcurrently.java b/hotspot/test/runtime/memory/RunUnitTestsConcurrently.java new file mode 100644 index 00000000000..35b855e0af3 --- /dev/null +++ b/hotspot/test/runtime/memory/RunUnitTestsConcurrently.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @summary Test launches unit tests inside vm concurrently + * @library /testlibrary /testlibrary/whitebox + * @build RunUnitTestsConcurrently + * @run main ClassFileInstaller sun.hotspot.WhiteBox + * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions -XX:+WhiteBoxAPI RunUnitTestsConcurrently 30 15000 + */ + +import com.oracle.java.testlibrary.*; +import sun.hotspot.WhiteBox; + +public class RunUnitTestsConcurrently { + + private static WhiteBox wb; + private static long timeout; + private static long timeStamp; + + public static class Worker implements Runnable { + @Override + public void run() { + while (System.currentTimeMillis() - timeStamp < timeout) { + WhiteBox.getWhiteBox().runMemoryUnitTests(); + } + } + } + + public static void main(String[] args) throws InterruptedException { + if (!Platform.isDebugBuild() || !Platform.is64bit()) { + return; + } + wb = WhiteBox.getWhiteBox(); + System.out.println("Starting threads"); + + int threads = Integer.valueOf(args[0]); + timeout = Long.valueOf(args[1]); + + timeStamp = System.currentTimeMillis(); + + Thread[] threadsArray = new Thread[threads]; + for (int i = 0; i < threads; i++) { + threadsArray[i] = new Thread(new Worker()); + threadsArray[i].start(); + } + for (int i = 0; i < threads; i++) { + threadsArray[i].join(); + } + + System.out.println("Quitting test."); + } +} diff --git a/hotspot/test/runtime/memory/StressVirtualSpaceResize.java b/hotspot/test/runtime/memory/StressVirtualSpaceResize.java new file mode 100644 index 00000000000..df978012080 --- /dev/null +++ b/hotspot/test/runtime/memory/StressVirtualSpaceResize.java @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +/* + * @test + * @summary Stress test that expands/shrinks VirtualSpace + * @library /testlibrary /testlibrary/whitebox + * @build StressVirtualSpaceResize + * @run main ClassFileInstaller sun.hotspot.WhiteBox + * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions -XX:+WhiteBoxAPI StressVirtualSpaceResize + */ + +import sun.hotspot.WhiteBox; + +public class StressVirtualSpaceResize { + + public static void main(String args[]) throws Exception { + if (WhiteBox.getWhiteBox().stressVirtualSpaceResize(1000, 0xffffL, 0xffffL) != 0) + throw new RuntimeException("Whitebox method stressVirtualSpaceResize returned non zero exit code"); + } +} diff --git a/hotspot/test/testlibrary/whitebox/sun/hotspot/WhiteBox.java b/hotspot/test/testlibrary/whitebox/sun/hotspot/WhiteBox.java index 091b5f7543b..da1244ce093 100644 --- a/hotspot/test/testlibrary/whitebox/sun/hotspot/WhiteBox.java +++ b/hotspot/test/testlibrary/whitebox/sun/hotspot/WhiteBox.java @@ -144,4 +144,10 @@ public class WhiteBox { // force Full GC public native void fullGC(); + + // Tests on ReservedSpace/VirtualSpace classes + public native int stressVirtualSpaceResize(long reservedSpaceSize, long magnitude, long iterations); + public native void runMemoryUnitTests(); + public native void readFromNoaccessArea(); + } diff --git a/jaxp/.hgtags b/jaxp/.hgtags index 43356fd5d4d..c894b9ce915 100644 --- a/jaxp/.hgtags +++ b/jaxp/.hgtags @@ -237,3 +237,5 @@ c1f9158fbb9c2da50f6946fffd974e8236e08447 jdk8-b112 0046d2278204b7eff76803fc4623cb48c7e6384d jdk8-b113 1b1e12117fe2840e5d21ae9a4b309e4f981f3ea8 jdk8-b114 f610fd46463e6b0533dd92bce11a1e7d84984e64 jdk8-b115 +e757eb9aee3d6bec7da074c47e07616104a8df33 jdk8-b116 +c1d234d4f16472a5163464420fa00b25ffa5298a jdk8-b117 diff --git a/jaxws/.hgtags b/jaxws/.hgtags index cee784b95fa..45cc1bbaea7 100644 --- a/jaxws/.hgtags +++ b/jaxws/.hgtags @@ -237,3 +237,5 @@ dbdd5c76250928582cb5342bcf7b299a6007d538 jdk8-b112 9261f342aa73a79bbd1a817ae72fa72b15ef30bc jdk8-b113 9ad289610fc6effe9076280b7920d0f16470709f jdk8-b114 e126d8eca69b83a1cc159c2375b7c33140346d2b jdk8-b115 +587560c222a2476066852224ed02d39b5090a299 jdk8-b116 +fe56ba456fd32758c72db629938d69067468d89c jdk8-b117 diff --git a/jdk/.hgignore b/jdk/.hgignore index e849b9e6d1f..d8754b13e1f 100644 --- a/jdk/.hgignore +++ b/jdk/.hgignore @@ -1,5 +1,6 @@ ^build/ ^dist/ +^testoutput/ /nbproject/private/ ^make/netbeans/.*/build/ ^make/netbeans/.*/dist/ diff --git a/jdk/.hgtags b/jdk/.hgtags index 0804e08a7d0..2ea9affc5fd 100644 --- a/jdk/.hgtags +++ b/jdk/.hgtags @@ -237,3 +237,5 @@ f002f5f3a16cca62e139cb8eed05ffaeb373587d jdk8-b112 5b4261b4b72af53e8e178933ef6bc6c7f8cdbc60 jdk8-b113 f26a0c8071bde1e3b923713c75156e4a58955623 jdk8-b114 f82b730c798b6bf38946baaba8a7d80fd5efaa70 jdk8-b115 +0dc0067f3b8efb299a4c23f76ee26ea64df9e1d7 jdk8-b116 +fc4ac66aa657e09de5f8257c3174f240ed0cbaf7 jdk8-b117 diff --git a/jdk/make/java/management/mapfile-vers b/jdk/make/java/management/mapfile-vers index 0ea2ab4eb06..1cf52a8c710 100644 --- a/jdk/make/java/management/mapfile-vers +++ b/jdk/make/java/management/mapfile-vers @@ -103,6 +103,7 @@ SUNWprivate_1.1 { Java_sun_management_VMManagementImpl_getSafepointCount; Java_sun_management_VMManagementImpl_getSafepointSyncTime; Java_sun_management_VMManagementImpl_getStartupTime; + Java_sun_management_VMManagementImpl_getUptime0; Java_sun_management_VMManagementImpl_getTotalApplicationNonStoppedTime; Java_sun_management_VMManagementImpl_getTotalClassCount; Java_sun_management_VMManagementImpl_getTotalCompileTime; diff --git a/jdk/make/tools/sharing/classlist.linux b/jdk/make/tools/sharing/classlist.linux index 3d73d7fc731..fe642b27eca 100644 --- a/jdk/make/tools/sharing/classlist.linux +++ b/jdk/make/tools/sharing/classlist.linux @@ -1,2327 +1,2454 @@ -java/lang/Object -java/lang/String -java/io/Serializable -java/lang/Comparable -java/lang/CharSequence -java/lang/Class -java/lang/reflect/GenericDeclaration -java/lang/reflect/Type -java/lang/reflect/AnnotatedElement -java/lang/Cloneable -java/lang/ClassLoader -java/lang/System -java/lang/Throwable -java/lang/Error -java/lang/ThreadDeath -java/lang/Exception -java/lang/RuntimeException -java/security/ProtectionDomain -java/security/AccessControlContext -java/lang/ClassNotFoundException -java/lang/NoClassDefFoundError -java/lang/LinkageError -java/lang/ClassCastException -java/lang/ArrayStoreException -java/lang/VirtualMachineError -java/lang/OutOfMemoryError -java/lang/StackOverflowError -java/lang/IllegalMonitorStateException -java/lang/ref/Reference -java/lang/ref/SoftReference -java/lang/ref/WeakReference -java/lang/ref/FinalReference -java/lang/ref/PhantomReference -java/lang/ref/Finalizer -java/lang/Thread -java/lang/Runnable -java/lang/ThreadGroup -java/lang/Thread$UncaughtExceptionHandler -java/util/Properties -java/util/Hashtable -java/util/Map -java/util/Dictionary -java/lang/reflect/AccessibleObject -java/lang/reflect/Field -java/lang/reflect/Member -java/lang/reflect/Method -java/lang/reflect/Constructor -sun/reflect/MagicAccessorImpl -sun/reflect/MethodAccessorImpl -sun/reflect/MethodAccessor -sun/reflect/ConstructorAccessorImpl -sun/reflect/ConstructorAccessor -sun/reflect/DelegatingClassLoader -sun/reflect/ConstantPool -sun/reflect/UnsafeStaticFieldAccessorImpl -sun/reflect/UnsafeFieldAccessorImpl -sun/reflect/FieldAccessorImpl -sun/reflect/FieldAccessor -java/util/Vector -java/util/List -java/util/Collection -java/lang/Iterable -java/util/RandomAccess -java/util/AbstractList -java/util/AbstractCollection -java/lang/StringBuffer -java/lang/AbstractStringBuilder -java/lang/Appendable -java/lang/StackTraceElement -java/nio/Buffer -java/lang/Boolean -java/lang/Character -java/lang/Float -java/lang/Number -java/lang/Double -java/lang/Byte -java/lang/Short -java/lang/Integer -java/lang/Long -java/lang/NullPointerException -java/lang/ArithmeticException -java/io/ObjectStreamField -java/lang/String$CaseInsensitiveComparator -java/util/Comparator -java/lang/RuntimePermission -java/security/BasicPermission -java/security/Permission -java/security/Guard -sun/misc/SoftCache -java/util/AbstractMap -java/lang/ref/ReferenceQueue -java/lang/ref/ReferenceQueue$Null -java/lang/ref/ReferenceQueue$Lock -java/util/HashMap -java/lang/annotation/Annotation -java/util/HashMap$Entry -java/util/Map$Entry -java/security/AccessController -java/lang/reflect/ReflectPermission -sun/reflect/ReflectionFactory$GetReflectionFactoryAction -java/security/PrivilegedAction -java/util/Stack -sun/reflect/ReflectionFactory -java/lang/ref/Reference$Lock -java/lang/ref/Reference$ReferenceHandler -java/lang/ref/Finalizer$FinalizerThread -java/util/Enumeration -java/util/Iterator -java/util/Hashtable$Entry -java/nio/charset/Charset -sun/nio/cs/StandardCharsets -sun/nio/cs/FastCharsetProvider -java/nio/charset/spi/CharsetProvider -sun/nio/cs/StandardCharsets$Aliases -sun/util/PreHashedMap -sun/nio/cs/StandardCharsets$Classes -sun/nio/cs/StandardCharsets$Cache -java/lang/ThreadLocal -java/util/concurrent/atomic/AtomicInteger -sun/misc/Unsafe -java/lang/NoSuchMethodError -java/lang/IncompatibleClassChangeError -sun/reflect/Reflection -java/util/Collections -java/util/Collections$EmptySet -java/util/AbstractSet -java/util/Set -java/util/Collections$EmptyList -java/util/Collections$EmptyMap -java/util/Collections$ReverseComparator -java/util/Collections$SynchronizedMap -java/lang/Class$3 -java/lang/reflect/Modifier -java/lang/reflect/ReflectAccess -sun/reflect/LangReflectAccess -java/util/Arrays -java/lang/Math -sun/nio/cs/US_ASCII -sun/nio/cs/HistoricallyNamedCharset -sun/misc/VM -java/lang/StringCoding -java/lang/ThreadLocal$ThreadLocalMap -java/lang/ThreadLocal$ThreadLocalMap$Entry -java/lang/StringCoding$StringDecoder -sun/nio/cs/US_ASCII$Decoder -java/nio/charset/CharsetDecoder -java/nio/charset/CodingErrorAction -java/nio/ByteBuffer -java/nio/HeapByteBuffer -java/nio/Bits -java/nio/ByteOrder -java/nio/CharBuffer -java/lang/Readable -java/nio/HeapCharBuffer -java/nio/charset/CoderResult -java/nio/charset/CoderResult$1 -java/nio/charset/CoderResult$Cache -java/nio/charset/CoderResult$2 -sun/misc/Version -java/io/FileInputStream -java/io/InputStream -java/io/Closeable -java/io/FileDescriptor -java/io/FileOutputStream -java/io/OutputStream -java/io/Flushable -java/io/BufferedInputStream -java/io/FilterInputStream -java/util/concurrent/atomic/AtomicReferenceFieldUpdater -java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl -sun/reflect/misc/ReflectUtil -java/io/PrintStream -java/io/FilterOutputStream -java/io/BufferedOutputStream -java/io/OutputStreamWriter -java/io/Writer -sun/nio/cs/StreamEncoder -sun/security/action/GetPropertyAction -sun/nio/cs/US_ASCII$Encoder -java/nio/charset/CharsetEncoder -sun/nio/cs/Surrogate$Parser -sun/nio/cs/Surrogate -java/io/BufferedWriter -java/lang/Runtime -java/io/File -java/io/FileSystem -java/io/UnixFileSystem -java/io/ExpiringCache -java/io/ExpiringCache$1 -java/util/LinkedHashMap -java/util/LinkedHashMap$Entry -java/lang/StringBuilder -sun/misc/SharedSecrets -java/lang/ClassLoader$3 -java/lang/StringCoding$StringEncoder -java/io/ExpiringCache$Entry -java/lang/ClassLoader$NativeLibrary -java/lang/Terminator -java/lang/Terminator$1 -sun/misc/SignalHandler -sun/misc/Signal -sun/misc/NativeSignalHandler -java/io/Console -java/io/Console$1 -sun/misc/JavaIOAccess -java/lang/Shutdown -java/util/ArrayList -java/lang/Shutdown$Lock -java/lang/ApplicationShutdownHooks -java/util/IdentityHashMap -sun/misc/OSEnvironment -java/lang/System$2 -sun/misc/JavaLangAccess -java/lang/Compiler -java/lang/Compiler$1 -sun/misc/Launcher -sun/misc/Launcher$Factory -java/net/URLStreamHandlerFactory -sun/misc/Launcher$ExtClassLoader -java/net/URLClassLoader -java/security/SecureClassLoader -sun/security/util/Debug -java/net/URLClassLoader$7 -sun/misc/JavaNetAccess -java/util/StringTokenizer -sun/misc/Launcher$ExtClassLoader$1 -java/security/PrivilegedExceptionAction -sun/misc/MetaIndex -java/io/BufferedReader -java/io/Reader -java/io/FileReader -java/io/InputStreamReader -sun/nio/cs/StreamDecoder -java/lang/reflect/Array -sun/net/www/ParseUtil -java/util/BitSet -java/io/ObjectStreamClass -java/net/URL -java/util/Locale -java/util/concurrent/ConcurrentHashMap -java/util/concurrent/ConcurrentMap -java/util/concurrent/ConcurrentHashMap$Segment -java/util/concurrent/locks/ReentrantLock -java/util/concurrent/locks/Lock -java/util/concurrent/locks/ReentrantLock$NonfairSync -java/util/concurrent/locks/ReentrantLock$Sync -java/util/concurrent/locks/AbstractQueuedSynchronizer -java/util/concurrent/locks/AbstractOwnableSynchronizer -java/util/concurrent/locks/AbstractQueuedSynchronizer$Node -java/util/concurrent/ConcurrentHashMap$HashEntry -java/lang/CharacterDataLatin1 -java/net/Parts -sun/net/www/protocol/file/Handler -java/net/URLStreamHandler -java/lang/Class$1 -sun/reflect/ReflectionFactory$1 -sun/reflect/NativeConstructorAccessorImpl -sun/reflect/DelegatingConstructorAccessorImpl -java/util/HashSet -sun/misc/URLClassPath -sun/net/www/protocol/jar/Handler -sun/misc/Launcher$AppClassLoader -sun/misc/Launcher$AppClassLoader$1 -java/lang/SystemClassLoaderAction -java/net/URLClassLoader$1 -sun/misc/URLClassPath$3 -sun/misc/URLClassPath$JarLoader -sun/misc/URLClassPath$Loader -java/security/PrivilegedActionException -sun/misc/URLClassPath$FileLoader -sun/misc/URLClassPath$FileLoader$1 -sun/misc/Resource -sun/nio/ByteBuffered -java/security/CodeSource -java/security/Permissions -java/security/PermissionCollection -sun/net/www/protocol/file/FileURLConnection -sun/net/www/URLConnection -java/net/URLConnection -java/net/UnknownContentHandler -java/net/ContentHandler -sun/net/www/MessageHeader -java/io/FilePermission -java/io/FilePermission$1 -sun/security/provider/PolicyFile -java/security/Policy -java/security/Policy$UnsupportedEmptyCollection -java/io/FilePermissionCollection -java/security/AllPermission -java/security/UnresolvedPermission -java/security/BasicPermissionCollection -java/security/Principal -java/security/cert/Certificate -java/util/AbstractList$Itr -java/util/IdentityHashMap$KeySet -java/util/IdentityHashMap$KeyIterator -java/util/IdentityHashMap$IdentityHashMapIterator -java/io/DeleteOnExitHook -java/util/LinkedHashSet -java/util/HashMap$KeySet -java/util/LinkedHashMap$KeyIterator -java/util/LinkedHashMap$LinkedHashIterator -java/awt/Frame -java/awt/MenuContainer -java/awt/Window -javax/accessibility/Accessible -java/awt/Container -java/awt/Component -java/awt/image/ImageObserver -java/lang/InterruptedException -java/awt/Label -java/util/logging/Logger -java/util/logging/Handler -java/util/logging/Level -java/util/logging/LogManager -java/util/logging/LogManager$1 -java/beans/PropertyChangeSupport -java/util/logging/LogManager$LogNode -java/util/logging/LoggingPermission -java/util/logging/LogManager$Cleaner -java/util/logging/LogManager$RootLogger -java/util/logging/LogManager$2 -java/util/Properties$LineReader -java/util/Hashtable$Enumerator -java/beans/PropertyChangeEvent -java/util/EventObject -java/awt/Component$AWTTreeLock -sun/awt/NativeLibLoader -sun/security/action/LoadLibraryAction -java/awt/GraphicsEnvironment -java/awt/GraphicsEnvironment$1 -java/lang/ProcessEnvironment -java/lang/ProcessEnvironment$Variable -java/lang/ProcessEnvironment$ExternalData -java/lang/ProcessEnvironment$Value -java/lang/ProcessEnvironment$StringEnvironment -java/util/Collections$UnmodifiableMap -java/awt/Toolkit -java/awt/Toolkit$3 -sun/util/CoreResourceBundleControl -java/util/ResourceBundle$Control -java/util/Arrays$ArrayList -java/util/Collections$UnmodifiableRandomAccessList -java/util/Collections$UnmodifiableList -java/util/Collections$UnmodifiableCollection -java/util/ResourceBundle -java/util/ResourceBundle$1 -java/util/ResourceBundle$RBClassLoader -java/util/ResourceBundle$RBClassLoader$1 -java/util/ResourceBundle$CacheKey -java/util/ResourceBundle$LoaderReference -java/util/ResourceBundle$CacheKeyReference -java/util/ResourceBundle$SingleFormatControl -sun/awt/resources/awt -java/util/ListResourceBundle -java/awt/Toolkit$1 -java/io/FileNotFoundException -java/io/IOException -java/awt/event/KeyEvent -java/awt/event/InputEvent -java/awt/event/ComponentEvent +com/sun/java/swing/SwingUtilities3 +com/sun/java/swing/plaf/windows/WindowsTabbedPaneUI +com/sun/swing/internal/plaf/basic/resources/basic +com/sun/swing/internal/plaf/metal/resources/metal +java/applet/Applet java/awt/AWTEvent -java/awt/event/NativeLibLoader -java/util/WeakHashMap -java/util/WeakHashMap$Entry -java/awt/Component$DummyRequestFocusController -sun/awt/RequestFocusController -java/awt/LayoutManager -java/awt/LightweightDispatcher -java/awt/event/AWTEventListener -java/util/EventListener -java/awt/Dimension -java/awt/geom/Dimension2D -java/util/concurrent/atomic/AtomicBoolean -java/awt/ComponentOrientation -java/awt/Component$2 -java/lang/NoSuchMethodException -sun/awt/AppContext -sun/awt/AppContext$1 -sun/awt/AppContext$2 -sun/awt/MostRecentKeyValue -java/awt/Cursor -sun/awt/X11GraphicsEnvironment -sun/java2d/SunGraphicsEnvironment -sun/java2d/FontSupport -sun/awt/DisplayChangedListener -java/io/FilenameFilter -sun/awt/X11GraphicsEnvironment$1 -sun/awt/SunToolkit -sun/awt/WindowClosingSupport -sun/awt/WindowClosingListener -sun/awt/ComponentFactory -sun/awt/InputMethodSupport -java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject -java/util/concurrent/locks/Condition -sun/awt/AWTAutoShutdown -sun/awt/SunToolkit$6 -java/awt/Dialog$ModalExclusionType -java/lang/Enum -java/awt/Dialog -java/awt/Dialog$ModalityType -java/awt/ModalEventFilter -java/awt/EventFilter -sun/reflect/UnsafeFieldAccessorFactory -sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl -sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl -sun/awt/SunDisplayChanger -sun/java2d/SunGraphicsEnvironment$1 -java/io/StreamTokenizer -sun/font/FontManager -sun/font/FileFont -sun/font/PhysicalFont -sun/font/Font2D -sun/font/CompositeFont -java/util/HashMap$Values -java/util/HashMap$ValueIterator -java/util/HashMap$HashIterator -java/awt/Font -java/awt/geom/AffineTransform -sun/font/AttributeValues -sun/font/EAttribute -java/text/AttributedCharacterIterator$Attribute -java/lang/Class$4 -sun/reflect/NativeMethodAccessorImpl -sun/reflect/DelegatingMethodAccessorImpl -java/awt/font/TextAttribute -java/lang/Integer$IntegerCache -sun/font/TrueTypeFont -java/awt/font/FontRenderContext -java/awt/RenderingHints -sun/awt/SunHints -sun/awt/SunHints$Key -java/awt/RenderingHints$Key -sun/awt/SunHints$Value -sun/awt/SunHints$LCDContrastKey -sun/font/Type1Font -java/awt/geom/Point2D$Float -java/awt/geom/Point2D -sun/font/StrikeMetrics -java/awt/geom/Rectangle2D$Float -java/awt/geom/Rectangle2D -java/awt/geom/RectangularShape -java/awt/Shape -java/awt/geom/GeneralPath -java/awt/geom/Path2D$Float -java/awt/geom/Path2D -sun/font/CharToGlyphMapper -sun/font/PhysicalStrike -sun/font/FontStrike -sun/font/GlyphList -sun/font/StrikeCache -sun/java2d/Disposer -sun/java2d/Disposer$1 -sun/font/StrikeCache$1 -sun/awt/motif/MFontConfiguration -sun/awt/FontConfiguration -sun/awt/FontDescriptor -java/util/Scanner -java/util/regex/Pattern -java/util/regex/Pattern$Node -java/util/regex/Pattern$LastNode -java/util/regex/Pattern$GroupHead -java/util/regex/Pattern$CharPropertyNames -java/util/regex/Pattern$CharPropertyNames$1 -java/util/regex/Pattern$CharPropertyNames$CharPropertyFactory -java/util/regex/Pattern$CharPropertyNames$2 -java/util/regex/Pattern$CharPropertyNames$5 -java/util/regex/Pattern$CharPropertyNames$3 -java/util/regex/Pattern$CharPropertyNames$6 -java/util/regex/Pattern$CharPropertyNames$CloneableProperty -java/util/regex/Pattern$CharProperty -java/util/regex/Pattern$CharPropertyNames$4 -java/util/regex/Pattern$CharPropertyNames$7 -java/util/regex/Pattern$CharPropertyNames$8 -java/util/regex/Pattern$CharPropertyNames$9 -java/util/regex/Pattern$CharPropertyNames$10 -java/util/regex/Pattern$CharPropertyNames$11 -java/util/regex/Pattern$CharPropertyNames$12 -java/util/regex/Pattern$CharPropertyNames$13 -java/util/regex/Pattern$CharPropertyNames$14 -java/util/regex/Pattern$CharPropertyNames$15 -java/util/regex/Pattern$CharPropertyNames$16 -java/util/regex/Pattern$CharPropertyNames$17 -java/util/regex/Pattern$CharPropertyNames$18 -java/util/regex/Pattern$CharPropertyNames$19 -java/util/regex/Pattern$CharPropertyNames$20 -java/util/regex/Pattern$CharPropertyNames$21 -java/util/regex/Pattern$Curly -java/util/regex/Pattern$Slice -java/util/regex/Pattern$Begin -java/util/regex/Pattern$First -java/util/regex/Pattern$Start -java/util/regex/Pattern$TreeInfo -java/util/regex/Pattern$All -java/util/regex/Pattern$BitClass -java/util/regex/Pattern$BmpCharProperty -java/util/regex/Pattern$6 -java/util/regex/Pattern$CharProperty$1 -sun/nio/ch/FileChannelImpl -java/nio/channels/FileChannel -java/nio/channels/ByteChannel -java/nio/channels/ReadableByteChannel -java/nio/channels/Channel -java/nio/channels/WritableByteChannel -java/nio/channels/GatheringByteChannel -java/nio/channels/ScatteringByteChannel -java/nio/channels/spi/AbstractInterruptibleChannel -java/nio/channels/InterruptibleChannel -sun/nio/ch/Util -sun/nio/ch/IOUtil -sun/nio/ch/FileDispatcher -sun/nio/ch/NativeDispatcher -sun/nio/ch/Reflect -java/nio/MappedByteBuffer -sun/nio/ch/Reflect$1 -sun/nio/ch/NativeThreadSet -java/nio/channels/Channels -java/util/Scanner$1 -sun/misc/LRUCache -java/util/regex/Matcher -java/util/regex/MatchResult -java/text/NumberFormat -java/text/Format -java/text/spi/NumberFormatProvider -java/util/spi/LocaleServiceProvider -sun/util/LocaleServiceProviderPool -sun/util/LocaleServiceProviderPool$1 -java/util/ServiceLoader -java/util/ServiceLoader$LazyIterator -java/util/ServiceLoader$1 -java/util/HashMap$EntrySet -java/util/LinkedHashMap$EntryIterator -sun/misc/Launcher$1 -sun/misc/URLClassPath$2 -java/lang/ClassLoader$2 -sun/misc/URLClassPath$1 -java/net/URLClassLoader$3 -sun/misc/CompoundEnumeration -sun/misc/URLClassPath$JarLoader$1 -sun/misc/FileURLMapper -java/net/URLClassLoader$3$1 -sun/util/resources/LocaleData -sun/util/resources/LocaleData$1 -sun/util/resources/LocaleData$LocaleDataResourceBundleControl -sun/util/LocaleDataMetaInfo -sun/text/resources/FormatData -java/util/ResourceBundle$BundleReference -sun/text/resources/FormatData_en -sun/text/resources/FormatData_en_US -java/text/DecimalFormatSymbols -java/text/spi/DecimalFormatSymbolsProvider -java/util/Currency -java/util/Currency$1 -java/util/spi/CurrencyNameProvider -sun/util/resources/CurrencyNames -sun/util/resources/LocaleNamesBundle -sun/util/resources/OpenListResourceBundle -sun/util/resources/CurrencyNames_en_US -java/text/DecimalFormat -java/text/FieldPosition -java/text/DigitList -java/math/RoundingMode -java/util/regex/Pattern$GroupTail -java/util/regex/Pattern$Ctype -java/util/regex/Pattern$Ques -java/util/regex/Pattern$GroupCurly -java/util/regex/Pattern$5 -java/util/regex/Pattern$Loop -java/util/regex/Pattern$Prolog -java/util/regex/Pattern$BranchConn -java/util/regex/Pattern$Branch -java/nio/channels/spi/AbstractInterruptibleChannel$1 -sun/nio/ch/Interruptible -sun/nio/ch/NativeThread -sun/nio/ch/DirectBuffer -java/nio/DirectByteBuffer -java/nio/DirectByteBuffer$Deallocator -sun/misc/Cleaner -sun/nio/ch/IOStatus -java/util/regex/ASCII -java/io/DataInputStream -java/io/DataInput -java/lang/Short$ShortCache -java/util/HashMap$KeyIterator -sun/font/CompositeFontDescriptor -sun/font/Font2DHandle -sun/font/FontFamily -java/awt/GraphicsDevice -sun/awt/X11GraphicsDevice -sun/awt/X11GraphicsConfig -java/awt/GraphicsConfiguration -java/awt/ImageCapabilities -sun/java2d/x11/X11SurfaceData -sun/java2d/SurfaceData -java/awt/Transparency -sun/java2d/DisposerTarget -sun/java2d/InvalidPipeException -java/lang/IllegalStateException -sun/java2d/NullSurfaceData -sun/java2d/loops/SurfaceType -sun/awt/image/PixelConverter -sun/awt/image/PixelConverter$Xrgb -sun/awt/image/PixelConverter$Argb -sun/awt/image/PixelConverter$ArgbPre -sun/awt/image/PixelConverter$Xbgr -sun/awt/image/PixelConverter$Rgba -sun/awt/image/PixelConverter$RgbaPre -sun/awt/image/PixelConverter$Ushort565Rgb -sun/awt/image/PixelConverter$Ushort555Rgb -sun/awt/image/PixelConverter$Ushort555Rgbx -sun/awt/image/PixelConverter$Ushort4444Argb -sun/awt/image/PixelConverter$ByteGray -sun/awt/image/PixelConverter$UshortGray -sun/awt/image/PixelConverter$Rgbx -sun/awt/image/PixelConverter$Bgrx -sun/awt/image/PixelConverter$ArgbBm -java/awt/image/ColorModel -java/awt/image/DirectColorModel -java/awt/image/PackedColorModel -java/awt/color/ColorSpace -java/awt/color/ICC_Profile -java/awt/color/ICC_ProfileRGB -java/awt/color/ICC_Profile$1 -java/awt/color/ICC_ColorSpace -sun/java2d/pipe/NullPipe -sun/java2d/pipe/PixelDrawPipe -sun/java2d/pipe/PixelFillPipe -sun/java2d/pipe/ShapeDrawPipe -sun/java2d/pipe/TextPipe -sun/java2d/pipe/DrawImagePipe -java/awt/image/IndexColorModel -sun/java2d/pipe/LoopPipe -sun/java2d/pipe/OutlineTextRenderer -sun/java2d/pipe/SolidTextRenderer -sun/java2d/pipe/GlyphListLoopPipe -sun/java2d/pipe/GlyphListPipe -sun/java2d/pipe/AATextRenderer -sun/java2d/pipe/LCDTextRenderer -sun/java2d/pipe/AlphaColorPipe -sun/java2d/pipe/CompositePipe -sun/java2d/pipe/PixelToShapeConverter -sun/java2d/pipe/TextRenderer -sun/java2d/pipe/SpanClipRenderer -sun/java2d/pipe/Region -sun/java2d/pipe/RegionIterator -sun/java2d/pipe/AlphaPaintPipe -sun/java2d/pipe/SpanShapeRenderer$Composite -sun/java2d/pipe/SpanShapeRenderer -sun/java2d/pipe/GeneralCompositePipe -sun/java2d/pipe/DrawImage -sun/java2d/loops/RenderCache -sun/java2d/loops/RenderCache$Entry -sun/java2d/loops/XORComposite -java/awt/Composite -sun/font/X11TextRenderer -sun/java2d/loops/GraphicsPrimitive -sun/java2d/x11/X11PMBlitLoops -sun/java2d/loops/Blit -sun/java2d/loops/GraphicsPrimitiveMgr -sun/java2d/loops/CompositeType -sun/java2d/SunGraphics2D -sun/awt/ConstrainableGraphics -java/awt/Graphics2D -java/awt/Graphics -java/awt/Color -java/awt/Paint -java/awt/AlphaComposite -sun/java2d/loops/BlitBg -sun/java2d/loops/ScaledBlit -sun/java2d/loops/FillRect -sun/java2d/loops/FillSpans -sun/java2d/loops/DrawLine -sun/java2d/loops/DrawRect -sun/java2d/loops/DrawPolygons -sun/java2d/loops/DrawPath -sun/java2d/loops/FillPath -sun/java2d/loops/MaskBlit -sun/java2d/loops/MaskFill -sun/java2d/loops/DrawGlyphList -sun/java2d/loops/DrawGlyphListAA -sun/java2d/loops/DrawGlyphListLCD -sun/java2d/loops/TransformHelper -java/awt/BasicStroke -java/awt/Stroke -sun/misc/PerformanceLogger -sun/misc/PerformanceLogger$TimeData -sun/java2d/pipe/ValidatePipe -sun/java2d/loops/CustomComponent -sun/java2d/loops/GraphicsPrimitiveProxy -sun/java2d/loops/GeneralRenderer -sun/java2d/loops/GraphicsPrimitiveMgr$1 -sun/java2d/loops/GraphicsPrimitiveMgr$2 -sun/java2d/x11/X11PMBlitLoops$DelegateBlitLoop -sun/java2d/x11/X11PMBlitBgLoops -sun/java2d/x11/X11SurfaceData$LazyPipe -sun/awt/X11GraphicsConfig$X11GCDisposerRecord -sun/java2d/DisposerRecord -java/awt/BorderLayout -java/awt/LayoutManager2 -java/awt/Rectangle -java/awt/Toolkit$2 -sun/awt/X11/XToolkit -sun/awt/X11/XConstants -sun/awt/UNIXToolkit -java/util/TreeMap -java/util/NavigableMap -java/util/SortedMap -sun/awt/X11/XlibWrapper -sun/awt/X11/XUtilConstants -sun/awt/X11/XProtocolConstants -sun/awt/X11/XCursorFontConstants -sun/awt/X11/XlibWrapper$1 -sun/awt/X11/XToolkit$4 -sun/awt/X11/XModifierKeymap -sun/awt/X11/XWrapperBase -sun/awt/X11/Native -sun/awt/X11/Native$1 -java/awt/EventQueue -java/util/EmptyStackException -java/lang/reflect/InvocationTargetException -java/awt/EventDispatchThread -java/awt/event/PaintEvent -java/awt/event/MouseEvent -sun/awt/PeerEvent -java/awt/event/InvocationEvent -java/awt/ActiveEvent -sun/awt/X11/XToolkit$1 -sun/awt/X11/XEventDispatcher -sun/awt/SunToolkit$ModalityListenerList -sun/awt/ModalityListener -sun/awt/SunToolkit$1 -java/util/MissingResourceException -java/awt/Queue -sun/awt/PostEventQueue -java/util/LinkedList -java/util/Deque -java/util/Queue -java/util/AbstractSequentialList -sun/awt/X11/AwtScreenData -sun/awt/X11/XWM -sun/awt/X11/MWMConstants -sun/awt/X11/XAtom -java/awt/Insets -sun/awt/X11/XWM$1 -sun/awt/X11/XSetWindowAttributes -sun/awt/X11/XErrorEvent -sun/awt/X11/XNETProtocol -sun/awt/X11/XStateProtocol -sun/awt/X11/XLayerProtocol -sun/awt/X11/XProtocol -sun/awt/X11/WindowPropertyGetter -sun/awt/X11/UnsafeXDisposerRecord -sun/awt/X11/XPropertyCache -sun/awt/X11/XWINProtocol -sun/awt/X11/XAtomList -sun/awt/X11/XToolkit$3 -sun/awt/X11/XAnyEvent -java/awt/Window$WindowDisposerRecord -java/awt/KeyboardFocusManager -java/awt/KeyEventDispatcher -java/awt/KeyEventPostProcessor +java/awt/AWTEvent$1 +java/awt/AWTEventMulticaster java/awt/AWTKeyStroke java/awt/AWTKeyStroke$1 -java/awt/DefaultKeyboardFocusManager -java/awt/DefaultFocusTraversalPolicy +java/awt/ActiveEvent +java/awt/Adjustable +java/awt/AlphaComposite +java/awt/BasicStroke +java/awt/BorderLayout +java/awt/BufferCapabilities +java/awt/Canvas +java/awt/CardLayout +java/awt/CardLayout$Card +java/awt/Color +java/awt/Component +java/awt/Component$1 +java/awt/Component$3 +java/awt/Component$AWTTreeLock +java/awt/Component$AccessibleAWTComponent +java/awt/Component$BaselineResizeBehavior +java/awt/Component$BltBufferStrategy +java/awt/Component$BltSubRegionBufferStrategy +java/awt/Component$DummyRequestFocusController +java/awt/Component$FlipBufferStrategy +java/awt/ComponentOrientation +java/awt/Composite +java/awt/Conditional +java/awt/Container +java/awt/Container$1 +java/awt/Container$AccessibleAWTContainer java/awt/ContainerOrderFocusTraversalPolicy +java/awt/Cursor +java/awt/Cursor$1 +java/awt/DefaultFocusTraversalPolicy +java/awt/DefaultKeyboardFocusManager +java/awt/DefaultKeyboardFocusManager$1 +java/awt/DefaultKeyboardFocusManager$DefaultKeyboardFocusManagerSentEvent +java/awt/DefaultKeyboardFocusManager$TypeAheadMarker +java/awt/Dialog +java/awt/Dialog$ModalExclusionType +java/awt/Dialog$ModalityType +java/awt/Dimension +java/awt/Event +java/awt/EventDispatchThread +java/awt/EventDispatchThread$1 +java/awt/EventDispatchThread$HierarchyEventFilter +java/awt/EventFilter +java/awt/EventFilter$FilterAction +java/awt/EventQueue +java/awt/EventQueue$1 +java/awt/EventQueue$1AWTInvocationLock +java/awt/EventQueue$2 +java/awt/EventQueue$3 +java/awt/EventQueue$4 +java/awt/EventQueue$5 +java/awt/FlowLayout java/awt/FocusTraversalPolicy -java/util/Collections$UnmodifiableSet -sun/awt/HeadlessToolkit -sun/awt/X11/XKeyboardFocusManagerPeer -java/awt/peer/KeyboardFocusManagerPeer -sun/awt/X11/XKeyboardFocusManagerPeer$1 -sun/awt/X11/XFramePeer -java/awt/peer/FramePeer -java/awt/peer/WindowPeer -java/awt/peer/ContainerPeer -java/awt/peer/ComponentPeer -sun/awt/X11/XDecoratedPeer -sun/awt/X11/XWindowPeer -sun/awt/X11/XPanelPeer -java/awt/peer/PanelPeer -sun/awt/X11/XCanvasPeer -java/awt/peer/CanvasPeer -sun/awt/X11/XComponentPeer -java/awt/dnd/peer/DropTargetPeer -sun/awt/X11/XWindow -sun/awt/X11ComponentPeer -sun/awt/X11/XBaseWindow -sun/awt/X11/XCreateWindowParams -java/lang/Long$LongCache -sun/awt/X11/XBaseWindow$InitialiseState -sun/awt/X11/XBaseWindow$StateLock -sun/awt/X11/AwtGraphicsConfigData -sun/awt/X11/XVisualInfo -java/awt/SystemColor -sun/awt/X11/MotifColorUtilities -java/lang/StrictMath -sun/awt/X11/XRepaintArea -sun/awt/RepaintArea -sun/awt/X11/XWindowAttributesData -java/util/concurrent/locks/LockSupport -sun/awt/X11/WindowDimensions +java/awt/Font +java/awt/Font$FontAccessImpl +java/awt/FontFormatException +java/awt/FontMetrics +java/awt/Frame +java/awt/Frame$1 +java/awt/Graphics +java/awt/Graphics2D +java/awt/GraphicsCallback +java/awt/GraphicsCallback$PaintCallback +java/awt/GraphicsConfiguration +java/awt/GraphicsDevice +java/awt/GraphicsEnvironment +java/awt/GraphicsEnvironment$1 +java/awt/GridLayout +java/awt/Image +java/awt/Image$1 +java/awt/ImageCapabilities +java/awt/ImageMediaEntry +java/awt/Insets +java/awt/ItemSelectable +java/awt/KeyEventDispatcher +java/awt/KeyEventPostProcessor +java/awt/KeyboardFocusManager +java/awt/KeyboardFocusManager$1 +java/awt/KeyboardFocusManager$3 +java/awt/KeyboardFocusManager$HeavyweightFocusRequest +java/awt/KeyboardFocusManager$LightweightFocusRequest +java/awt/Label +java/awt/LayoutManager +java/awt/LayoutManager2 +java/awt/LightweightDispatcher +java/awt/LightweightDispatcher$2 +java/awt/MediaEntry +java/awt/MediaTracker +java/awt/MenuBar +java/awt/MenuComponent +java/awt/MenuContainer +java/awt/ModalEventFilter +java/awt/Paint +java/awt/Panel java/awt/Point -java/util/TreeMap$Entry -sun/nio/cs/UTF_8 -sun/nio/cs/Unicode -sun/nio/cs/UTF_8$Encoder -sun/nio/cs/UTF_8$Decoder -sun/nio/cs/Surrogate$Generator -sun/awt/X11/XPropertyEvent -sun/awt/X11/XDropTargetEventProcessor -sun/awt/X11/XDragSourceContextPeer -sun/awt/X11/XDragSourceProtocolListener -sun/awt/dnd/SunDragSourceContextPeer -java/awt/dnd/peer/DragSourceContextPeer -sun/awt/X11/XAwtState -sun/awt/X11/XBaseWindow$1 -sun/awt/X11/XRootWindow -sun/nio/cs/ISO_8859_1 -sun/nio/cs/ISO_8859_1$Encoder -sun/nio/cs/ISO_8859_1$Decoder -sun/java2d/x11/X11SurfaceData$X11WindowSurfaceData -sun/java2d/loops/RenderLoops -sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec -sun/java2d/DefaultDisposerRecord -sun/java2d/x11/X11Renderer -sun/awt/X11/XGlobalCursorManager -sun/awt/GlobalCursorManager -java/awt/Cursor$CursorDisposer -java/awt/AWTException -java/awt/HeadlessException -java/lang/UnsupportedOperationException -sun/reflect/UnsafeLongFieldAccessorImpl -sun/reflect/UnsafeIntegerFieldAccessorImpl -sun/awt/X11/XClientMessageEvent -sun/awt/X11/XIconInfo -sun/awt/X11/XAWTIcon32_java_icon16_png -sun/awt/X11/XAWTIcon32_java_icon24_png -sun/awt/X11/XAWTIcon32_java_icon32_png -sun/awt/X11/XAWTIcon32_java_icon48_png -sun/awt/X11/XSizeHints -sun/awt/X11/XContentWindow -sun/awt/X11/XFocusProxyWindow -sun/awt/X11/XWMHints -java/util/LinkedList$ListItr -java/util/ListIterator -sun/awt/SunToolkit$2 -java/awt/image/BufferStrategy +java/awt/PrintGraphics +java/awt/Queue +java/awt/Rectangle +java/awt/RenderingHints +java/awt/RenderingHints$Key +java/awt/SentEvent +java/awt/SequencedEvent +java/awt/SequencedEvent$1 +java/awt/Shape +java/awt/SplashScreen +java/awt/Stroke +java/awt/SystemColor +java/awt/Toolkit +java/awt/Toolkit$1 +java/awt/Toolkit$2 +java/awt/Toolkit$3 +java/awt/Toolkit$4 +java/awt/Toolkit$5 +java/awt/Toolkit$DesktopPropertyChangeSupport +java/awt/Toolkit$DesktopPropertyChangeSupport$1 +java/awt/Toolkit$SelectiveAWTEventListener +java/awt/Toolkit$ToolkitEventMulticaster +java/awt/Transparency +java/awt/TrayIcon +java/awt/VKCollection +java/awt/Window +java/awt/Window$1 +java/awt/Window$1DisposeAction +java/awt/Window$Type +java/awt/Window$WindowDisposerRecord +java/awt/color/ColorSpace +java/awt/color/ICC_ColorSpace +java/awt/color/ICC_Profile +java/awt/color/ICC_Profile$1 +java/awt/color/ICC_ProfileRGB +java/awt/datatransfer/Clipboard +java/awt/datatransfer/ClipboardOwner +java/awt/datatransfer/FlavorMap +java/awt/datatransfer/FlavorTable +java/awt/datatransfer/SystemFlavorMap +java/awt/datatransfer/Transferable java/awt/dnd/DropTarget +java/awt/dnd/DropTargetContext java/awt/dnd/DropTargetListener +java/awt/dnd/peer/DragSourceContextPeer +java/awt/dnd/peer/DropTargetContextPeer +java/awt/dnd/peer/DropTargetPeer +java/awt/event/AWTEventListener +java/awt/event/AWTEventListenerProxy +java/awt/event/ActionEvent +java/awt/event/ActionListener +java/awt/event/AdjustmentEvent +java/awt/event/AdjustmentListener +java/awt/event/ComponentAdapter +java/awt/event/ComponentEvent java/awt/event/ComponentListener +java/awt/event/ContainerEvent +java/awt/event/ContainerListener +java/awt/event/FocusAdapter +java/awt/event/FocusEvent java/awt/event/FocusListener -java/awt/event/HierarchyListener java/awt/event/HierarchyBoundsListener +java/awt/event/HierarchyListener +java/awt/event/InputEvent +java/awt/event/InputEvent$1 +java/awt/event/InputMethodEvent +java/awt/event/InputMethodListener +java/awt/event/InvocationEvent +java/awt/event/InvocationEvent$1 +java/awt/event/ItemEvent +java/awt/event/ItemListener +java/awt/event/KeyAdapter +java/awt/event/KeyEvent +java/awt/event/KeyEvent$1 java/awt/event/KeyListener +java/awt/event/MouseAdapter +java/awt/event/MouseEvent java/awt/event/MouseListener +java/awt/event/MouseMotionAdapter java/awt/event/MouseMotionListener java/awt/event/MouseWheelListener -java/awt/event/InputMethodListener -java/awt/event/ContainerListener -javax/accessibility/AccessibleContext -sun/reflect/UnsafeObjectFieldAccessorImpl -java/awt/peer/LightweightPeer -sun/awt/X11/XLabelPeer +java/awt/event/NativeLibLoader +java/awt/event/NativeLibLoader$1 +java/awt/event/PaintEvent +java/awt/event/TextListener +java/awt/event/WindowAdapter +java/awt/event/WindowEvent +java/awt/event/WindowFocusListener +java/awt/event/WindowListener +java/awt/event/WindowStateListener +java/awt/font/FontRenderContext +java/awt/font/GlyphVector +java/awt/font/LineMetrics +java/awt/font/TextAttribute +java/awt/geom/AffineTransform +java/awt/geom/Dimension2D +java/awt/geom/GeneralPath +java/awt/geom/Line2D +java/awt/geom/Line2D$Float +java/awt/geom/Path2D +java/awt/geom/Path2D$Float +java/awt/geom/PathIterator +java/awt/geom/Point2D +java/awt/geom/Point2D$Float +java/awt/geom/RectIterator +java/awt/geom/Rectangle2D +java/awt/geom/Rectangle2D$Float +java/awt/geom/RectangularShape +java/awt/im/InputContext +java/awt/im/InputMethodRequests +java/awt/im/spi/InputMethod +java/awt/im/spi/InputMethodContext +java/awt/im/spi/InputMethodDescriptor +java/awt/image/BufferStrategy +java/awt/image/BufferedImage +java/awt/image/BufferedImage$1 +java/awt/image/ColorModel +java/awt/image/ColorModel$1 +java/awt/image/ComponentSampleModel +java/awt/image/DataBuffer +java/awt/image/DataBuffer$1 +java/awt/image/DataBufferByte +java/awt/image/DataBufferInt +java/awt/image/DirectColorModel +java/awt/image/FilteredImageSource +java/awt/image/ImageConsumer +java/awt/image/ImageFilter +java/awt/image/ImageObserver +java/awt/image/ImageProducer +java/awt/image/IndexColorModel +java/awt/image/PackedColorModel +java/awt/image/PixelInterleavedSampleModel +java/awt/image/RGBImageFilter +java/awt/image/Raster +java/awt/image/RenderedImage +java/awt/image/SampleModel +java/awt/image/SinglePixelPackedSampleModel +java/awt/image/VolatileImage +java/awt/image/WritableRaster +java/awt/image/WritableRenderedImage +java/awt/peer/CanvasPeer +java/awt/peer/ComponentPeer +java/awt/peer/ContainerPeer +java/awt/peer/FramePeer +java/awt/peer/KeyboardFocusManagerPeer java/awt/peer/LabelPeer -sun/awt/X11/XMapEvent -sun/awt/X11/XQueryTree -sun/awt/X11/XConfigureEvent -sun/awt/X11/PropMwmHints -sun/awt/GlobalCursorManager$NativeUpdater -javax/swing/JFrame -javax/swing/WindowConstants -javax/swing/RootPaneContainer -javax/swing/TransferHandler$HasGetTransferHandler -javax/swing/JLabel -javax/swing/SwingConstants -javax/swing/JComponent -javax/swing/JComponent$1 -javax/swing/SwingUtilities -javax/swing/JRootPane -sun/security/action/GetBooleanAction -javax/swing/event/EventListenerList -javax/swing/JPanel -java/awt/FlowLayout -javax/swing/UIManager -javax/swing/UIManager$LookAndFeelInfo -sun/swing/SwingUtilities2 -sun/swing/SwingUtilities2$LSBCacheEntry -javax/swing/UIManager$LAFState -javax/swing/UIDefaults -javax/swing/MultiUIDefaults -javax/swing/UIManager$1 -javax/swing/plaf/metal/MetalLookAndFeel -javax/swing/plaf/basic/BasicLookAndFeel -javax/swing/LookAndFeel -sun/swing/DefaultLookup -javax/swing/plaf/metal/OceanTheme -javax/swing/plaf/metal/DefaultMetalTheme -javax/swing/plaf/metal/MetalTheme -javax/swing/plaf/ColorUIResource -javax/swing/plaf/UIResource -sun/swing/PrintColorUIResource -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate -javax/swing/plaf/FontUIResource -sun/swing/SwingLazyValue -javax/swing/UIDefaults$LazyValue -javax/swing/UIDefaults$ActiveValue -javax/swing/plaf/InsetsUIResource -sun/swing/SwingUtilities2$2 -javax/swing/plaf/basic/BasicLookAndFeel$2 -javax/swing/plaf/DimensionUIResource -javax/swing/UIDefaults$LazyInputMap -java/lang/Character$CharacterCache -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue -javax/swing/plaf/metal/MetalLookAndFeel$FontActiveValue -java/awt/print/PrinterJob -sun/swing/SwingUtilities2$AATextInfo -sun/awt/X11/XAWTXSettings -sun/awt/X11/XMSelectionListener -sun/awt/XSettings -sun/awt/X11/XMSelection -sun/awt/X11/XMSelection$1 -javax/swing/plaf/metal/MetalLookAndFeel$AATextListener +java/awt/peer/LightweightPeer +java/awt/peer/PanelPeer +java/awt/peer/SystemTrayPeer +java/awt/peer/WindowPeer +java/awt/print/PrinterGraphics +java/beans/ChangeListenerMap +java/beans/PropertyChangeEvent java/beans/PropertyChangeListener java/beans/PropertyChangeListenerProxy +java/beans/PropertyChangeSupport +java/beans/PropertyChangeSupport$PropertyChangeListenerMap +java/beans/VetoableChangeListener +java/io/Bits +java/io/BufferedInputStream +java/io/BufferedOutputStream +java/io/BufferedReader +java/io/BufferedWriter +java/io/ByteArrayInputStream +java/io/ByteArrayOutputStream +java/io/Closeable +java/io/DataInput +java/io/DataInputStream +java/io/DataOutput +java/io/DataOutputStream +java/io/DefaultFileSystem +java/io/EOFException +java/io/ExpiringCache +java/io/ExpiringCache$1 +java/io/ExpiringCache$Entry +java/io/Externalizable +java/io/File +java/io/File$PathStatus +java/io/FileDescriptor +java/io/FileDescriptor$1 +java/io/FileInputStream +java/io/FileInputStream$1 +java/io/FileNotFoundException +java/io/FileOutputStream +java/io/FileOutputStream$1 +java/io/FilePermission +java/io/FilePermission$1 +java/io/FilePermissionCollection +java/io/FileReader +java/io/FileSystem +java/io/FileWriter +java/io/FilenameFilter +java/io/FilterInputStream +java/io/FilterOutputStream +java/io/FilterReader +java/io/Flushable +java/io/IOException +java/io/InputStream +java/io/InputStreamReader +java/io/InterruptedIOException +java/io/ObjectInput +java/io/ObjectInputStream +java/io/ObjectInputStream$BlockDataInputStream +java/io/ObjectInputStream$GetField +java/io/ObjectInputStream$GetFieldImpl +java/io/ObjectInputStream$HandleTable +java/io/ObjectInputStream$HandleTable$HandleList +java/io/ObjectInputStream$PeekInputStream +java/io/ObjectInputStream$ValidationList +java/io/ObjectOutput +java/io/ObjectOutputStream +java/io/ObjectOutputStream$BlockDataOutputStream +java/io/ObjectOutputStream$HandleTable +java/io/ObjectOutputStream$ReplaceTable +java/io/ObjectStreamClass +java/io/ObjectStreamClass$1 +java/io/ObjectStreamClass$2 +java/io/ObjectStreamClass$3 +java/io/ObjectStreamClass$4 +java/io/ObjectStreamClass$5 +java/io/ObjectStreamClass$Caches +java/io/ObjectStreamClass$ClassDataSlot +java/io/ObjectStreamClass$EntryFuture +java/io/ObjectStreamClass$ExceptionInfo +java/io/ObjectStreamClass$FieldReflector +java/io/ObjectStreamClass$FieldReflectorKey +java/io/ObjectStreamClass$MemberSignature +java/io/ObjectStreamClass$WeakClassKey +java/io/ObjectStreamConstants +java/io/ObjectStreamField +java/io/OutputStream +java/io/OutputStreamWriter +java/io/PrintStream +java/io/PushbackInputStream +java/io/RandomAccessFile +java/io/RandomAccessFile$1 +java/io/Reader +java/io/SerialCallbackContext +java/io/Serializable +java/io/StreamTokenizer +java/io/StringReader +java/io/StringWriter +java/io/UnixFileSystem +java/io/UnsupportedEncodingException +java/io/Writer +java/lang/AbstractStringBuilder +java/lang/Appendable +java/lang/ApplicationShutdownHooks +java/lang/ApplicationShutdownHooks$1 +java/lang/ArithmeticException +java/lang/ArrayIndexOutOfBoundsException +java/lang/ArrayStoreException +java/lang/AutoCloseable +java/lang/Boolean +java/lang/BootstrapMethodError +java/lang/Byte +java/lang/CharSequence +java/lang/Character +java/lang/Character$CharacterCache +java/lang/CharacterData +java/lang/CharacterData00 +java/lang/CharacterDataLatin1 +java/lang/Class +java/lang/Class$1 +java/lang/Class$3 +java/lang/Class$4 +java/lang/Class$AnnotationData +java/lang/Class$Atomic +java/lang/Class$ReflectionData +java/lang/ClassCastException +java/lang/ClassFormatError +java/lang/ClassLoader +java/lang/ClassLoader$2 +java/lang/ClassLoader$3 +java/lang/ClassLoader$NativeLibrary +java/lang/ClassLoader$ParallelLoaders +java/lang/ClassNotFoundException +java/lang/ClassValue$ClassValueMap +java/lang/CloneNotSupportedException +java/lang/Cloneable +java/lang/Comparable +java/lang/Compiler +java/lang/Compiler$1 +java/lang/Double +java/lang/Enum +java/lang/Error +java/lang/Exception +java/lang/ExceptionInInitializerError +java/lang/Float +java/lang/IllegalAccessError +java/lang/IllegalAccessException +java/lang/IllegalArgumentException +java/lang/IllegalMonitorStateException +java/lang/IllegalStateException +java/lang/IncompatibleClassChangeError +java/lang/IndexOutOfBoundsException +java/lang/InheritableThreadLocal +java/lang/InstantiationException +java/lang/Integer +java/lang/Integer$IntegerCache +java/lang/InternalError +java/lang/InterruptedException +java/lang/Iterable +java/lang/LinkageError +java/lang/Long +java/lang/Long$LongCache +java/lang/Math +java/lang/NoClassDefFoundError +java/lang/NoSuchFieldException +java/lang/NoSuchMethodError +java/lang/NoSuchMethodException +java/lang/NullPointerException +java/lang/Number +java/lang/NumberFormatException +java/lang/Object +java/lang/OutOfMemoryError +java/lang/Package +java/lang/Process +java/lang/ProcessBuilder +java/lang/ProcessBuilder$NullOutputStream +java/lang/ProcessEnvironment +java/lang/ProcessEnvironment$ExternalData +java/lang/ProcessEnvironment$StringEnvironment +java/lang/ProcessEnvironment$Value +java/lang/ProcessEnvironment$Variable +java/lang/ProcessImpl +java/lang/Readable +java/lang/ReflectiveOperationException +java/lang/Runnable +java/lang/Runtime +java/lang/RuntimeException +java/lang/RuntimePermission +java/lang/SecurityException +java/lang/SecurityManager +java/lang/Short +java/lang/Shutdown +java/lang/Shutdown$Lock +java/lang/StackOverflowError +java/lang/StackTraceElement +java/lang/StrictMath +java/lang/String +java/lang/String$CaseInsensitiveComparator +java/lang/StringBuffer +java/lang/StringBuilder +java/lang/StringCoding +java/lang/StringCoding$StringDecoder +java/lang/StringCoding$StringEncoder +java/lang/StringIndexOutOfBoundsException +java/lang/System +java/lang/System$2 +java/lang/SystemClassLoaderAction +java/lang/Terminator +java/lang/Terminator$1 +java/lang/Thread +java/lang/Thread$State +java/lang/Thread$UncaughtExceptionHandler +java/lang/ThreadDeath +java/lang/ThreadGroup +java/lang/ThreadLocal +java/lang/ThreadLocal$ThreadLocalMap +java/lang/ThreadLocal$ThreadLocalMap$Entry +java/lang/Throwable +java/lang/Throwable$PrintStreamOrWriter +java/lang/Throwable$WrappedPrintStream +java/lang/UNIXProcess +java/lang/UNIXProcess$1 +java/lang/UNIXProcess$2 +java/lang/UNIXProcess$3 +java/lang/UNIXProcess$4 +java/lang/UNIXProcess$LaunchMechanism +java/lang/UNIXProcess$ProcessPipeInputStream +java/lang/UNIXProcess$ProcessPipeOutputStream +java/lang/UNIXProcess$ProcessReaperThreadFactory +java/lang/UNIXProcess$ProcessReaperThreadFactory$1 +java/lang/UnsatisfiedLinkError +java/lang/UnsupportedOperationException +java/lang/VirtualMachineError +java/lang/Void +java/lang/annotation/Annotation +java/lang/invoke/CallSite +java/lang/invoke/ConstantCallSite +java/lang/invoke/DirectMethodHandle +java/lang/invoke/Invokers +java/lang/invoke/LambdaForm +java/lang/invoke/LambdaForm$NamedFunction +java/lang/invoke/MemberName +java/lang/invoke/MemberName$Factory +java/lang/invoke/MethodHandle +java/lang/invoke/MethodHandleImpl +java/lang/invoke/MethodHandleNatives +java/lang/invoke/MethodHandleStatics +java/lang/invoke/MethodHandleStatics$1 +java/lang/invoke/MethodType +java/lang/invoke/MethodType$ConcurrentWeakInternSet +java/lang/invoke/MethodType$ConcurrentWeakInternSet$WeakEntry +java/lang/invoke/MethodTypeForm +java/lang/invoke/MutableCallSite +java/lang/invoke/VolatileCallSite +java/lang/ref/FinalReference +java/lang/ref/Finalizer +java/lang/ref/Finalizer$FinalizerThread +java/lang/ref/PhantomReference +java/lang/ref/Reference +java/lang/ref/Reference$Lock +java/lang/ref/Reference$ReferenceHandler +java/lang/ref/ReferenceQueue +java/lang/ref/ReferenceQueue$Lock +java/lang/ref/ReferenceQueue$Null +java/lang/ref/SoftReference +java/lang/ref/WeakReference +java/lang/reflect/AccessibleObject +java/lang/reflect/AnnotatedElement +java/lang/reflect/Array +java/lang/reflect/Constructor +java/lang/reflect/Executable +java/lang/reflect/Field +java/lang/reflect/GenericDeclaration +java/lang/reflect/InvocationHandler +java/lang/reflect/InvocationTargetException +java/lang/reflect/Member +java/lang/reflect/Method +java/lang/reflect/Modifier +java/lang/reflect/Parameter +java/lang/reflect/Proxy +java/lang/reflect/Proxy$KeyFactory +java/lang/reflect/Proxy$ProxyClassFactory +java/lang/reflect/ReflectAccess +java/lang/reflect/ReflectPermission +java/lang/reflect/Type +java/lang/reflect/WeakCache +java/math/BigInteger +java/math/BigInteger$UnsafeHolder +java/math/MutableBigInteger +java/math/RoundingMode +java/math/SignedMutableBigInteger +java/net/AbstractPlainDatagramSocketImpl +java/net/AbstractPlainDatagramSocketImpl$1 +java/net/AbstractPlainSocketImpl +java/net/AbstractPlainSocketImpl$1 +java/net/Authenticator +java/net/BindException +java/net/ConnectException +java/net/DatagramPacket +java/net/DatagramPacket$1 +java/net/DatagramSocket +java/net/DatagramSocket$1 +java/net/DatagramSocketImpl +java/net/DefaultDatagramSocketImplFactory +java/net/DefaultInterface +java/net/FileNameMap +java/net/HttpURLConnection +java/net/Inet4Address +java/net/Inet4AddressImpl +java/net/Inet6Address +java/net/Inet6Address$Inet6AddressHolder +java/net/Inet6AddressImpl +java/net/InetAddress +java/net/InetAddress$1 +java/net/InetAddress$2 +java/net/InetAddress$Cache +java/net/InetAddress$Cache$Type +java/net/InetAddress$CacheEntry +java/net/InetAddress$InetAddressHolder +java/net/InetAddressImpl +java/net/InetAddressImplFactory +java/net/InetSocketAddress +java/net/InetSocketAddress$InetSocketAddressHolder +java/net/InterfaceAddress +java/net/JarURLConnection +java/net/MalformedURLException +java/net/MulticastSocket +java/net/NetworkInterface +java/net/NetworkInterface$1 +java/net/NoRouteToHostException +java/net/Parts +java/net/PlainDatagramSocketImpl +java/net/PlainSocketImpl +java/net/Proxy +java/net/Proxy$Type +java/net/ProxySelector +java/net/ServerSocket +java/net/Socket +java/net/SocketAddress +java/net/SocketException +java/net/SocketImpl +java/net/SocketImplFactory +java/net/SocketOptions +java/net/SocksConsts +java/net/SocksSocketImpl +java/net/SocksSocketImpl$3 +java/net/URI +java/net/URI$Parser +java/net/URL +java/net/URLClassLoader +java/net/URLClassLoader$1 +java/net/URLClassLoader$2 +java/net/URLClassLoader$3 +java/net/URLClassLoader$3$1 +java/net/URLClassLoader$7 +java/net/URLConnection +java/net/URLConnection$1 +java/net/URLStreamHandler +java/net/URLStreamHandlerFactory +java/net/UnknownHostException +java/nio/Bits +java/nio/Bits$1 +java/nio/Buffer +java/nio/ByteBuffer +java/nio/ByteBufferAsIntBufferB +java/nio/ByteBufferAsShortBufferB +java/nio/ByteOrder +java/nio/CharBuffer +java/nio/DirectByteBuffer +java/nio/DirectByteBuffer$Deallocator +java/nio/DirectByteBufferR +java/nio/DirectLongBufferU +java/nio/HeapByteBuffer +java/nio/HeapCharBuffer +java/nio/IntBuffer +java/nio/LongBuffer +java/nio/MappedByteBuffer +java/nio/ShortBuffer +java/nio/channels/ByteChannel +java/nio/channels/Channel +java/nio/channels/FileChannel +java/nio/channels/FileChannel$MapMode +java/nio/channels/GatheringByteChannel +java/nio/channels/InterruptibleChannel +java/nio/channels/NetworkChannel +java/nio/channels/ReadableByteChannel +java/nio/channels/ScatteringByteChannel +java/nio/channels/SeekableByteChannel +java/nio/channels/SelectableChannel +java/nio/channels/SocketChannel +java/nio/channels/WritableByteChannel +java/nio/channels/spi/AbstractInterruptibleChannel +java/nio/channels/spi/AbstractInterruptibleChannel$1 +java/nio/channels/spi/AbstractSelectableChannel +java/nio/charset/Charset +java/nio/charset/CharsetDecoder +java/nio/charset/CharsetEncoder +java/nio/charset/CoderResult +java/nio/charset/CoderResult$1 +java/nio/charset/CoderResult$2 +java/nio/charset/CoderResult$Cache +java/nio/charset/CodingErrorAction +java/nio/charset/StandardCharsets +java/nio/charset/spi/CharsetProvider +java/nio/file/Path +java/nio/file/Watchable +java/nio/file/attribute/FileAttribute +java/security/AccessControlContext +java/security/AccessController +java/security/AlgorithmParameters +java/security/AlgorithmParametersSpi +java/security/AllPermission +java/security/AllPermissionCollection +java/security/BasicPermission +java/security/BasicPermissionCollection +java/security/CodeSigner +java/security/CodeSource +java/security/GeneralSecurityException +java/security/Guard +java/security/InvalidKeyException +java/security/Key +java/security/KeyException +java/security/MessageDigest +java/security/MessageDigest$Delegate +java/security/MessageDigestSpi +java/security/NoSuchAlgorithmException +java/security/Permission +java/security/PermissionCollection +java/security/Permissions +java/security/Principal +java/security/PrivateKey +java/security/PrivilegedAction +java/security/PrivilegedActionException +java/security/PrivilegedExceptionAction +java/security/ProtectionDomain +java/security/ProtectionDomain$1 +java/security/ProtectionDomain$3 +java/security/ProtectionDomain$Key +java/security/Provider +java/security/Provider$EngineDescription +java/security/Provider$Service +java/security/Provider$ServiceKey +java/security/Provider$UString +java/security/PublicKey +java/security/SecureClassLoader +java/security/SecureRandomSpi +java/security/Security +java/security/Security$1 +java/security/Signature +java/security/Signature$Delegate +java/security/SignatureException +java/security/SignatureSpi +java/security/UnresolvedPermission +java/security/cert/Certificate +java/security/interfaces/DSAKey +java/security/interfaces/DSAParams +java/security/interfaces/DSAPrivateKey +java/security/interfaces/DSAPublicKey +java/security/spec/AlgorithmParameterSpec +java/security/spec/DSAParameterSpec +java/text/AttributedCharacterIterator$Attribute +java/text/CharacterIterator +java/text/Collator +java/text/DateFormat +java/text/DateFormat$Field +java/text/DateFormatSymbols +java/text/DecimalFormat +java/text/DecimalFormatSymbols +java/text/DigitList +java/text/DontCareFieldPosition +java/text/DontCareFieldPosition$1 +java/text/EntryPair +java/text/FieldPosition +java/text/Format +java/text/Format$Field +java/text/Format$FieldDelegate +java/text/MergeCollation +java/text/MessageFormat +java/text/MessageFormat$Field +java/text/NumberFormat +java/text/NumberFormat$Field +java/text/ParseException +java/text/PatternEntry +java/text/PatternEntry$Parser +java/text/RBCollationTables +java/text/RBCollationTables$BuildAPI +java/text/RBTableBuilder +java/text/RuleBasedCollator +java/text/SimpleDateFormat +java/text/spi/BreakIteratorProvider +java/text/spi/CollatorProvider +java/text/spi/DateFormatProvider +java/text/spi/DateFormatSymbolsProvider +java/text/spi/DecimalFormatSymbolsProvider +java/text/spi/NumberFormatProvider +java/util/AbstractCollection +java/util/AbstractList +java/util/AbstractList$Itr +java/util/AbstractList$ListItr +java/util/AbstractMap +java/util/AbstractQueue +java/util/AbstractSequentialList +java/util/AbstractSet +java/util/ArrayDeque +java/util/ArrayList +java/util/ArrayList$Itr +java/util/ArrayList$ListItr +java/util/ArrayList$SubList +java/util/ArrayList$SubList$1 +java/util/Arrays +java/util/Arrays$ArrayList +java/util/Arrays$LegacyMergeSort +java/util/BitSet +java/util/Calendar +java/util/Calendar$Builder +java/util/Collection +java/util/Collections +java/util/Collections$3 +java/util/Collections$EmptyEnumeration +java/util/Collections$EmptyIterator +java/util/Collections$EmptyList +java/util/Collections$EmptyMap +java/util/Collections$EmptySet +java/util/Collections$SetFromMap +java/util/Collections$SynchronizedCollection +java/util/Collections$SynchronizedMap +java/util/Collections$SynchronizedSet +java/util/Collections$UnmodifiableCollection +java/util/Collections$UnmodifiableCollection$1 +java/util/Collections$UnmodifiableList +java/util/Collections$UnmodifiableList$1 +java/util/Collections$UnmodifiableMap +java/util/Collections$UnmodifiableRandomAccessList +java/util/Collections$UnmodifiableSet +java/util/ComparableTimSort +java/util/Comparator +java/util/Currency +java/util/Currency$1 +java/util/Currency$CurrencyNameGetter +java/util/Date +java/util/Deque +java/util/Dictionary +java/util/Enumeration +java/util/EventListener java/util/EventListenerProxy -sun/awt/EventListenerAggregate -javax/swing/UIDefaults$ProxyLazyValue +java/util/EventObject +java/util/GregorianCalendar +java/util/HashMap +java/util/HashMap$EntryIterator +java/util/HashMap$EntrySet +java/util/HashMap$HashIterator +java/util/HashMap$KeyIterator +java/util/HashMap$KeySet +java/util/HashMap$Node +java/util/HashMap$TreeNode +java/util/HashMap$ValueIterator +java/util/HashMap$Values +java/util/HashSet +java/util/Hashtable +java/util/Hashtable$Entry +java/util/Hashtable$EntrySet +java/util/Hashtable$Enumerator +java/util/Hashtable$ValueCollection +java/util/IdentityHashMap +java/util/IdentityHashMap$IdentityHashMapIterator +java/util/IdentityHashMap$KeyIterator +java/util/IdentityHashMap$KeySet +java/util/IdentityHashMap$ValueIterator +java/util/IdentityHashMap$Values +java/util/Iterator +java/util/LinkedHashMap +java/util/LinkedHashMap$Entry +java/util/LinkedHashMap$LinkedEntryIterator +java/util/LinkedHashMap$LinkedEntrySet +java/util/LinkedHashMap$LinkedHashIterator +java/util/LinkedHashMap$LinkedKeyIterator +java/util/LinkedHashMap$LinkedKeySet +java/util/LinkedList +java/util/LinkedList$ListItr +java/util/LinkedList$Node +java/util/List +java/util/ListIterator +java/util/ListResourceBundle +java/util/Locale +java/util/Locale$1 +java/util/Locale$Cache +java/util/Locale$Category +java/util/Locale$LocaleKey +java/util/Map +java/util/Map$Entry +java/util/MissingResourceException +java/util/NavigableMap +java/util/Objects +java/util/PriorityQueue +java/util/Properties +java/util/Properties$LineReader +java/util/PropertyResourceBundle +java/util/Queue +java/util/Random +java/util/RandomAccess +java/util/ResourceBundle +java/util/ResourceBundle$1 +java/util/ResourceBundle$BundleReference +java/util/ResourceBundle$CacheKey +java/util/ResourceBundle$CacheKeyReference +java/util/ResourceBundle$Control +java/util/ResourceBundle$Control$1 +java/util/ResourceBundle$Control$CandidateListCache +java/util/ResourceBundle$LoaderReference +java/util/ResourceBundle$RBClassLoader +java/util/ResourceBundle$RBClassLoader$1 +java/util/ResourceBundle$SingleFormatControl +java/util/ServiceLoader +java/util/ServiceLoader$1 +java/util/ServiceLoader$LazyIterator +java/util/Set +java/util/SortedMap +java/util/Stack +java/util/StringTokenizer +java/util/TimSort +java/util/TimeZone +java/util/TimeZone$1 +java/util/TreeMap +java/util/TreeMap$Entry +java/util/Vector +java/util/Vector$1 +java/util/Vector$Itr +java/util/Vector$ListItr +java/util/WeakHashMap +java/util/WeakHashMap$Entry +java/util/WeakHashMap$KeySet +java/util/concurrent/AbstractExecutorService +java/util/concurrent/BlockingQueue +java/util/concurrent/ConcurrentHashMap +java/util/concurrent/ConcurrentHashMap$BaseIterator +java/util/concurrent/ConcurrentHashMap$CollectionView +java/util/concurrent/ConcurrentHashMap$CounterCell +java/util/concurrent/ConcurrentHashMap$EntrySetView +java/util/concurrent/ConcurrentHashMap$ForwardingNode +java/util/concurrent/ConcurrentHashMap$KeyIterator +java/util/concurrent/ConcurrentHashMap$KeySetView +java/util/concurrent/ConcurrentHashMap$Node +java/util/concurrent/ConcurrentHashMap$Segment +java/util/concurrent/ConcurrentHashMap$Traverser +java/util/concurrent/ConcurrentHashMap$ValueIterator +java/util/concurrent/ConcurrentHashMap$ValuesView +java/util/concurrent/ConcurrentMap +java/util/concurrent/CopyOnWriteArrayList +java/util/concurrent/DelayQueue +java/util/concurrent/Delayed +java/util/concurrent/Executor +java/util/concurrent/ExecutorService +java/util/concurrent/Executors +java/util/concurrent/RejectedExecutionHandler +java/util/concurrent/SynchronousQueue +java/util/concurrent/SynchronousQueue$TransferStack +java/util/concurrent/SynchronousQueue$TransferStack$SNode +java/util/concurrent/SynchronousQueue$Transferer +java/util/concurrent/ThreadFactory +java/util/concurrent/ThreadPoolExecutor +java/util/concurrent/ThreadPoolExecutor$AbortPolicy +java/util/concurrent/ThreadPoolExecutor$Worker +java/util/concurrent/TimeUnit +java/util/concurrent/TimeUnit$1 +java/util/concurrent/TimeUnit$2 +java/util/concurrent/TimeUnit$3 +java/util/concurrent/TimeUnit$4 +java/util/concurrent/TimeUnit$5 +java/util/concurrent/TimeUnit$6 +java/util/concurrent/TimeUnit$7 +java/util/concurrent/atomic/AtomicBoolean +java/util/concurrent/atomic/AtomicInteger +java/util/concurrent/atomic/AtomicLong +java/util/concurrent/atomic/AtomicMarkableReference +java/util/concurrent/atomic/AtomicMarkableReference$Pair +java/util/concurrent/atomic/AtomicReferenceFieldUpdater +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl$1 +java/util/concurrent/locks/AbstractOwnableSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject +java/util/concurrent/locks/AbstractQueuedSynchronizer$Node +java/util/concurrent/locks/Condition +java/util/concurrent/locks/Lock +java/util/concurrent/locks/LockSupport +java/util/concurrent/locks/ReentrantLock +java/util/concurrent/locks/ReentrantLock$NonfairSync +java/util/concurrent/locks/ReentrantLock$Sync +java/util/function/BiFunction +java/util/jar/Attributes +java/util/jar/Attributes$Name +java/util/jar/JarEntry +java/util/jar/JarFile +java/util/jar/JarFile$JarEntryIterator +java/util/jar/JarFile$JarFileEntry +java/util/jar/JarVerifier +java/util/jar/JarVerifier$3 +java/util/jar/JavaUtilJarAccessImpl +java/util/jar/Manifest +java/util/jar/Manifest$FastInputStream +java/util/logging/Handler +java/util/logging/Level +java/util/logging/Level$KnownLevel +java/util/logging/LogManager +java/util/logging/LogManager$1 +java/util/logging/LogManager$2 +java/util/logging/LogManager$3 +java/util/logging/LogManager$5 +java/util/logging/LogManager$Cleaner +java/util/logging/LogManager$LogNode +java/util/logging/LogManager$LoggerContext +java/util/logging/LogManager$LoggerContext$1 +java/util/logging/LogManager$LoggerWeakRef +java/util/logging/LogManager$RootLogger +java/util/logging/LogManager$SystemLoggerContext +java/util/logging/Logger +java/util/logging/Logger$1 +java/util/logging/LoggingPermission +java/util/logging/LoggingProxyImpl +java/util/spi/CalendarDataProvider +java/util/spi/CurrencyNameProvider +java/util/spi/LocaleNameProvider +java/util/spi/LocaleServiceProvider +java/util/spi/ResourceBundleControlProvider +java/util/spi/TimeZoneNameProvider +java/util/zip/CRC32 +java/util/zip/Checksum +java/util/zip/DeflaterOutputStream +java/util/zip/GZIPInputStream +java/util/zip/Inflater +java/util/zip/InflaterInputStream +java/util/zip/ZStreamRef +java/util/zip/ZipCoder +java/util/zip/ZipConstants +java/util/zip/ZipEntry +java/util/zip/ZipFile +java/util/zip/ZipFile$1 +java/util/zip/ZipFile$ZipEntryIterator +java/util/zip/ZipFile$ZipFileInflaterInputStream +java/util/zip/ZipFile$ZipFileInputStream +java/util/zip/ZipInputStream +java/util/zip/ZipUtils +javax/accessibility/Accessible +javax/accessibility/AccessibleAction +javax/accessibility/AccessibleBundle +javax/accessibility/AccessibleComponent +javax/accessibility/AccessibleContext +javax/accessibility/AccessibleExtendedComponent +javax/accessibility/AccessibleRelationSet +javax/accessibility/AccessibleState +javax/accessibility/AccessibleText +javax/accessibility/AccessibleValue +javax/security/auth/Destroyable +javax/sound/sampled/Control$Type +javax/sound/sampled/DataLine +javax/sound/sampled/DataLine$Info +javax/sound/sampled/FloatControl$Type +javax/sound/sampled/Line +javax/sound/sampled/Line$Info +javax/sound/sampled/LineUnavailableException +javax/sound/sampled/UnsupportedAudioFileException +javax/swing/AbstractAction +javax/swing/AbstractButton +javax/swing/AbstractButton$AccessibleAbstractButton +javax/swing/AbstractButton$Handler +javax/swing/AbstractCellEditor +javax/swing/AbstractListModel +javax/swing/Action +javax/swing/ActionMap +javax/swing/AncestorNotifier +javax/swing/ArrayTable +javax/swing/BorderFactory +javax/swing/BoundedRangeModel +javax/swing/Box +javax/swing/Box$Filler +javax/swing/BoxLayout +javax/swing/BufferStrategyPaintManager +javax/swing/BufferStrategyPaintManager$BufferInfo +javax/swing/ButtonGroup +javax/swing/ButtonModel +javax/swing/CellEditor +javax/swing/CellRendererPane +javax/swing/ClientPropertyKey +javax/swing/ClientPropertyKey$1 +javax/swing/ComboBoxEditor +javax/swing/ComboBoxModel +javax/swing/ComponentInputMap +javax/swing/DefaultBoundedRangeModel +javax/swing/DefaultButtonModel +javax/swing/DefaultCellEditor +javax/swing/DefaultCellEditor$1 +javax/swing/DefaultCellEditor$EditorDelegate +javax/swing/DefaultComboBoxModel +javax/swing/DefaultListCellRenderer +javax/swing/DefaultListCellRenderer$UIResource +javax/swing/DefaultListModel +javax/swing/DefaultListSelectionModel +javax/swing/DefaultSingleSelectionModel +javax/swing/DropMode +javax/swing/FocusManager +javax/swing/GrayFilter +javax/swing/Icon +javax/swing/ImageIcon +javax/swing/ImageIcon$1 +javax/swing/ImageIcon$2 +javax/swing/ImageIcon$2$1 +javax/swing/ImageIcon$3 +javax/swing/InputMap +javax/swing/InternalFrameFocusTraversalPolicy +javax/swing/JButton +javax/swing/JCheckBox +javax/swing/JCheckBoxMenuItem +javax/swing/JCheckBoxMenuItem$AccessibleJCheckBoxMenuItem +javax/swing/JComboBox +javax/swing/JComboBox$1 +javax/swing/JComboBox$KeySelectionManager +javax/swing/JComponent +javax/swing/JComponent$1 +javax/swing/JComponent$2 +javax/swing/JComponent$AccessibleJComponent +javax/swing/JDialog +javax/swing/JEditorPane +javax/swing/JFrame +javax/swing/JInternalFrame +javax/swing/JLabel +javax/swing/JLayer +javax/swing/JLayeredPane +javax/swing/JList +javax/swing/JList$3 +javax/swing/JList$ListSelectionHandler +javax/swing/JMenu +javax/swing/JMenu$MenuChangeListener +javax/swing/JMenu$WinListener +javax/swing/JMenuBar +javax/swing/JMenuItem +javax/swing/JMenuItem$AccessibleJMenuItem +javax/swing/JMenuItem$MenuItemFocusListener +javax/swing/JPanel +javax/swing/JPopupMenu +javax/swing/JPopupMenu$Separator +javax/swing/JProgressBar +javax/swing/JProgressBar$ModelListener +javax/swing/JRadioButton +javax/swing/JRadioButtonMenuItem +javax/swing/JRootPane +javax/swing/JRootPane$1 +javax/swing/JRootPane$RootLayout +javax/swing/JScrollBar +javax/swing/JScrollBar$ModelListener +javax/swing/JScrollPane +javax/swing/JScrollPane$ScrollBar +javax/swing/JSeparator +javax/swing/JSlider +javax/swing/JSlider$ModelListener +javax/swing/JSplitPane +javax/swing/JTabbedPane +javax/swing/JTabbedPane$ModelListener +javax/swing/JTabbedPane$Page +javax/swing/JTable +javax/swing/JTable$2 +javax/swing/JTable$5 +javax/swing/JTable$Resizable2 +javax/swing/JTable$Resizable3 +javax/swing/JTextArea +javax/swing/JTextField +javax/swing/JTextField$NotifyAction +javax/swing/JTextField$ScrollRepainter +javax/swing/JToggleButton +javax/swing/JToggleButton$ToggleButtonModel +javax/swing/JToolBar +javax/swing/JToolBar$DefaultToolBarLayout +javax/swing/JToolBar$Separator +javax/swing/JToolTip +javax/swing/JTree +javax/swing/JTree$TreeModelHandler +javax/swing/JTree$TreeSelectionRedirector +javax/swing/JViewport +javax/swing/JViewport$ViewListener +javax/swing/JWindow +javax/swing/KeyStroke +javax/swing/KeyboardManager +javax/swing/KeyboardManager$ComponentKeyStrokePair +javax/swing/LayoutComparator +javax/swing/LayoutFocusTraversalPolicy +javax/swing/ListCellRenderer +javax/swing/ListModel +javax/swing/ListSelectionModel +javax/swing/LookAndFeel +javax/swing/MenuElement +javax/swing/MenuSelectionManager +javax/swing/MultiUIDefaults +javax/swing/MutableComboBoxModel +javax/swing/RepaintManager +javax/swing/RepaintManager$2 +javax/swing/RepaintManager$3 +javax/swing/RepaintManager$DisplayChangedHandler +javax/swing/RepaintManager$PaintManager +javax/swing/RepaintManager$ProcessingRunnable +javax/swing/RootPaneContainer +javax/swing/ScrollPaneConstants +javax/swing/ScrollPaneLayout +javax/swing/ScrollPaneLayout$UIResource +javax/swing/Scrollable +javax/swing/SingleSelectionModel +javax/swing/SizeRequirements +javax/swing/SortingFocusTraversalPolicy +javax/swing/SwingConstants +javax/swing/SwingContainerOrderFocusTraversalPolicy +javax/swing/SwingDefaultFocusTraversalPolicy +javax/swing/SwingPaintEventDispatcher +javax/swing/SwingUtilities +javax/swing/SwingUtilities$SharedOwnerFrame +javax/swing/Timer +javax/swing/Timer$DoPostEvent +javax/swing/TimerQueue +javax/swing/TimerQueue$1 +javax/swing/TimerQueue$DelayedTimer +javax/swing/ToolTipManager +javax/swing/ToolTipManager$AccessibilityKeyListener +javax/swing/ToolTipManager$MoveBeforeEnterListener +javax/swing/ToolTipManager$insideTimerAction +javax/swing/ToolTipManager$outsideTimerAction +javax/swing/ToolTipManager$stillInsideTimerAction +javax/swing/TransferHandler +javax/swing/TransferHandler$DropHandler +javax/swing/TransferHandler$HasGetTransferHandler +javax/swing/TransferHandler$SwingDropTarget +javax/swing/TransferHandler$TransferAction +javax/swing/TransferHandler$TransferSupport +javax/swing/UIDefaults +javax/swing/UIDefaults$ActiveValue +javax/swing/UIDefaults$LazyInputMap +javax/swing/UIDefaults$LazyValue +javax/swing/UIDefaults$TextAndMnemonicHashMap +javax/swing/UIManager +javax/swing/UIManager$1 +javax/swing/UIManager$2 +javax/swing/UIManager$LAFState +javax/swing/UIManager$LookAndFeelInfo +javax/swing/UnsupportedLookAndFeelException +javax/swing/ViewportLayout +javax/swing/WindowConstants +javax/swing/border/AbstractBorder +javax/swing/border/BevelBorder +javax/swing/border/Border +javax/swing/border/CompoundBorder +javax/swing/border/EmptyBorder +javax/swing/border/EtchedBorder +javax/swing/border/LineBorder +javax/swing/border/MatteBorder +javax/swing/border/TitledBorder +javax/swing/event/AncestorEvent +javax/swing/event/AncestorListener +javax/swing/event/CaretEvent +javax/swing/event/CaretListener +javax/swing/event/CellEditorListener +javax/swing/event/ChangeEvent +javax/swing/event/ChangeListener +javax/swing/event/DocumentEvent +javax/swing/event/DocumentEvent$ElementChange +javax/swing/event/DocumentEvent$EventType +javax/swing/event/DocumentListener +javax/swing/event/EventListenerList +javax/swing/event/ListDataEvent +javax/swing/event/ListDataListener +javax/swing/event/ListSelectionEvent +javax/swing/event/ListSelectionListener +javax/swing/event/MenuDragMouseListener +javax/swing/event/MenuEvent +javax/swing/event/MenuKeyListener +javax/swing/event/MenuListener +javax/swing/event/MouseInputAdapter +javax/swing/event/MouseInputListener +javax/swing/event/PopupMenuListener +javax/swing/event/RowSorterListener +javax/swing/event/SwingPropertyChangeSupport +javax/swing/event/TableColumnModelEvent +javax/swing/event/TableColumnModelListener +javax/swing/event/TableModelEvent +javax/swing/event/TableModelListener +javax/swing/event/TreeExpansionListener +javax/swing/event/TreeModelEvent +javax/swing/event/TreeModelListener +javax/swing/event/TreeSelectionEvent +javax/swing/event/TreeSelectionListener +javax/swing/event/UndoableEditEvent +javax/swing/event/UndoableEditListener +javax/swing/filechooser/FileFilter +javax/swing/plaf/ActionMapUIResource +javax/swing/plaf/BorderUIResource +javax/swing/plaf/BorderUIResource$CompoundBorderUIResource +javax/swing/plaf/BorderUIResource$EmptyBorderUIResource +javax/swing/plaf/BorderUIResource$LineBorderUIResource +javax/swing/plaf/ButtonUI +javax/swing/plaf/ColorUIResource +javax/swing/plaf/ComboBoxUI +javax/swing/plaf/ComponentInputMapUIResource +javax/swing/plaf/ComponentUI +javax/swing/plaf/DimensionUIResource +javax/swing/plaf/FontUIResource +javax/swing/plaf/InputMapUIResource +javax/swing/plaf/InsetsUIResource +javax/swing/plaf/LabelUI +javax/swing/plaf/ListUI +javax/swing/plaf/MenuBarUI +javax/swing/plaf/MenuItemUI +javax/swing/plaf/PanelUI +javax/swing/plaf/PopupMenuUI +javax/swing/plaf/ProgressBarUI +javax/swing/plaf/RootPaneUI +javax/swing/plaf/ScrollBarUI +javax/swing/plaf/ScrollPaneUI +javax/swing/plaf/SeparatorUI +javax/swing/plaf/SliderUI +javax/swing/plaf/SplitPaneUI +javax/swing/plaf/TabbedPaneUI +javax/swing/plaf/TableHeaderUI +javax/swing/plaf/TableUI +javax/swing/plaf/TextUI +javax/swing/plaf/ToolBarUI +javax/swing/plaf/TreeUI +javax/swing/plaf/UIResource +javax/swing/plaf/ViewportUI +javax/swing/plaf/basic/BasicArrowButton +javax/swing/plaf/basic/BasicBorders +javax/swing/plaf/basic/BasicBorders$ButtonBorder +javax/swing/plaf/basic/BasicBorders$MarginBorder +javax/swing/plaf/basic/BasicBorders$RadioButtonBorder +javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder +javax/swing/plaf/basic/BasicBorders$SplitPaneBorder +javax/swing/plaf/basic/BasicBorders$SplitPaneDividerBorder +javax/swing/plaf/basic/BasicButtonListener +javax/swing/plaf/basic/BasicButtonUI +javax/swing/plaf/basic/BasicCheckBoxMenuItemUI +javax/swing/plaf/basic/BasicComboBoxEditor +javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField +javax/swing/plaf/basic/BasicComboBoxEditor$UIResource +javax/swing/plaf/basic/BasicComboBoxRenderer +javax/swing/plaf/basic/BasicComboBoxRenderer$UIResource +javax/swing/plaf/basic/BasicComboBoxUI +javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager +javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager +javax/swing/plaf/basic/BasicComboBoxUI$Handler +javax/swing/plaf/basic/BasicComboBoxUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicComboPopup +javax/swing/plaf/basic/BasicComboPopup$1 +javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass +javax/swing/plaf/basic/BasicComboPopup$Handler +javax/swing/plaf/basic/BasicGraphicsUtils +javax/swing/plaf/basic/BasicHTML +javax/swing/plaf/basic/BasicLabelUI +javax/swing/plaf/basic/BasicListUI +javax/swing/plaf/basic/BasicListUI$Handler +javax/swing/plaf/basic/BasicListUI$ListTransferHandler +javax/swing/plaf/basic/BasicLookAndFeel +javax/swing/plaf/basic/BasicLookAndFeel$1 +javax/swing/plaf/basic/BasicLookAndFeel$2 +javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper +javax/swing/plaf/basic/BasicMenuBarUI +javax/swing/plaf/basic/BasicMenuBarUI$Handler +javax/swing/plaf/basic/BasicMenuItemUI +javax/swing/plaf/basic/BasicMenuItemUI$Handler +javax/swing/plaf/basic/BasicMenuUI +javax/swing/plaf/basic/BasicMenuUI$Handler +javax/swing/plaf/basic/BasicPanelUI +javax/swing/plaf/basic/BasicPopupMenuUI +javax/swing/plaf/basic/BasicPopupMenuUI$BasicMenuKeyListener +javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener +javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper +javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper$1 +javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber +javax/swing/plaf/basic/BasicProgressBarUI +javax/swing/plaf/basic/BasicProgressBarUI$Handler +javax/swing/plaf/basic/BasicRadioButtonMenuItemUI +javax/swing/plaf/basic/BasicRadioButtonUI +javax/swing/plaf/basic/BasicRootPaneUI +javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap +javax/swing/plaf/basic/BasicScrollBarUI +javax/swing/plaf/basic/BasicScrollBarUI$ArrowButtonListener +javax/swing/plaf/basic/BasicScrollBarUI$Handler +javax/swing/plaf/basic/BasicScrollBarUI$ModelListener +javax/swing/plaf/basic/BasicScrollBarUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicScrollBarUI$ScrollListener +javax/swing/plaf/basic/BasicScrollBarUI$TrackListener +javax/swing/plaf/basic/BasicScrollPaneUI +javax/swing/plaf/basic/BasicScrollPaneUI$Handler +javax/swing/plaf/basic/BasicSeparatorUI +javax/swing/plaf/basic/BasicSliderUI +javax/swing/plaf/basic/BasicSliderUI$Actions +javax/swing/plaf/basic/BasicSliderUI$Handler +javax/swing/plaf/basic/BasicSliderUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicSliderUI$ScrollListener +javax/swing/plaf/basic/BasicSliderUI$TrackListener +javax/swing/plaf/basic/BasicSplitPaneDivider +javax/swing/plaf/basic/BasicSplitPaneDivider$DividerLayout +javax/swing/plaf/basic/BasicSplitPaneDivider$MouseHandler +javax/swing/plaf/basic/BasicSplitPaneDivider$OneTouchActionHandler +javax/swing/plaf/basic/BasicSplitPaneUI +javax/swing/plaf/basic/BasicSplitPaneUI$1 +javax/swing/plaf/basic/BasicSplitPaneUI$BasicHorizontalLayoutManager +javax/swing/plaf/basic/BasicSplitPaneUI$Handler +javax/swing/plaf/basic/BasicTabbedPaneUI +javax/swing/plaf/basic/BasicTabbedPaneUI$Handler +javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneLayout +javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneScrollLayout +javax/swing/plaf/basic/BasicTableHeaderUI +javax/swing/plaf/basic/BasicTableHeaderUI$1 +javax/swing/plaf/basic/BasicTableHeaderUI$MouseInputHandler +javax/swing/plaf/basic/BasicTableUI +javax/swing/plaf/basic/BasicTableUI$Handler +javax/swing/plaf/basic/BasicTableUI$TableTransferHandler +javax/swing/plaf/basic/BasicTextAreaUI +javax/swing/plaf/basic/BasicTextFieldUI +javax/swing/plaf/basic/BasicTextUI +javax/swing/plaf/basic/BasicTextUI$BasicCaret +javax/swing/plaf/basic/BasicTextUI$BasicCursor +javax/swing/plaf/basic/BasicTextUI$BasicHighlighter +javax/swing/plaf/basic/BasicTextUI$DragListener +javax/swing/plaf/basic/BasicTextUI$FocusAction +javax/swing/plaf/basic/BasicTextUI$RootView +javax/swing/plaf/basic/BasicTextUI$TextActionWrapper +javax/swing/plaf/basic/BasicTextUI$TextTransferHandler +javax/swing/plaf/basic/BasicTextUI$UpdateHandler +javax/swing/plaf/basic/BasicToggleButtonUI +javax/swing/plaf/basic/BasicToolBarSeparatorUI +javax/swing/plaf/basic/BasicToolBarUI +javax/swing/plaf/basic/BasicToolBarUI$DockingListener +javax/swing/plaf/basic/BasicToolBarUI$Handler +javax/swing/plaf/basic/BasicTreeUI +javax/swing/plaf/basic/BasicTreeUI$Actions +javax/swing/plaf/basic/BasicTreeUI$Handler +javax/swing/plaf/basic/BasicTreeUI$NodeDimensionsHandler +javax/swing/plaf/basic/BasicTreeUI$TreeTransferHandler +javax/swing/plaf/basic/BasicViewportUI +javax/swing/plaf/basic/ComboPopup +javax/swing/plaf/basic/DefaultMenuLayout +javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag +javax/swing/plaf/basic/LazyActionMap +javax/swing/plaf/metal/DefaultMetalTheme +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 +javax/swing/plaf/metal/MetalBorders +javax/swing/plaf/metal/MetalBorders$ButtonBorder +javax/swing/plaf/metal/MetalBorders$Flush3DBorder +javax/swing/plaf/metal/MetalBorders$MenuBarBorder +javax/swing/plaf/metal/MetalBorders$MenuItemBorder +javax/swing/plaf/metal/MetalBorders$PopupMenuBorder +javax/swing/plaf/metal/MetalBorders$RolloverButtonBorder +javax/swing/plaf/metal/MetalBorders$RolloverMarginBorder +javax/swing/plaf/metal/MetalBorders$ScrollPaneBorder +javax/swing/plaf/metal/MetalBorders$TextFieldBorder +javax/swing/plaf/metal/MetalBorders$ToggleButtonBorder +javax/swing/plaf/metal/MetalBorders$ToolBarBorder +javax/swing/plaf/metal/MetalBumps +javax/swing/plaf/metal/MetalButtonUI +javax/swing/plaf/metal/MetalCheckBoxUI +javax/swing/plaf/metal/MetalComboBoxButton +javax/swing/plaf/metal/MetalComboBoxButton$1 +javax/swing/plaf/metal/MetalComboBoxEditor +javax/swing/plaf/metal/MetalComboBoxEditor$1 +javax/swing/plaf/metal/MetalComboBoxEditor$EditorBorder +javax/swing/plaf/metal/MetalComboBoxEditor$UIResource +javax/swing/plaf/metal/MetalComboBoxIcon +javax/swing/plaf/metal/MetalComboBoxUI +javax/swing/plaf/metal/MetalComboBoxUI$MetalComboBoxLayoutManager +javax/swing/plaf/metal/MetalComboBoxUI$MetalPropertyChangeListener +javax/swing/plaf/metal/MetalIconFactory +javax/swing/plaf/metal/MetalIconFactory$CheckBoxIcon +javax/swing/plaf/metal/MetalIconFactory$CheckBoxMenuItemIcon +javax/swing/plaf/metal/MetalIconFactory$FolderIcon16 +javax/swing/plaf/metal/MetalIconFactory$HorizontalSliderThumbIcon +javax/swing/plaf/metal/MetalIconFactory$MenuArrowIcon +javax/swing/plaf/metal/MetalIconFactory$MenuItemArrowIcon +javax/swing/plaf/metal/MetalIconFactory$RadioButtonIcon +javax/swing/plaf/metal/MetalIconFactory$RadioButtonMenuItemIcon +javax/swing/plaf/metal/MetalIconFactory$TreeFolderIcon +javax/swing/plaf/metal/MetalIconFactory$VerticalSliderThumbIcon +javax/swing/plaf/metal/MetalLabelUI +javax/swing/plaf/metal/MetalLookAndFeel +javax/swing/plaf/metal/MetalLookAndFeel$AATextListener +javax/swing/plaf/metal/MetalLookAndFeel$FontActiveValue +javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue +javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue$1 +javax/swing/plaf/metal/MetalPopupMenuSeparatorUI +javax/swing/plaf/metal/MetalProgressBarUI +javax/swing/plaf/metal/MetalRadioButtonUI +javax/swing/plaf/metal/MetalRootPaneUI +javax/swing/plaf/metal/MetalScrollBarUI +javax/swing/plaf/metal/MetalScrollBarUI$ScrollBarListener +javax/swing/plaf/metal/MetalScrollButton +javax/swing/plaf/metal/MetalScrollPaneUI +javax/swing/plaf/metal/MetalScrollPaneUI$1 +javax/swing/plaf/metal/MetalSeparatorUI +javax/swing/plaf/metal/MetalSliderUI +javax/swing/plaf/metal/MetalSliderUI$MetalPropertyListener +javax/swing/plaf/metal/MetalSplitPaneDivider +javax/swing/plaf/metal/MetalSplitPaneDivider$1 +javax/swing/plaf/metal/MetalSplitPaneDivider$2 +javax/swing/plaf/metal/MetalSplitPaneUI +javax/swing/plaf/metal/MetalTabbedPaneUI +javax/swing/plaf/metal/MetalTabbedPaneUI$TabbedPaneLayout +javax/swing/plaf/metal/MetalTextFieldUI +javax/swing/plaf/metal/MetalTheme +javax/swing/plaf/metal/MetalToggleButtonUI +javax/swing/plaf/metal/MetalToolBarUI +javax/swing/plaf/metal/MetalToolBarUI$MetalDockingListener +javax/swing/plaf/metal/MetalTreeUI +javax/swing/plaf/metal/MetalTreeUI$LineListener +javax/swing/plaf/metal/OceanTheme javax/swing/plaf/metal/OceanTheme$1 javax/swing/plaf/metal/OceanTheme$2 javax/swing/plaf/metal/OceanTheme$3 javax/swing/plaf/metal/OceanTheme$4 javax/swing/plaf/metal/OceanTheme$5 javax/swing/plaf/metal/OceanTheme$6 -javax/swing/RepaintManager -javax/swing/RepaintManager$DisplayChangedHandler -javax/swing/SwingPaintEventDispatcher -sun/awt/PaintEventDispatcher -javax/swing/UIManager$2 -java/awt/PopupMenu -java/awt/Menu -java/awt/MenuItem -java/awt/MenuComponent -java/io/ObjectOutputStream -java/io/ObjectOutput -java/io/DataOutput -java/io/ObjectStreamConstants -java/io/PrintWriter -java/io/ObjectInputStream -java/io/ObjectInput -java/awt/Event -java/awt/im/InputContext -java/awt/event/MouseWheelEvent -java/awt/BufferCapabilities -sun/awt/CausedFocusEvent$Cause -java/awt/PointerInfo -java/awt/Component$BaselineResizeBehavior -java/awt/FontMetrics -java/awt/Image -java/awt/image/ImageProducer -java/awt/image/VolatileImage -java/awt/im/InputMethodRequests -java/awt/event/FocusEvent -java/awt/event/InputMethodEvent -java/awt/event/HierarchyEvent -javax/accessibility/AccessibleStateSet -com/sun/swing/internal/plaf/metal/resources/metal -sun/util/ResourceBundleEnumeration -com/sun/swing/internal/plaf/basic/resources/basic -javax/swing/plaf/basic/BasicPanelUI -javax/swing/plaf/PanelUI -javax/swing/plaf/ComponentUI -sun/reflect/misc/MethodUtil -sun/reflect/misc/MethodUtil$1 -java/util/jar/JarFile -java/util/zip/ZipFile -java/util/zip/ZipConstants -java/util/jar/JavaUtilJarAccessImpl -sun/misc/JavaUtilJarAccess -sun/misc/JarIndex -java/util/zip/ZipEntry -java/util/jar/JarFile$JarFileEntry -java/util/jar/JarEntry -sun/misc/URLClassPath$JarLoader$2 -sun/net/www/protocol/jar/JarURLConnection -java/net/JarURLConnection -sun/net/www/protocol/jar/JarFileFactory -sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController -java/net/HttpURLConnection -sun/net/www/protocol/jar/URLJarFile -sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry -sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream -java/util/zip/ZipFile$ZipFileInputStream -java/security/AllPermissionCollection -java/lang/IllegalAccessException -javax/swing/JPasswordField -javax/swing/JTextField -javax/swing/text/JTextComponent -javax/swing/Scrollable -javax/swing/JLayeredPane -javax/swing/JRootPane$1 -javax/swing/ArrayTable -javax/swing/JInternalFrame -javax/swing/JRootPane$RootLayout -javax/swing/BufferStrategyPaintManager -javax/swing/RepaintManager$PaintManager -javax/swing/plaf/metal/MetalRootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI -javax/swing/plaf/RootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap -javax/swing/plaf/ComponentInputMapUIResource -javax/swing/ComponentInputMap -javax/swing/InputMap -javax/swing/plaf/InputMapUIResource -javax/swing/KeyStroke -java/awt/VKCollection -sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl -javax/swing/plaf/basic/LazyActionMap -javax/swing/plaf/ActionMapUIResource -javax/swing/ActionMap -javax/swing/LayoutFocusTraversalPolicy -javax/swing/SortingFocusTraversalPolicy -javax/swing/InternalFrameFocusTraversalPolicy -javax/swing/SwingContainerOrderFocusTraversalPolicy -javax/swing/SwingDefaultFocusTraversalPolicy -javax/swing/LayoutComparator -javax/swing/plaf/metal/MetalLabelUI -javax/swing/plaf/basic/BasicLabelUI -javax/swing/plaf/LabelUI -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 -javax/swing/plaf/basic/BasicHTML -sun/awt/NullComponentPeer -java/awt/event/WindowEvent -java/awt/EventQueue$1 -java/awt/EventDispatchThread$1 -java/awt/Conditional -java/awt/EventDispatchThread$HierarchyEventFilter -java/awt/EventFilter$FilterAction -sun/awt/dnd/SunDropTargetEvent -java/awt/event/ActionEvent -java/util/jar/Manifest -java/io/ByteArrayInputStream -java/util/jar/Attributes -java/util/jar/Manifest$FastInputStream -java/util/jar/Attributes$Name -sun/misc/ASCIICaseInsensitiveComparator -java/util/jar/JarVerifier -java/io/ByteArrayOutputStream -sun/misc/ExtensionDependency -java/lang/Package -sun/security/util/ManifestEntryVerifier -java/security/Provider -java/security/Provider$ServiceKey -java/security/Provider$EngineDescription -java/security/Security -java/security/Security$1 -sun/misc/FloatingDecimal -sun/misc/FloatingDecimal$1 -sun/security/provider/NativePRNG -java/security/SecureRandomSpi -sun/security/provider/NativePRNG$1 -sun/security/provider/NativePRNG$RandomIO -sun/misc/BASE64Decoder -sun/misc/CharacterDecoder -sun/security/util/SignatureFileVerifier -java/awt/event/KeyAdapter -java/lang/NumberFormatException -java/lang/IllegalArgumentException -java/io/FileWriter -java/net/Authenticator -java/net/MalformedURLException -javax/swing/text/Element -javax/swing/text/Document -javax/swing/text/PlainDocument +javax/swing/plaf/synth/SynthConstants +javax/swing/plaf/synth/SynthUI +javax/swing/table/AbstractTableModel +javax/swing/table/DefaultTableCellRenderer +javax/swing/table/DefaultTableColumnModel +javax/swing/table/DefaultTableModel +javax/swing/table/JTableHeader +javax/swing/table/TableCellEditor +javax/swing/table/TableCellRenderer +javax/swing/table/TableColumn +javax/swing/table/TableColumnModel +javax/swing/table/TableModel javax/swing/text/AbstractDocument -javax/swing/text/GapContent -javax/swing/text/AbstractDocument$Content -javax/swing/text/GapVector -javax/swing/text/GapContent$MarkVector -javax/swing/text/GapContent$MarkData -javax/swing/text/StyleContext +javax/swing/text/AbstractDocument$1 +javax/swing/text/AbstractDocument$AbstractElement javax/swing/text/AbstractDocument$AttributeContext -javax/swing/text/StyleConstants -javax/swing/text/StyleConstants$CharacterConstants -javax/swing/text/AttributeSet$CharacterAttribute -javax/swing/text/StyleConstants$FontConstants -javax/swing/text/AttributeSet$FontAttribute -javax/swing/text/StyleConstants$ColorConstants -javax/swing/text/AttributeSet$ColorAttribute -javax/swing/text/StyleConstants$ParagraphConstants -javax/swing/text/AttributeSet$ParagraphAttribute -javax/swing/text/StyleContext$FontKey -javax/swing/text/SimpleAttributeSet -javax/swing/text/MutableAttributeSet -javax/swing/text/AttributeSet -javax/swing/text/SimpleAttributeSet$EmptyAttributeSet -javax/swing/text/StyleContext$NamedStyle -javax/swing/text/Style -javax/swing/text/StyleContext$SmallAttributeSet +javax/swing/text/AbstractDocument$BidiElement javax/swing/text/AbstractDocument$BidiRootElement javax/swing/text/AbstractDocument$BranchElement -javax/swing/text/AbstractDocument$AbstractElement -javax/swing/tree/TreeNode -javax/swing/text/AbstractDocument$1 -javax/swing/text/AbstractDocument$BidiElement -javax/swing/text/AbstractDocument$LeafElement -javax/swing/text/GapContent$StickyPosition -javax/swing/text/Position -javax/swing/text/StyleContext$KeyEnumeration -javax/swing/text/GapContent$InsertUndo -javax/swing/undo/AbstractUndoableEdit -javax/swing/undo/UndoableEdit +javax/swing/text/AbstractDocument$Content javax/swing/text/AbstractDocument$DefaultDocumentEvent -javax/swing/event/DocumentEvent -javax/swing/undo/CompoundEdit -javax/swing/event/DocumentEvent$EventType -javax/swing/text/Segment -java/text/CharacterIterator -javax/swing/text/Utilities -javax/swing/text/SegmentCache -javax/swing/text/SegmentCache$CachedSegment -javax/swing/event/UndoableEditEvent javax/swing/text/AbstractDocument$ElementEdit -javax/swing/event/DocumentEvent$ElementChange -java/net/Socket -java/net/InetAddress -java/net/InetAddress$Cache -java/net/InetAddress$Cache$Type -java/net/InetAddressImplFactory -java/net/Inet4AddressImpl -java/net/InetAddressImpl -java/net/InetAddress$1 -sun/net/spi/nameservice/NameService -sun/net/util/IPAddressUtil -java/util/RandomAccessSubList -java/util/SubList -java/util/SubList$1 -java/util/AbstractList$ListItr -java/net/Inet4Address -java/net/InetSocketAddress -java/net/SocketAddress -java/net/SocksSocketImpl -java/net/SocksConsts -java/net/PlainSocketImpl -java/net/SocketImpl -java/net/SocketOptions -java/net/SocketException -java/net/SocksSocketImpl$5 -java/net/ProxySelector -sun/net/spi/DefaultProxySelector -sun/net/spi/DefaultProxySelector$1 -sun/net/NetProperties -sun/net/NetProperties$1 -sun/net/spi/DefaultProxySelector$NonProxyInfo -java/net/Inet6Address -java/net/URI -java/net/URI$Parser -java/net/Proxy -java/net/Proxy$Type -java/net/ConnectException -javax/swing/JMenu -javax/swing/MenuElement -javax/swing/JMenuItem -javax/swing/AbstractButton -java/awt/ItemSelectable -javax/swing/event/MenuListener -javax/swing/JCheckBoxMenuItem -javax/swing/Icon -javax/swing/JButton -java/awt/event/WindowListener -java/net/URLClassLoader$2 -javax/swing/ImageIcon -javax/swing/ImageIcon$1 -java/awt/MediaTracker -sun/misc/SoftCache$ValueCell -sun/awt/image/URLImageSource -sun/awt/image/InputStreamImageSource -sun/awt/image/ImageFetchable -sun/awt/image/ToolkitImage -java/awt/Image$1 -sun/awt/image/SurfaceManager$ImageAccessor -sun/awt/image/SurfaceManager -sun/awt/image/NativeLibLoader -java/awt/ImageMediaEntry -java/awt/MediaEntry -sun/awt/image/ImageRepresentation -java/awt/image/ImageConsumer -sun/awt/image/ImageWatched -sun/awt/image/ImageWatched$Link -sun/awt/image/ImageWatched$WeakLink -sun/awt/image/ImageConsumerQueue -sun/awt/image/ImageFetcher -sun/awt/image/FetcherInfo -sun/awt/image/ImageFetcher$1 -sun/awt/image/GifImageDecoder -sun/awt/image/ImageDecoder -sun/awt/image/GifFrame -java/awt/image/Raster -java/awt/image/DataBufferByte -java/awt/image/DataBuffer -java/awt/image/PixelInterleavedSampleModel -java/awt/image/ComponentSampleModel -java/awt/image/SampleModel -sun/awt/image/ByteInterleavedRaster -sun/awt/image/ByteComponentRaster -sun/awt/image/SunWritableRaster -java/awt/image/WritableRaster -java/awt/image/BufferedImage -java/awt/image/WritableRenderedImage -java/awt/image/RenderedImage -sun/awt/image/IntegerComponentRaster -sun/awt/image/BytePackedRaster -java/awt/Canvas -sun/font/FontDesignMetrics -sun/font/FontStrikeDesc -sun/font/CompositeStrike -sun/font/FontStrikeDisposer -sun/font/StrikeCache$SoftDisposerRef -sun/font/StrikeCache$DisposableStrike -sun/font/TrueTypeFont$TTDisposerRecord -sun/font/TrueTypeFont$1 -java/io/RandomAccessFile -java/nio/ByteBufferAsIntBufferB -java/nio/IntBuffer -sun/font/TrueTypeFont$DirectoryEntry -java/nio/ByteBufferAsShortBufferB -java/nio/ShortBuffer -sun/nio/cs/UTF_16 -sun/nio/cs/UTF_16$Decoder -sun/nio/cs/UnicodeDecoder -sun/font/FileFontStrike -sun/font/TrueTypeGlyphMapper -sun/font/CMap -sun/font/CMap$NullCMapClass -sun/font/CMap$CMapFormat4 -java/nio/ByteBufferAsCharBufferB -sun/font/FontDesignMetrics$KeyReference -sun/awt/image/PNGImageDecoder -sun/awt/image/PNGFilterInputStream -java/util/zip/InflaterInputStream -java/util/zip/Inflater -sun/awt/EventQueueItem -sun/awt/SunToolkit$3 -sun/awt/X11/XExposeEvent -sun/reflect/UnsafeBooleanFieldAccessorImpl -sun/awt/event/IgnorePaintEvent -java/awt/image/DataBufferInt -java/awt/image/SinglePixelPackedSampleModel -sun/awt/image/IntegerInterleavedRaster -sun/awt/image/OffScreenImage -sun/awt/image/BufImgSurfaceData -sun/java2d/opengl/GLXGraphicsConfig -sun/java2d/opengl/OGLGraphicsConfig -sun/java2d/x11/X11SurfaceData$X11PixmapSurfaceData -sun/awt/image/WritableRasterNative -sun/awt/image/DataBufferNative -sun/java2d/SurfaceManagerFactory -sun/java2d/opengl/GLXSurfaceData -sun/java2d/opengl/OGLSurfaceData -sun/font/CompositeGlyphMapper -sun/java2d/loops/FontInfo -java/util/Date -sun/util/calendar/CalendarSystem -sun/util/calendar/Gregorian -sun/util/calendar/BaseCalendar -sun/util/calendar/AbstractCalendar -java/util/TimeZone -java/lang/InheritableThreadLocal -sun/util/calendar/ZoneInfo -sun/util/calendar/ZoneInfoFile -sun/util/calendar/ZoneInfoFile$1 -java/util/TimeZone$1 -sun/util/calendar/Gregorian$Date -sun/util/calendar/BaseCalendar$Date -sun/util/calendar/CalendarDate -sun/util/calendar/CalendarUtils -java/util/TimeZone$DisplayNames -sun/util/TimeZoneNameUtility -sun/util/resources/TimeZoneNames -sun/util/resources/TimeZoneNamesBundle -sun/util/resources/TimeZoneNames_en -java/util/spi/TimeZoneNameProvider -java/lang/ProcessBuilder -java/lang/ProcessImpl -java/lang/UNIXProcess -java/lang/Process -java/lang/UNIXProcess$1 -java/net/ServerSocket -java/util/Random -java/util/concurrent/atomic/AtomicLong -java/lang/InternalError -java/io/StringReader -java/lang/SecurityException -java/io/FilterReader -java/lang/reflect/Proxy -java/lang/reflect/InvocationHandler -java/lang/NoSuchFieldException -java/lang/InstantiationException -java/lang/ArrayIndexOutOfBoundsException -java/lang/IndexOutOfBoundsException -javax/swing/JDialog -sun/awt/X11/XClipboard -sun/awt/datatransfer/SunClipboard -java/awt/datatransfer/Clipboard -java/awt/datatransfer/SystemFlavorMap -java/awt/datatransfer/FlavorMap -java/awt/datatransfer/FlavorTable -java/awt/datatransfer/SystemFlavorMap$1 -sun/net/ProgressMonitor -sun/net/DefaultProgressMeteringPolicy -sun/net/ProgressMeteringPolicy -java/awt/datatransfer/SystemFlavorMap$2 -java/awt/datatransfer/MimeType -java/io/Externalizable -java/awt/datatransfer/MimeTypeParameterList -sun/awt/datatransfer/DataTransferer -java/util/Collections$SynchronizedSet -java/util/Collections$SynchronizedCollection -java/awt/datatransfer/DataFlavor -java/awt/datatransfer/DataFlavor$1 -sun/awt/datatransfer/DataTransferer$CharsetComparator -sun/awt/datatransfer/DataTransferer$IndexedComparator -sun/nio/cs/UTF_16LE -sun/nio/cs/UTF_16BE -sun/awt/datatransfer/DataTransferer$DataFlavorComparator -java/rmi/Remote -sun/awt/datatransfer/DataTransferer$1 -sun/awt/X11/XDataTransferer -sun/awt/datatransfer/ToolkitThreadBlockedHandler -javax/imageio/ImageTypeSpecifier -sun/awt/X11/XSelection -sun/security/action/GetIntegerAction -sun/awt/X11/XSelection$IncrementalTransferHandler -sun/awt/X11/XSelection$SelectionEventHandler -java/awt/datatransfer/Transferable -java/io/EOFException -java/util/Vector$1 -java/util/zip/ZipFile$1 -java/util/zip/ZipFile$2 -java/util/jar/JarFile$1 -java/util/PropertyResourceBundle -java/util/ResourceBundle$Control$1 -java/util/Hashtable$EntrySet -java/lang/IllegalAccessError -java/text/MessageFormat -java/text/MessageFormat$Field -java/text/Format$Field -java/lang/CloneNotSupportedException -sun/reflect/MethodAccessorGenerator -sun/reflect/AccessorGenerator -sun/reflect/ClassFileConstants -java/lang/Void -sun/reflect/ByteVectorFactory -sun/reflect/ByteVectorImpl -sun/reflect/ByteVector -sun/reflect/ClassFileAssembler -sun/reflect/UTF8 -sun/reflect/Label -sun/reflect/Label$PatchInfo -sun/reflect/MethodAccessorGenerator$1 -sun/reflect/ClassDefiner -sun/reflect/ClassDefiner$1 -sun/reflect/BootstrapConstructorAccessorImpl -java/awt/event/ActionListener -javax/swing/Timer -javax/swing/Timer$DoPostEvent -javax/swing/TimerQueue -javax/swing/TimerQueue$1 -javax/swing/ToolTipManager -java/awt/event/MouseAdapter -javax/swing/ToolTipManager$insideTimerAction -javax/swing/ToolTipManager$outsideTimerAction -javax/swing/ToolTipManager$stillInsideTimerAction -sun/swing/UIAction -javax/swing/Action -javax/swing/ToolTipManager$MoveBeforeEnterListener -java/awt/event/MouseMotionAdapter -java/util/Hashtable$ValueCollection -javax/swing/event/CaretListener -javax/swing/JToolBar -javax/swing/JSplitPane -javax/swing/border/Border -javax/swing/JToggleButton -javax/swing/border/EmptyBorder -javax/swing/border/AbstractBorder -javax/swing/DefaultButtonModel -javax/swing/ButtonModel -javax/swing/AbstractButton$Handler -javax/swing/event/ChangeListener -java/awt/event/ItemListener -javax/swing/plaf/metal/MetalButtonUI -javax/swing/plaf/basic/BasicButtonUI -javax/swing/plaf/ButtonUI -javax/swing/plaf/metal/MetalBorders -javax/swing/plaf/BorderUIResource$CompoundBorderUIResource -javax/swing/border/CompoundBorder -javax/swing/plaf/metal/MetalBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$MarginBorder -javax/swing/plaf/basic/BasicButtonListener -java/awt/AWTEventMulticaster -java/awt/event/WindowFocusListener -java/awt/event/WindowStateListener -java/awt/event/AdjustmentListener -java/awt/event/TextListener -javax/swing/event/AncestorListener -java/beans/VetoableChangeListener -javax/swing/ButtonGroup -javax/swing/JToggleButton$ToggleButtonModel -javax/swing/plaf/metal/MetalToggleButtonUI -javax/swing/plaf/basic/BasicToggleButtonUI -javax/swing/plaf/metal/MetalBorders$ToggleButtonBorder -java/awt/CardLayout -javax/swing/Box -javax/swing/plaf/metal/MetalBorders$TextFieldBorder -javax/swing/plaf/metal/MetalBorders$Flush3DBorder -javax/swing/BoxLayout -javax/swing/JMenuBar -javax/swing/DefaultSingleSelectionModel -javax/swing/SingleSelectionModel -javax/swing/plaf/basic/BasicMenuBarUI -javax/swing/plaf/MenuBarUI -javax/swing/plaf/basic/DefaultMenuLayout -javax/swing/plaf/metal/MetalBorders$MenuBarBorder -javax/swing/plaf/basic/BasicMenuBarUI$Handler -javax/swing/KeyboardManager -javax/swing/event/MenuEvent -javax/swing/JMenu$MenuChangeListener -javax/swing/JMenuItem$MenuItemFocusListener -javax/swing/plaf/basic/BasicMenuUI -javax/swing/plaf/basic/BasicMenuItemUI -javax/swing/plaf/MenuItemUI -javax/swing/plaf/metal/MetalBorders$MenuItemBorder -javax/swing/plaf/metal/MetalIconFactory -javax/swing/plaf/metal/MetalIconFactory$MenuArrowIcon -javax/swing/plaf/basic/BasicMenuUI$Handler -javax/swing/event/MenuKeyListener -javax/swing/plaf/basic/BasicMenuItemUI$Handler -javax/swing/event/MenuDragMouseListener -javax/swing/event/MouseInputListener -javax/swing/event/ChangeEvent -java/awt/event/ContainerEvent -javax/swing/plaf/metal/MetalIconFactory$MenuItemArrowIcon -javax/swing/JPopupMenu -javax/swing/plaf/basic/BasicPopupMenuUI -javax/swing/plaf/PopupMenuUI -javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper -java/awt/event/AWTEventListenerProxy -java/awt/Toolkit$SelectiveAWTEventListener -java/awt/Toolkit$ToolkitEventMulticaster -javax/swing/plaf/basic/BasicLookAndFeel$1 -javax/swing/plaf/metal/MetalBorders$PopupMenuBorder -javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener -javax/swing/event/PopupMenuListener -javax/swing/plaf/basic/BasicPopupMenuUI$BasicMenuKeyListener -javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber -javax/swing/MenuSelectionManager -javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper -javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper$1 -java/awt/event/FocusAdapter -javax/swing/JMenu$WinListener -java/awt/event/WindowAdapter -javax/swing/JPopupMenu$Separator -javax/swing/JSeparator -javax/swing/plaf/metal/MetalPopupMenuSeparatorUI -javax/swing/plaf/metal/MetalSeparatorUI -javax/swing/plaf/basic/BasicSeparatorUI -javax/swing/plaf/SeparatorUI -javax/swing/JComboBox -javax/swing/event/ListDataListener -javax/swing/event/CaretEvent -javax/swing/text/TabExpander -javax/swing/JScrollBar -java/awt/Adjustable -javax/swing/event/MouseInputAdapter -javax/swing/JScrollBar$ModelListener -javax/swing/DefaultBoundedRangeModel -javax/swing/BoundedRangeModel -javax/swing/plaf/metal/MetalScrollBarUI -javax/swing/plaf/basic/BasicScrollBarUI -javax/swing/plaf/ScrollBarUI -javax/swing/plaf/metal/MetalBumps -javax/swing/plaf/metal/MetalScrollButton -javax/swing/plaf/basic/BasicArrowButton -javax/swing/plaf/basic/BasicScrollBarUI$TrackListener -javax/swing/plaf/basic/BasicScrollBarUI$ArrowButtonListener -javax/swing/plaf/basic/BasicScrollBarUI$ModelListener -javax/swing/plaf/metal/MetalScrollBarUI$ScrollBarListener -javax/swing/plaf/basic/BasicScrollBarUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicScrollBarUI$Handler -javax/swing/plaf/basic/BasicScrollBarUI$ScrollListener -javax/swing/CellRendererPane -java/util/HashMap$EntryIterator -javax/swing/border/MatteBorder -sun/font/StandardGlyphVector -java/awt/font/GlyphVector -sun/font/StandardGlyphVector$GlyphStrike -sun/font/CoreMetrics -sun/font/FontLineMetrics -java/awt/font/LineMetrics -javax/swing/ComboBoxModel -javax/swing/ListModel -javax/swing/ListCellRenderer -javax/swing/DefaultComboBoxModel -javax/swing/MutableComboBoxModel -javax/swing/AbstractListModel -javax/swing/JComboBox$1 -javax/swing/AncestorNotifier -javax/swing/plaf/metal/MetalComboBoxUI -javax/swing/plaf/basic/BasicComboBoxUI -javax/swing/plaf/ComboBoxUI -javax/swing/plaf/metal/MetalComboBoxUI$MetalComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboPopup -javax/swing/plaf/basic/ComboPopup -javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass -javax/swing/border/LineBorder -javax/swing/plaf/basic/BasicComboPopup$1 -javax/swing/JList -javax/swing/DropMode -javax/swing/DefaultListSelectionModel -javax/swing/ListSelectionModel -javax/swing/plaf/basic/BasicListUI -javax/swing/plaf/ListUI -javax/swing/plaf/basic/BasicListUI$ListTransferHandler -javax/swing/TransferHandler -javax/swing/TransferHandler$TransferAction -javax/swing/DefaultListCellRenderer$UIResource -javax/swing/DefaultListCellRenderer -javax/swing/TransferHandler$SwingDropTarget -java/awt/dnd/DropTargetContext -javax/swing/TransferHandler$DropHandler -javax/swing/TransferHandler$TransferSupport -javax/swing/plaf/basic/BasicListUI$Handler -javax/swing/event/ListSelectionListener -javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag -javax/swing/plaf/basic/BasicComboPopup$Handler -javax/swing/JScrollPane -javax/swing/ScrollPaneConstants -javax/swing/ScrollPaneLayout$UIResource -javax/swing/ScrollPaneLayout -javax/swing/JViewport -javax/swing/ViewportLayout -javax/swing/plaf/basic/BasicViewportUI -javax/swing/plaf/ViewportUI -javax/swing/JScrollPane$ScrollBar -javax/swing/JViewport$ViewListener -java/awt/event/ComponentAdapter -javax/swing/plaf/metal/MetalScrollPaneUI -javax/swing/plaf/basic/BasicScrollPaneUI -javax/swing/plaf/ScrollPaneUI -javax/swing/plaf/metal/MetalBorders$ScrollPaneBorder -javax/swing/plaf/basic/BasicScrollPaneUI$Handler -javax/swing/plaf/metal/MetalScrollPaneUI$1 -javax/swing/plaf/basic/BasicComboBoxRenderer$UIResource -javax/swing/plaf/basic/BasicComboBoxRenderer -javax/swing/plaf/metal/MetalComboBoxEditor$UIResource -javax/swing/plaf/metal/MetalComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor -javax/swing/ComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField -javax/swing/JTextField$NotifyAction -javax/swing/text/TextAction -javax/swing/AbstractAction -javax/swing/text/JTextComponent$MutableCaretEvent -javax/swing/plaf/metal/MetalTextFieldUI -javax/swing/plaf/basic/BasicTextFieldUI -javax/swing/plaf/basic/BasicTextUI -javax/swing/text/ViewFactory -javax/swing/plaf/TextUI -javax/swing/plaf/basic/BasicTextUI$BasicCursor +javax/swing/text/AbstractDocument$InsertStringResult +javax/swing/text/AbstractDocument$LeafElement +javax/swing/text/AttributeSet +javax/swing/text/AttributeSet$CharacterAttribute +javax/swing/text/AttributeSet$ColorAttribute +javax/swing/text/AttributeSet$FontAttribute +javax/swing/text/AttributeSet$ParagraphAttribute +javax/swing/text/Caret +javax/swing/text/DefaultCaret +javax/swing/text/DefaultCaret$Handler javax/swing/text/DefaultEditorKit -javax/swing/text/EditorKit -javax/swing/text/DefaultEditorKit$InsertContentAction -javax/swing/text/DefaultEditorKit$DeletePrevCharAction -javax/swing/text/DefaultEditorKit$DeleteNextCharAction -javax/swing/text/DefaultEditorKit$ReadOnlyAction -javax/swing/text/DefaultEditorKit$DeleteWordAction -javax/swing/text/DefaultEditorKit$WritableAction -javax/swing/text/DefaultEditorKit$CutAction -javax/swing/text/DefaultEditorKit$CopyAction -javax/swing/text/DefaultEditorKit$PasteAction -javax/swing/text/DefaultEditorKit$VerticalPageAction -javax/swing/text/DefaultEditorKit$PageAction -javax/swing/text/DefaultEditorKit$InsertBreakAction javax/swing/text/DefaultEditorKit$BeepAction -javax/swing/text/DefaultEditorKit$NextVisualPositionAction -javax/swing/text/DefaultEditorKit$BeginWordAction -javax/swing/text/DefaultEditorKit$EndWordAction -javax/swing/text/DefaultEditorKit$PreviousWordAction -javax/swing/text/DefaultEditorKit$NextWordAction -javax/swing/text/DefaultEditorKit$BeginLineAction -javax/swing/text/DefaultEditorKit$EndLineAction -javax/swing/text/DefaultEditorKit$BeginParagraphAction -javax/swing/text/DefaultEditorKit$EndParagraphAction javax/swing/text/DefaultEditorKit$BeginAction -javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$BeginLineAction +javax/swing/text/DefaultEditorKit$BeginParagraphAction +javax/swing/text/DefaultEditorKit$BeginWordAction +javax/swing/text/DefaultEditorKit$CopyAction +javax/swing/text/DefaultEditorKit$CutAction javax/swing/text/DefaultEditorKit$DefaultKeyTypedAction +javax/swing/text/DefaultEditorKit$DeleteNextCharAction +javax/swing/text/DefaultEditorKit$DeletePrevCharAction +javax/swing/text/DefaultEditorKit$DeleteWordAction +javax/swing/text/DefaultEditorKit$DumpModelAction +javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$EndLineAction +javax/swing/text/DefaultEditorKit$EndParagraphAction +javax/swing/text/DefaultEditorKit$EndWordAction +javax/swing/text/DefaultEditorKit$InsertBreakAction +javax/swing/text/DefaultEditorKit$InsertContentAction javax/swing/text/DefaultEditorKit$InsertTabAction -javax/swing/text/DefaultEditorKit$SelectWordAction +javax/swing/text/DefaultEditorKit$NextVisualPositionAction +javax/swing/text/DefaultEditorKit$NextWordAction +javax/swing/text/DefaultEditorKit$PageAction +javax/swing/text/DefaultEditorKit$PasteAction +javax/swing/text/DefaultEditorKit$PreviousWordAction +javax/swing/text/DefaultEditorKit$ReadOnlyAction +javax/swing/text/DefaultEditorKit$SelectAllAction javax/swing/text/DefaultEditorKit$SelectLineAction javax/swing/text/DefaultEditorKit$SelectParagraphAction -javax/swing/text/DefaultEditorKit$SelectAllAction -javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$SelectWordAction javax/swing/text/DefaultEditorKit$ToggleComponentOrientationAction -javax/swing/text/DefaultEditorKit$DumpModelAction -javax/swing/plaf/basic/BasicTextUI$TextTransferHandler -javax/swing/text/Position$Bias -javax/swing/plaf/basic/BasicTextUI$RootView -javax/swing/text/View -javax/swing/plaf/basic/BasicTextUI$UpdateHandler -javax/swing/event/DocumentListener -javax/swing/plaf/basic/BasicTextUI$DragListener -javax/swing/plaf/basic/BasicComboBoxEditor$UIResource -javax/swing/plaf/basic/BasicTextUI$BasicCaret -javax/swing/text/DefaultCaret -javax/swing/text/Caret -javax/swing/text/DefaultCaret$Handler -java/awt/datatransfer/ClipboardOwner -javax/swing/plaf/basic/BasicTextUI$BasicHighlighter +javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$VerticalPageAction +javax/swing/text/DefaultEditorKit$WritableAction javax/swing/text/DefaultHighlighter -javax/swing/text/LayeredHighlighter +javax/swing/text/DefaultHighlighter$DefaultHighlightPainter +javax/swing/text/DefaultHighlighter$SafeDamager +javax/swing/text/Document +javax/swing/text/EditorKit +javax/swing/text/Element +javax/swing/text/FieldView +javax/swing/text/GapContent +javax/swing/text/GapContent$InsertUndo +javax/swing/text/GapContent$MarkData +javax/swing/text/GapContent$MarkVector +javax/swing/text/GapContent$StickyPosition +javax/swing/text/GapVector javax/swing/text/Highlighter javax/swing/text/Highlighter$Highlight -javax/swing/text/DefaultHighlighter$DefaultHighlightPainter -javax/swing/text/LayeredHighlighter$LayerPainter javax/swing/text/Highlighter$HighlightPainter -javax/swing/text/DefaultHighlighter$SafeDamager -javax/swing/text/FieldView -javax/swing/text/PlainView +javax/swing/text/JTextComponent +javax/swing/text/JTextComponent$1 javax/swing/text/JTextComponent$DefaultKeymap -javax/swing/text/Keymap -javax/swing/text/JTextComponent$KeymapWrapper javax/swing/text/JTextComponent$KeymapActionMap -javax/swing/plaf/basic/BasicTextUI$FocusAction -javax/swing/plaf/basic/BasicTextUI$TextActionWrapper -javax/swing/JTextArea -javax/swing/JEditorPane -javax/swing/JTextField$ScrollRepainter -javax/swing/plaf/metal/MetalComboBoxEditor$1 -javax/swing/plaf/metal/MetalComboBoxEditor$EditorBorder -javax/swing/plaf/metal/MetalComboBoxUI$MetalPropertyChangeListener -javax/swing/plaf/basic/BasicComboBoxUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicComboBoxUI$Handler -javax/swing/plaf/metal/MetalComboBoxButton -javax/swing/plaf/metal/MetalComboBoxIcon -javax/swing/plaf/metal/MetalComboBoxButton$1 -javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager -javax/swing/JComboBox$KeySelectionManager -javax/swing/JToolBar$DefaultToolBarLayout -javax/swing/plaf/metal/MetalToolBarUI -javax/swing/plaf/basic/BasicToolBarUI -javax/swing/plaf/ToolBarUI -javax/swing/plaf/metal/MetalBorders$ToolBarBorder -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue$1 -javax/swing/plaf/metal/MetalBorders$RolloverButtonBorder -javax/swing/plaf/metal/MetalBorders$RolloverMarginBorder -javax/swing/plaf/basic/BasicBorders$RadioButtonBorder -javax/swing/plaf/basic/BasicBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder -javax/swing/plaf/metal/MetalToolBarUI$MetalDockingListener -javax/swing/plaf/basic/BasicToolBarUI$DockingListener -javax/swing/plaf/basic/BasicToolBarUI$Handler -javax/swing/border/EtchedBorder -javax/swing/JToolBar$Separator -javax/swing/plaf/basic/BasicToolBarSeparatorUI -java/applet/Applet -java/awt/Panel -com/sun/awt/AWTUtilities -javax/swing/KeyboardManager$ComponentKeyStrokePair -sun/awt/EmbeddedFrame -sun/awt/im/InputMethodContext -java/awt/im/spi/InputMethodContext -sun/awt/im/InputContext -sun/awt/im/InputMethodManager -sun/awt/im/ExecutableInputMethodManager -sun/awt/X11/XInputMethodDescriptor -sun/awt/X11InputMethodDescriptor -java/awt/im/spi/InputMethodDescriptor -sun/awt/im/InputMethodLocator -sun/awt/im/ExecutableInputMethodManager$2 -sun/misc/Service -sun/misc/Service$LazyIterator -java/util/TreeSet -java/util/NavigableSet -java/util/SortedSet -javax/swing/SizeRequirements -javax/swing/plaf/basic/BasicGraphicsUtils -java/awt/event/AdjustmentEvent -java/awt/MenuBar -sun/awt/X11/XComponentPeer$2 -java/awt/SequencedEvent -java/beans/PropertyVetoException -java/awt/DefaultKeyboardFocusManager$TypeAheadMarker -java/awt/KeyboardFocusManager$HeavyweightFocusRequest -java/awt/KeyboardFocusManager$LightweightFocusRequest -sun/awt/KeyboardFocusManagerPeerImpl -sun/awt/SunToolkit$7 -java/awt/Window$1DisposeAction -java/awt/LightweightDispatcher$2 -sun/awt/X11/XReparentEvent -sun/awt/X11/XWindowAttributes -sun/awt/X11/XFocusChangeEvent -sun/awt/X11/XComponentPeer$1 -sun/awt/X11/XUnmapEvent -java/io/StringWriter -javax/swing/JWindow -java/io/UnsupportedEncodingException -java/net/UnknownHostException -java/nio/channels/SocketChannel -java/nio/channels/spi/AbstractSelectableChannel -java/nio/channels/SelectableChannel -java/net/SocketImplFactory -javax/swing/UnsupportedLookAndFeelException -java/lang/UnsatisfiedLinkError -javax/swing/Box$Filler -javax/swing/JComponent$2 -sun/net/www/MimeTable -java/net/FileNameMap -sun/net/www/MimeTable$1 -sun/net/www/MimeEntry -java/net/URLConnection$1 -java/text/SimpleDateFormat -java/text/DateFormat -java/text/DateFormat$Field -java/util/Calendar -java/util/GregorianCalendar -sun/util/resources/CalendarData -sun/util/resources/CalendarData_en -java/text/DateFormatSymbols -java/text/spi/DateFormatSymbolsProvider -java/text/DontCareFieldPosition -java/text/DontCareFieldPosition$1 -java/text/Format$FieldDelegate -javax/swing/plaf/BorderUIResource -javax/swing/BorderFactory -javax/swing/border/BevelBorder -javax/swing/plaf/metal/MetalIconFactory$TreeFolderIcon -javax/swing/plaf/metal/MetalIconFactory$FolderIcon16 -java/util/zip/ZipInputStream -java/io/PushbackInputStream -java/util/zip/CRC32 -java/util/zip/Checksum -java/lang/Thread$State -javax/swing/SwingUtilities$SharedOwnerFrame -javax/swing/JTable -javax/swing/event/TableModelListener -javax/swing/event/TableColumnModelListener -javax/swing/event/CellEditorListener -javax/swing/event/RowSorterListener -javax/swing/BufferStrategyPaintManager$BufferInfo -java/awt/Component$BltSubRegionBufferStrategy -sun/awt/SubRegionShowable -java/awt/Component$BltBufferStrategy -sun/awt/image/SunVolatileImage -sun/awt/image/BufferedImageGraphicsConfig -sun/print/PrinterGraphicsConfig -sun/java2d/x11/X11VolatileSurfaceManager -sun/awt/image/VolatileSurfaceManager -java/awt/print/PrinterGraphics -java/awt/PrintGraphics -java/awt/GraphicsCallback$PaintCallback -java/awt/GraphicsCallback -sun/awt/SunGraphicsCallback -javax/swing/JRadioButton -java/lang/ClassFormatError -javax/swing/JTabbedPane -javax/swing/JTabbedPane$ModelListener -javax/swing/plaf/metal/MetalTabbedPaneUI -javax/swing/plaf/basic/BasicTabbedPaneUI -javax/swing/plaf/TabbedPaneUI -javax/swing/plaf/metal/MetalTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneScrollLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$Handler -sun/swing/ImageIconUIResource -javax/swing/GrayFilter -java/awt/image/RGBImageFilter -java/awt/image/ImageFilter -java/awt/image/FilteredImageSource -org/w3c/dom/Node -org/xml/sax/SAXException -javax/xml/parsers/ParserConfigurationException -org/xml/sax/EntityResolver -java/security/NoSuchAlgorithmException -java/security/GeneralSecurityException -java/util/zip/GZIPInputStream -java/util/zip/DeflaterOutputStream -org/xml/sax/InputSource -javax/xml/parsers/DocumentBuilderFactory -javax/xml/parsers/FactoryFinder -javax/xml/parsers/SecuritySupport -javax/xml/parsers/SecuritySupport$2 -javax/xml/parsers/SecuritySupport$5 -javax/xml/parsers/SecuritySupport$1 -javax/xml/parsers/SecuritySupport$4 -javax/xml/parsers/DocumentBuilder -org/w3c/dom/Document -org/xml/sax/helpers/DefaultHandler -org/xml/sax/DTDHandler -org/xml/sax/ContentHandler -org/xml/sax/ErrorHandler -org/xml/sax/SAXNotSupportedException -org/xml/sax/Locator -org/xml/sax/SAXNotRecognizedException -org/xml/sax/SAXParseException -org/w3c/dom/NodeList -org/w3c/dom/events/EventTarget -org/w3c/dom/traversal/DocumentTraversal -org/w3c/dom/events/DocumentEvent -org/w3c/dom/ranges/DocumentRange -org/w3c/dom/Entity -org/w3c/dom/Element -org/w3c/dom/CharacterData -org/w3c/dom/CDATASection -org/w3c/dom/Text -org/xml/sax/AttributeList -org/w3c/dom/DOMException -org/w3c/dom/Notation -org/w3c/dom/DocumentType -org/w3c/dom/Attr -org/w3c/dom/EntityReference -org/w3c/dom/ProcessingInstruction -org/w3c/dom/Comment -org/w3c/dom/DocumentFragment -org/w3c/dom/events/Event -org/w3c/dom/events/MutationEvent -org/w3c/dom/traversal/TreeWalker -org/w3c/dom/ranges/Range -org/w3c/dom/traversal/NodeIterator -org/w3c/dom/events/EventException -org/w3c/dom/NamedNodeMap -java/lang/StringIndexOutOfBoundsException -java/awt/GridLayout -javax/swing/plaf/metal/MetalRadioButtonUI -javax/swing/plaf/basic/BasicRadioButtonUI -javax/swing/plaf/basic/BasicBorders -javax/swing/plaf/metal/MetalIconFactory$RadioButtonIcon -java/awt/event/ItemEvent -java/awt/CardLayout$Card -javax/swing/JCheckBox -javax/swing/event/ListSelectionEvent -javax/swing/plaf/metal/MetalCheckBoxUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxIcon -java/lang/ExceptionInInitializerError -com/sun/java/swing/plaf/windows/WindowsTabbedPaneUI -javax/swing/JProgressBar -javax/swing/JProgressBar$ModelListener -javax/swing/plaf/metal/MetalProgressBarUI -javax/swing/plaf/basic/BasicProgressBarUI -javax/swing/plaf/ProgressBarUI -javax/swing/plaf/BorderUIResource$LineBorderUIResource -javax/swing/plaf/basic/BasicProgressBarUI$Handler -javax/swing/tree/TreeModel -javax/swing/table/TableCellRenderer -javax/swing/table/JTableHeader -javax/swing/event/TreeExpansionListener -javax/swing/table/AbstractTableModel -javax/swing/table/TableModel -javax/swing/table/DefaultTableCellRenderer -javax/swing/JTree -javax/swing/tree/TreeSelectionModel -javax/swing/tree/DefaultTreeCellRenderer -javax/swing/tree/TreeCellRenderer -javax/swing/table/TableCellEditor -javax/swing/CellEditor -javax/swing/JToolTip -javax/swing/table/TableColumn -javax/swing/table/DefaultTableColumnModel -javax/swing/table/TableColumnModel -javax/swing/table/DefaultTableModel -javax/swing/event/TableModelEvent -sun/swing/table/DefaultTableCellHeaderRenderer -javax/swing/plaf/basic/BasicTableHeaderUI -javax/swing/plaf/TableHeaderUI -javax/swing/plaf/basic/BasicTableHeaderUI$1 -javax/swing/plaf/basic/BasicTableHeaderUI$MouseInputHandler -javax/swing/DefaultCellEditor -javax/swing/tree/TreeCellEditor -javax/swing/AbstractCellEditor -javax/swing/plaf/basic/BasicTableUI -javax/swing/plaf/TableUI -javax/swing/plaf/basic/BasicTableUI$TableTransferHandler -javax/swing/plaf/basic/BasicTableUI$Handler -javax/swing/tree/DefaultTreeSelectionModel -javax/swing/tree/TreePath -javax/swing/plaf/metal/MetalTreeUI -javax/swing/plaf/basic/BasicTreeUI -javax/swing/plaf/TreeUI -javax/swing/plaf/basic/BasicTreeUI$Actions -javax/swing/plaf/basic/BasicTreeUI$TreeTransferHandler -javax/swing/plaf/metal/MetalTreeUI$LineListener -javax/swing/plaf/basic/BasicTreeUI$Handler -javax/swing/event/TreeModelListener -javax/swing/event/TreeSelectionListener -javax/swing/event/SwingPropertyChangeSupport -javax/swing/tree/VariableHeightLayoutCache +javax/swing/text/JTextComponent$KeymapWrapper +javax/swing/text/JTextComponent$MutableCaretEvent +javax/swing/text/Keymap +javax/swing/text/LayeredHighlighter +javax/swing/text/LayeredHighlighter$LayerPainter +javax/swing/text/MutableAttributeSet +javax/swing/text/PlainDocument +javax/swing/text/PlainView +javax/swing/text/Position +javax/swing/text/Position$Bias +javax/swing/text/Segment +javax/swing/text/SegmentCache +javax/swing/text/SegmentCache$CachedSegment +javax/swing/text/SimpleAttributeSet +javax/swing/text/SimpleAttributeSet$EmptyAttributeSet +javax/swing/text/Style +javax/swing/text/StyleConstants +javax/swing/text/StyleConstants$CharacterConstants +javax/swing/text/StyleConstants$ColorConstants +javax/swing/text/StyleConstants$FontConstants +javax/swing/text/StyleConstants$ParagraphConstants +javax/swing/text/StyleContext +javax/swing/text/StyleContext$FontKey +javax/swing/text/StyleContext$KeyEnumeration +javax/swing/text/StyleContext$NamedStyle +javax/swing/text/StyleContext$SmallAttributeSet +javax/swing/text/TabExpander +javax/swing/text/TextAction +javax/swing/text/Utilities +javax/swing/text/View +javax/swing/text/ViewFactory javax/swing/tree/AbstractLayoutCache -javax/swing/tree/RowMapper -javax/swing/plaf/basic/BasicTreeUI$NodeDimensionsHandler javax/swing/tree/AbstractLayoutCache$NodeDimensions -javax/swing/JTree$TreeModelHandler -javax/swing/tree/VariableHeightLayoutCache$TreeStateNode javax/swing/tree/DefaultMutableTreeNode -javax/swing/tree/MutableTreeNode javax/swing/tree/DefaultMutableTreeNode$PreorderEnumeration -javax/swing/event/TableColumnModelEvent -java/text/ParseException -java/text/NumberFormat$Field -javax/swing/event/UndoableEditListener -javax/swing/filechooser/FileFilter -javax/swing/tree/DefaultTreeModel javax/swing/tree/DefaultTreeCellEditor javax/swing/tree/DefaultTreeCellEditor$1 javax/swing/tree/DefaultTreeCellEditor$DefaultTextField -javax/swing/DefaultCellEditor$1 -javax/swing/DefaultCellEditor$EditorDelegate javax/swing/tree/DefaultTreeCellEditor$EditorContainer -javax/swing/JTree$TreeSelectionRedirector -javax/swing/event/TreeModelEvent -javax/swing/plaf/metal/MetalSplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneUI -javax/swing/plaf/SplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneDivider -javax/swing/plaf/basic/BasicBorders$SplitPaneBorder -javax/swing/plaf/metal/MetalSplitPaneDivider -javax/swing/plaf/basic/BasicSplitPaneDivider$DividerLayout -javax/swing/plaf/basic/BasicSplitPaneDivider$MouseHandler -javax/swing/plaf/basic/BasicBorders$SplitPaneDividerBorder -javax/swing/plaf/basic/BasicSplitPaneUI$BasicHorizontalLayoutManager -javax/swing/plaf/basic/BasicSplitPaneUI$1 -javax/swing/plaf/basic/BasicSplitPaneUI$Handler -javax/swing/plaf/metal/MetalSplitPaneDivider$1 -javax/swing/plaf/basic/BasicSplitPaneDivider$OneTouchActionHandler -javax/swing/plaf/metal/MetalSplitPaneDivider$2 -javax/swing/border/TitledBorder -javax/swing/plaf/basic/BasicTextAreaUI -java/util/Collections$UnmodifiableCollection$1 -java/io/InterruptedIOException -java/net/NoRouteToHostException -java/net/BindException +javax/swing/tree/DefaultTreeCellRenderer +javax/swing/tree/DefaultTreeModel +javax/swing/tree/DefaultTreeSelectionModel +javax/swing/tree/MutableTreeNode javax/swing/tree/PathPlaceHolder -javax/swing/event/TreeSelectionEvent -javax/swing/JList$3 -javax/swing/JList$ListSelectionHandler -javax/swing/JSlider -javax/swing/JSlider$ModelListener -javax/swing/plaf/metal/MetalSliderUI -javax/swing/plaf/basic/BasicSliderUI -javax/swing/plaf/SliderUI -javax/swing/plaf/basic/BasicSliderUI$Actions -javax/swing/plaf/metal/MetalIconFactory$HorizontalSliderThumbIcon -javax/swing/plaf/metal/MetalIconFactory$VerticalSliderThumbIcon -javax/swing/plaf/basic/BasicSliderUI$TrackListener -javax/swing/plaf/basic/BasicSliderUI$Handler -javax/swing/plaf/basic/BasicSliderUI$ScrollListener -javax/swing/plaf/metal/MetalSliderUI$MetalPropertyListener -javax/swing/plaf/basic/BasicSliderUI$PropertyChangeHandler -sun/java2d/HeadlessGraphicsEnvironment -java/util/Hashtable$KeySet -java/awt/FontFormatException -sun/font/Type1Font$1 -java/nio/channels/FileChannel$MapMode -sun/nio/ch/FileChannelImpl$Unmapper -sun/nio/ch/Util$3 -java/nio/DirectByteBufferR -java/nio/charset/Charset$3 -sun/nio/cs/AbstractCharsetProvider -sun/nio/cs/SingleByteDecoder -java/lang/CharacterData00 -javax/swing/DefaultListModel -javax/swing/event/ListDataEvent -javax/sound/sampled/DataLine -javax/sound/sampled/Line -javax/sound/sampled/Line$Info -javax/sound/sampled/DataLine$Info -javax/sound/sampled/Control$Type -javax/sound/sampled/FloatControl$Type -javax/sound/sampled/LineUnavailableException -javax/sound/sampled/UnsupportedAudioFileException -javax/swing/JRadioButtonMenuItem -javax/swing/JMenuItem$AccessibleJMenuItem -javax/swing/AbstractButton$AccessibleAbstractButton -javax/accessibility/AccessibleAction -javax/accessibility/AccessibleValue -javax/accessibility/AccessibleText -javax/accessibility/AccessibleExtendedComponent -javax/accessibility/AccessibleComponent -javax/swing/JComponent$AccessibleJComponent -java/awt/Container$AccessibleAWTContainer -java/awt/Component$AccessibleAWTComponent -javax/accessibility/AccessibleRelationSet -javax/accessibility/AccessibleState -javax/accessibility/AccessibleBundle -javax/swing/plaf/basic/BasicCheckBoxMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxMenuItemIcon -javax/swing/JCheckBoxMenuItem$AccessibleJCheckBoxMenuItem -javax/swing/plaf/basic/BasicRadioButtonMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$RadioButtonMenuItemIcon +javax/swing/tree/RowMapper +javax/swing/tree/TreeCellEditor +javax/swing/tree/TreeCellRenderer +javax/swing/tree/TreeModel +javax/swing/tree/TreeNode +javax/swing/tree/TreePath +javax/swing/tree/TreeSelectionModel +javax/swing/tree/VariableHeightLayoutCache +javax/swing/tree/VariableHeightLayoutCache$TreeStateNode +javax/swing/undo/AbstractUndoableEdit +javax/swing/undo/CompoundEdit +javax/swing/undo/UndoableEdit +javax/xml/parsers/DocumentBuilder +javax/xml/parsers/DocumentBuilderFactory +javax/xml/parsers/FactoryFinder +javax/xml/parsers/FactoryFinder$1 +javax/xml/parsers/ParserConfigurationException +javax/xml/parsers/SecuritySupport +javax/xml/parsers/SecuritySupport$2 +javax/xml/parsers/SecuritySupport$5 +org/w3c/dom/Attr +org/w3c/dom/CDATASection +org/w3c/dom/CharacterData +org/w3c/dom/Comment +org/w3c/dom/DOMException +org/w3c/dom/Document +org/w3c/dom/DocumentFragment +org/w3c/dom/DocumentType +org/w3c/dom/Element +org/w3c/dom/Entity +org/w3c/dom/EntityReference +org/w3c/dom/NamedNodeMap +org/w3c/dom/Node +org/w3c/dom/NodeList +org/w3c/dom/Notation +org/w3c/dom/ProcessingInstruction +org/w3c/dom/Text +org/w3c/dom/events/DocumentEvent +org/w3c/dom/events/Event +org/w3c/dom/events/EventException +org/w3c/dom/events/EventTarget +org/w3c/dom/events/MutationEvent +org/w3c/dom/ranges/DocumentRange +org/w3c/dom/ranges/Range +org/w3c/dom/traversal/DocumentTraversal +org/w3c/dom/traversal/NodeIterator +org/w3c/dom/traversal/TreeWalker +org/xml/sax/AttributeList +org/xml/sax/ContentHandler +org/xml/sax/DTDHandler +org/xml/sax/EntityResolver +org/xml/sax/ErrorHandler +org/xml/sax/InputSource +org/xml/sax/Locator +org/xml/sax/SAXException +org/xml/sax/SAXNotRecognizedException +org/xml/sax/SAXNotSupportedException +org/xml/sax/SAXParseException +org/xml/sax/helpers/DefaultHandler +sun/awt/AWTAccessor +sun/awt/AWTAccessor$AWTEventAccessor +sun/awt/AWTAccessor$ClientPropertyKeyAccessor +sun/awt/AWTAccessor$ComponentAccessor +sun/awt/AWTAccessor$ContainerAccessor +sun/awt/AWTAccessor$CursorAccessor +sun/awt/AWTAccessor$DefaultKeyboardFocusManagerAccessor +sun/awt/AWTAccessor$EventQueueAccessor +sun/awt/AWTAccessor$FrameAccessor +sun/awt/AWTAccessor$InputEventAccessor +sun/awt/AWTAccessor$InvocationEventAccessor +sun/awt/AWTAccessor$KeyEventAccessor +sun/awt/AWTAccessor$KeyboardFocusManagerAccessor +sun/awt/AWTAccessor$SequencedEventAccessor +sun/awt/AWTAccessor$ToolkitAccessor +sun/awt/AWTAccessor$WindowAccessor +sun/awt/AWTAutoShutdown +sun/awt/AWTIcon32_java_icon16_png +sun/awt/AWTIcon32_java_icon24_png +sun/awt/AWTIcon32_java_icon32_png +sun/awt/AWTIcon32_java_icon48_png +sun/awt/AppContext +sun/awt/AppContext$1 +sun/awt/AppContext$2 +sun/awt/AppContext$3 +sun/awt/AppContext$6 +sun/awt/AppContext$GetAppContextLock +sun/awt/AppContext$State +sun/awt/CausedFocusEvent +sun/awt/CausedFocusEvent$Cause +sun/awt/ComponentFactory +sun/awt/ConstrainableGraphics +sun/awt/DisplayChangedListener +sun/awt/EmbeddedFrame +sun/awt/EventQueueDelegate +sun/awt/EventQueueItem +sun/awt/FontConfiguration +sun/awt/FontDescriptor +sun/awt/GlobalCursorManager +sun/awt/GlobalCursorManager$NativeUpdater +sun/awt/HeadlessToolkit +sun/awt/IconInfo +sun/awt/InputMethodSupport +sun/awt/KeyboardFocusManagerPeerImpl +sun/awt/KeyboardFocusManagerPeerProvider +sun/awt/LightweightFrame +sun/awt/ModalityListener +sun/awt/MostRecentKeyValue +sun/awt/NullComponentPeer +sun/awt/OSInfo +sun/awt/OSInfo$1 +sun/awt/OSInfo$OSType +sun/awt/OSInfo$WindowsVersion +sun/awt/PaintEventDispatcher +sun/awt/PeerEvent +sun/awt/PostEventQueue +sun/awt/RepaintArea +sun/awt/RequestFocusController +sun/awt/SubRegionShowable +sun/awt/SunDisplayChanger +sun/awt/SunGraphicsCallback +sun/awt/SunHints +sun/awt/SunHints$Key +sun/awt/SunHints$LCDContrastKey +sun/awt/SunHints$Value +sun/awt/SunToolkit +sun/awt/SunToolkit$ModalityListenerList +sun/awt/TimedWindowEvent +sun/awt/UNIXToolkit +sun/awt/WindowClosingListener +sun/awt/WindowClosingSupport +sun/awt/X11/AwtGraphicsConfigData +sun/awt/X11/AwtScreenData +sun/awt/X11/MotifColorUtilities +sun/awt/X11/MotifDnDConstants +sun/awt/X11/MotifDnDDragSourceProtocol +sun/awt/X11/MotifDnDDropTargetProtocol +sun/awt/X11/Native +sun/awt/X11/Native$1 +sun/awt/X11/OwnershipListener +sun/awt/X11/PropMwmHints +sun/awt/X11/UnsafeXDisposerRecord +sun/awt/X11/WindowDimensions +sun/awt/X11/WindowPropertyGetter +sun/awt/X11/XAWTXSettings +sun/awt/X11/XAnyEvent +sun/awt/X11/XAtom +sun/awt/X11/XAtomList +sun/awt/X11/XAwtState +sun/awt/X11/XBaseWindow +sun/awt/X11/XBaseWindow$1 +sun/awt/X11/XBaseWindow$InitialiseState +sun/awt/X11/XBaseWindow$StateLock +sun/awt/X11/XCanvasPeer +sun/awt/X11/XClientMessageEvent +sun/awt/X11/XClipboard +sun/awt/X11/XComponentPeer +sun/awt/X11/XComponentPeer$1 +sun/awt/X11/XConfigureEvent +sun/awt/X11/XContentWindow +sun/awt/X11/XCreateWindowParams +sun/awt/X11/XDecoratedPeer +sun/awt/X11/XDnDConstants +sun/awt/X11/XDnDDragSourceProtocol +sun/awt/X11/XDnDDropTargetProtocol +sun/awt/X11/XDragAndDropProtocols +sun/awt/X11/XDragSourceContextPeer +sun/awt/X11/XDragSourceProtocol +sun/awt/X11/XDragSourceProtocolListener +sun/awt/X11/XDropTargetContextPeer +sun/awt/X11/XDropTargetContextPeer$XDropTargetProtocolListenerImpl +sun/awt/X11/XDropTargetEventProcessor +sun/awt/X11/XDropTargetProtocol +sun/awt/X11/XDropTargetProtocolListener +sun/awt/X11/XDropTargetRegistry +sun/awt/X11/XEmbeddedFramePeer +sun/awt/X11/XErrorEvent +sun/awt/X11/XErrorHandler +sun/awt/X11/XErrorHandler$IgnoreBadWindowHandler +sun/awt/X11/XErrorHandler$VerifyChangePropertyHandler +sun/awt/X11/XErrorHandler$XBaseErrorHandler +sun/awt/X11/XErrorHandler$XErrorHandlerWithFlag +sun/awt/X11/XErrorHandler$XShmAttachHandler +sun/awt/X11/XErrorHandlerUtil +sun/awt/X11/XEvent +sun/awt/X11/XEventDispatcher +sun/awt/X11/XExposeEvent +sun/awt/X11/XFocusChangeEvent +sun/awt/X11/XFocusProxyWindow +sun/awt/X11/XFramePeer +sun/awt/X11/XGlobalCursorManager +sun/awt/X11/XInputMethod +sun/awt/X11/XInputMethodDescriptor +sun/awt/X11/XKeyboardFocusManagerPeer +sun/awt/X11/XLabelPeer +sun/awt/X11/XLayerProtocol +sun/awt/X11/XMSelection +sun/awt/X11/XMSelection$1 +sun/awt/X11/XMSelection$3 +sun/awt/X11/XMSelectionListener +sun/awt/X11/XModifierKeymap +sun/awt/X11/XNETProtocol +sun/awt/X11/XPanelPeer +sun/awt/X11/XPropertyCache +sun/awt/X11/XPropertyEvent +sun/awt/X11/XProtocol +sun/awt/X11/XRepaintArea +sun/awt/X11/XReparentEvent +sun/awt/X11/XRootWindow +sun/awt/X11/XSelection +sun/awt/X11/XSelection$IncrementalTransferHandler +sun/awt/X11/XSelection$SelectionEventHandler +sun/awt/X11/XSetWindowAttributes +sun/awt/X11/XSizeHints +sun/awt/X11/XStateProtocol +sun/awt/X11/XSystemTrayPeer +sun/awt/X11/XToolkit +sun/awt/X11/XToolkit$1 +sun/awt/X11/XToolkit$2 +sun/awt/X11/XToolkit$2$1 +sun/awt/X11/XToolkit$3 +sun/awt/X11/XToolkit$4 +sun/awt/X11/XToolkit$5 +sun/awt/X11/XUnmapEvent +sun/awt/X11/XVisibilityEvent +sun/awt/X11/XVisualInfo +sun/awt/X11/XWINProtocol +sun/awt/X11/XWM +sun/awt/X11/XWM$1 +sun/awt/X11/XWMHints +sun/awt/X11/XWindow +sun/awt/X11/XWindowAttributes +sun/awt/X11/XWindowAttributesData +sun/awt/X11/XWindowPeer +sun/awt/X11/XWindowPeer$2 +sun/awt/X11/XWindowPeer$4 +sun/awt/X11/XWrapperBase +sun/awt/X11/XlibUtil +sun/awt/X11/XlibWrapper +sun/awt/X11ComponentPeer +sun/awt/X11FontManager +sun/awt/X11GraphicsConfig +sun/awt/X11GraphicsConfig$X11GCDisposerRecord +sun/awt/X11GraphicsDevice +sun/awt/X11GraphicsEnvironment +sun/awt/X11GraphicsEnvironment$1 +sun/awt/X11InputMethod +sun/awt/X11InputMethodDescriptor +sun/awt/XSettings +sun/awt/XSettings$Update +sun/awt/datatransfer/SunClipboard +sun/awt/dnd/SunDragSourceContextPeer +sun/awt/dnd/SunDropTargetContextPeer +sun/awt/dnd/SunDropTargetEvent +sun/awt/event/IgnorePaintEvent +sun/awt/geom/PathConsumer2D +sun/awt/im/ExecutableInputMethodManager +sun/awt/im/ExecutableInputMethodManager$3 +sun/awt/im/InputContext +sun/awt/im/InputMethodAdapter +sun/awt/im/InputMethodContext +sun/awt/im/InputMethodLocator +sun/awt/im/InputMethodManager +sun/awt/image/BufImgSurfaceData +sun/awt/image/BufImgSurfaceData$ICMColorData +sun/awt/image/BufImgSurfaceManager +sun/awt/image/BufferedImageGraphicsConfig +sun/awt/image/ByteComponentRaster +sun/awt/image/ByteInterleavedRaster +sun/awt/image/BytePackedRaster +sun/awt/image/FetcherInfo +sun/awt/image/GifFrame +sun/awt/image/GifImageDecoder +sun/awt/image/ImageConsumerQueue +sun/awt/image/ImageDecoder sun/awt/image/ImageDecoder$1 -javax/swing/JTabbedPane$Page -java/net/DatagramSocket -java/net/MulticastSocket -java/net/DatagramPacket +sun/awt/image/ImageFetchable +sun/awt/image/ImageFetcher +sun/awt/image/ImageFetcher$1 +sun/awt/image/ImageRepresentation +sun/awt/image/ImageWatched +sun/awt/image/ImageWatched$Link +sun/awt/image/ImageWatched$WeakLink +sun/awt/image/InputStreamImageSource +sun/awt/image/IntegerComponentRaster +sun/awt/image/IntegerInterleavedRaster +sun/awt/image/NativeLibLoader +sun/awt/image/NativeLibLoader$1 +sun/awt/image/OffScreenImage +sun/awt/image/PNGFilterInputStream +sun/awt/image/PNGImageDecoder +sun/awt/image/PixelConverter +sun/awt/image/PixelConverter$Argb +sun/awt/image/PixelConverter$ArgbBm +sun/awt/image/PixelConverter$ArgbPre +sun/awt/image/PixelConverter$Bgrx +sun/awt/image/PixelConverter$ByteGray +sun/awt/image/PixelConverter$Rgba +sun/awt/image/PixelConverter$RgbaPre +sun/awt/image/PixelConverter$Rgbx +sun/awt/image/PixelConverter$Ushort4444Argb +sun/awt/image/PixelConverter$Ushort555Rgb +sun/awt/image/PixelConverter$Ushort555Rgbx +sun/awt/image/PixelConverter$Ushort565Rgb +sun/awt/image/PixelConverter$UshortGray +sun/awt/image/PixelConverter$Xbgr +sun/awt/image/PixelConverter$Xrgb +sun/awt/image/SunVolatileImage +sun/awt/image/SunWritableRaster +sun/awt/image/SunWritableRaster$DataStealer +sun/awt/image/SurfaceManager +sun/awt/image/SurfaceManager$ImageAccessor +sun/awt/image/SurfaceManager$ProxiedGraphicsConfig +sun/awt/image/ToolkitImage +sun/awt/image/URLImageSource +sun/awt/image/VolatileSurfaceManager +sun/awt/motif/MFontConfiguration +sun/awt/resources/awt +sun/awt/util/IdentityArrayList +sun/dc/DuctusRenderingEngine +sun/dc/path/PathConsumer +sun/dc/pr/PathDasher +sun/dc/pr/PathDasher$1 +sun/dc/pr/PathStroker +sun/dc/pr/PathStroker$1 +sun/font/AttributeValues +sun/font/CMap +sun/font/CMap$CMapFormat12 +sun/font/CMap$NullCMapClass +sun/font/CharToGlyphMapper +sun/font/CompositeFont +sun/font/CompositeFontDescriptor +sun/font/CompositeGlyphMapper +sun/font/CompositeStrike +sun/font/CoreMetrics +sun/font/EAttribute +sun/font/FcFontConfiguration +sun/font/FileFont +sun/font/FileFontStrike +sun/font/Font2D +sun/font/Font2DHandle +sun/font/FontAccess +sun/font/FontConfigManager +sun/font/FontConfigManager$FcCompFont +sun/font/FontConfigManager$FontConfigFont +sun/font/FontConfigManager$FontConfigInfo +sun/font/FontDesignMetrics +sun/font/FontDesignMetrics$KeyReference +sun/font/FontDesignMetrics$MetricsKey +sun/font/FontFamily +sun/font/FontLineMetrics +sun/font/FontManager +sun/font/FontManagerFactory +sun/font/FontManagerFactory$1 +sun/font/FontManagerForSGE +sun/font/FontManagerNativeLibrary +sun/font/FontManagerNativeLibrary$1 +sun/font/FontScaler +sun/font/FontStrike +sun/font/FontStrikeDesc +sun/font/FontStrikeDisposer +sun/font/FontUtilities +sun/font/FontUtilities$1 +sun/font/GlyphList +sun/font/PhysicalFont +sun/font/PhysicalStrike +sun/font/StandardGlyphVector +sun/font/StandardGlyphVector$GlyphStrike +sun/font/StrikeCache +sun/font/StrikeCache$1 +sun/font/StrikeCache$DisposableStrike +sun/font/StrikeCache$SoftDisposerRef +sun/font/StrikeMetrics +sun/font/SunFontManager +sun/font/SunFontManager$1 +sun/font/SunFontManager$11 +sun/font/SunFontManager$2 +sun/font/SunFontManager$3 +sun/font/SunFontManager$FontRegistrationInfo +sun/font/SunFontManager$T1Filter +sun/font/SunFontManager$TTFilter +sun/font/T2KFontScaler +sun/font/T2KFontScaler$1 +sun/font/TrueTypeFont +sun/font/TrueTypeFont$1 +sun/font/TrueTypeFont$DirectoryEntry +sun/font/TrueTypeFont$TTDisposerRecord +sun/font/TrueTypeGlyphMapper +sun/font/Type1Font +sun/font/Type1Font$1 +sun/font/X11TextRenderer +sun/java2d/BackBufferCapsProvider +sun/java2d/DefaultDisposerRecord +sun/java2d/DestSurfaceProvider +sun/java2d/Disposer +sun/java2d/Disposer$1 +sun/java2d/Disposer$2 +sun/java2d/Disposer$PollDisposable +sun/java2d/DisposerRecord +sun/java2d/DisposerTarget +sun/java2d/FontSupport +sun/java2d/InvalidPipeException +sun/java2d/NullSurfaceData +sun/java2d/StateTrackable +sun/java2d/StateTrackable$State +sun/java2d/StateTrackableDelegate +sun/java2d/StateTrackableDelegate$2 +sun/java2d/SunGraphics2D +sun/java2d/SunGraphicsEnvironment +sun/java2d/SunGraphicsEnvironment$1 +sun/java2d/Surface +sun/java2d/SurfaceData +sun/java2d/SurfaceData$PixelToPgramLoopConverter +sun/java2d/SurfaceData$PixelToShapeLoopConverter +sun/java2d/SurfaceManagerFactory +sun/java2d/UnixSurfaceManagerFactory +sun/java2d/cmm/CMSManager +sun/java2d/cmm/ProfileActivator +sun/java2d/cmm/ProfileDeferralInfo +sun/java2d/cmm/ProfileDeferralMgr +sun/java2d/loops/Blit +sun/java2d/loops/BlitBg +sun/java2d/loops/CompositeType +sun/java2d/loops/CustomComponent +sun/java2d/loops/DrawGlyphList +sun/java2d/loops/DrawGlyphListAA +sun/java2d/loops/DrawGlyphListLCD +sun/java2d/loops/DrawLine +sun/java2d/loops/DrawParallelogram +sun/java2d/loops/DrawPath +sun/java2d/loops/DrawPolygons +sun/java2d/loops/DrawRect +sun/java2d/loops/FillParallelogram +sun/java2d/loops/FillPath +sun/java2d/loops/FillRect +sun/java2d/loops/FillSpans +sun/java2d/loops/FontInfo +sun/java2d/loops/GeneralRenderer +sun/java2d/loops/GraphicsPrimitive +sun/java2d/loops/GraphicsPrimitiveMgr +sun/java2d/loops/GraphicsPrimitiveMgr$1 +sun/java2d/loops/GraphicsPrimitiveMgr$2 +sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec +sun/java2d/loops/GraphicsPrimitiveProxy +sun/java2d/loops/MaskBlit +sun/java2d/loops/MaskFill +sun/java2d/loops/RenderCache +sun/java2d/loops/RenderCache$Entry +sun/java2d/loops/RenderLoops +sun/java2d/loops/ScaledBlit +sun/java2d/loops/SurfaceType +sun/java2d/loops/TransformHelper +sun/java2d/loops/XORComposite +sun/java2d/opengl/GLXGraphicsConfig +sun/java2d/opengl/OGLGraphicsConfig +sun/java2d/pipe/AAShapePipe +sun/java2d/pipe/AATextRenderer +sun/java2d/pipe/AlphaColorPipe +sun/java2d/pipe/AlphaPaintPipe +sun/java2d/pipe/CompositePipe +sun/java2d/pipe/DrawImage +sun/java2d/pipe/DrawImagePipe +sun/java2d/pipe/GeneralCompositePipe +sun/java2d/pipe/GlyphListLoopPipe +sun/java2d/pipe/GlyphListPipe +sun/java2d/pipe/LCDTextRenderer +sun/java2d/pipe/LoopBasedPipe +sun/java2d/pipe/LoopPipe +sun/java2d/pipe/NullPipe +sun/java2d/pipe/OutlineTextRenderer +sun/java2d/pipe/ParallelogramPipe +sun/java2d/pipe/PixelDrawPipe +sun/java2d/pipe/PixelFillPipe +sun/java2d/pipe/PixelToParallelogramConverter +sun/java2d/pipe/PixelToShapeConverter +sun/java2d/pipe/Region +sun/java2d/pipe/Region$ImmutableRegion +sun/java2d/pipe/RegionIterator +sun/java2d/pipe/RenderingEngine +sun/java2d/pipe/RenderingEngine$1 +sun/java2d/pipe/ShapeDrawPipe +sun/java2d/pipe/ShapeSpanIterator +sun/java2d/pipe/SolidTextRenderer +sun/java2d/pipe/SpanClipRenderer +sun/java2d/pipe/SpanIterator +sun/java2d/pipe/SpanShapeRenderer +sun/java2d/pipe/SpanShapeRenderer$Composite +sun/java2d/pipe/TextPipe +sun/java2d/pipe/TextRenderer +sun/java2d/pipe/ValidatePipe +sun/java2d/pipe/hw/AccelGraphicsConfig +sun/java2d/pipe/hw/BufferedContextProvider +sun/java2d/x11/X11Renderer +sun/java2d/x11/X11SurfaceData +sun/java2d/x11/X11SurfaceData$LazyPipe +sun/java2d/x11/X11SurfaceData$X11WindowSurfaceData +sun/java2d/x11/X11VolatileSurfaceManager +sun/java2d/x11/XSurfaceData +sun/java2d/xr/XRGraphicsConfig +sun/launcher/LauncherHelper +sun/launcher/LauncherHelper$FXHelper +sun/misc/ASCIICaseInsensitiveComparator +sun/misc/Cleaner +sun/misc/CompoundEnumeration +sun/misc/ExtensionDependency +sun/misc/FDBigInteger +sun/misc/FileURLMapper +sun/misc/FloatingDecimal +sun/misc/FloatingDecimal$1 +sun/misc/FloatingDecimal$ASCIIToBinaryBuffer +sun/misc/FloatingDecimal$ASCIIToBinaryConverter +sun/misc/FloatingDecimal$BinaryToASCIIBuffer +sun/misc/FloatingDecimal$BinaryToASCIIConverter +sun/misc/FloatingDecimal$ExceptionalBinaryToASCIIBuffer +sun/misc/FloatingDecimal$PreparedASCIIToBinaryBuffer +sun/misc/IOUtils +sun/misc/JarIndex +sun/misc/JavaAWTAccess +sun/misc/JavaIOFileDescriptorAccess +sun/misc/JavaLangAccess +sun/misc/JavaNetAccess +sun/misc/JavaNioAccess +sun/misc/JavaSecurityAccess +sun/misc/JavaSecurityProtectionDomainAccess +sun/misc/JavaUtilJarAccess +sun/misc/JavaUtilZipFileAccess +sun/misc/Launcher +sun/misc/Launcher$AppClassLoader +sun/misc/Launcher$AppClassLoader$1 +sun/misc/Launcher$BootClassPathHolder +sun/misc/Launcher$BootClassPathHolder$1 +sun/misc/Launcher$ExtClassLoader +sun/misc/Launcher$ExtClassLoader$1 +sun/misc/Launcher$Factory +sun/misc/MetaIndex +sun/misc/NativeSignalHandler +sun/misc/OSEnvironment +sun/misc/Perf +sun/misc/Perf$GetPerfAction +sun/misc/PerfCounter +sun/misc/PerfCounter$CoreCounters +sun/misc/PerformanceLogger +sun/misc/PerformanceLogger$TimeData +sun/misc/PostVMInitHook +sun/misc/Resource +sun/misc/SharedSecrets +sun/misc/Signal +sun/misc/SignalHandler +sun/misc/SoftCache +sun/misc/SoftCache$ValueCell +sun/misc/URLClassPath +sun/misc/URLClassPath$1 +sun/misc/URLClassPath$2 +sun/misc/URLClassPath$3 +sun/misc/URLClassPath$FileLoader +sun/misc/URLClassPath$JarLoader +sun/misc/URLClassPath$JarLoader$1 +sun/misc/URLClassPath$JarLoader$2 +sun/misc/URLClassPath$Loader +sun/misc/Unsafe +sun/misc/VM +sun/misc/Version +sun/net/DefaultProgressMeteringPolicy sun/net/InetAddressCachePolicy sun/net/InetAddressCachePolicy$1 sun/net/InetAddressCachePolicy$2 -java/net/InetAddress$CacheEntry -java/net/PlainDatagramSocketImpl -java/net/DatagramSocketImpl -java/net/NetworkInterface -java/net/InterfaceAddress -java/text/Collator -java/text/spi/CollatorProvider -sun/text/resources/CollationData -sun/text/resources/CollationData_en -sun/util/EmptyListResourceBundle -java/text/RuleBasedCollator -java/text/CollationRules -java/text/RBCollationTables -java/text/RBTableBuilder -java/text/RBCollationTables$BuildAPI -sun/text/IntHashtable -sun/text/UCompactIntArray -sun/text/normalizer/NormalizerImpl -sun/text/normalizer/ICUData -sun/text/normalizer/NormalizerDataReader -sun/text/normalizer/ICUBinary$Authenticate -sun/text/normalizer/ICUBinary -sun/text/normalizer/NormalizerImpl$FCDTrieImpl -sun/text/normalizer/Trie$DataManipulate -sun/text/normalizer/NormalizerImpl$NormTrieImpl -sun/text/normalizer/NormalizerImpl$AuxTrieImpl -sun/text/normalizer/IntTrie -sun/text/normalizer/Trie -sun/text/normalizer/CharTrie -sun/text/normalizer/CharTrie$FriendAgent -sun/text/normalizer/UnicodeSet -sun/text/normalizer/UnicodeMatcher -sun/text/normalizer/NormalizerImpl$DecomposeArgs -java/text/MergeCollation -java/text/PatternEntry$Parser -java/text/PatternEntry -java/text/EntryPair -sun/text/ComposedCharIter -sun/text/normalizer/UTF16 +sun/net/NetHooks +sun/net/NetHooks$Provider +sun/net/NetProperties +sun/net/NetProperties$1 +sun/net/ProgressMeteringPolicy +sun/net/ProgressMonitor +sun/net/ResourceManager +sun/net/sdp/SdpProvider +sun/net/spi/DefaultProxySelector +sun/net/spi/DefaultProxySelector$1 +sun/net/spi/DefaultProxySelector$3 +sun/net/spi/DefaultProxySelector$NonProxyInfo +sun/net/spi/nameservice/NameService +sun/net/util/IPAddressUtil +sun/net/util/URLUtil +sun/net/www/MessageHeader +sun/net/www/MimeEntry +sun/net/www/MimeTable +sun/net/www/MimeTable$1 +sun/net/www/MimeTable$DefaultInstanceHolder +sun/net/www/MimeTable$DefaultInstanceHolder$1 +sun/net/www/ParseUtil +sun/net/www/URLConnection +sun/net/www/protocol/file/FileURLConnection +sun/net/www/protocol/file/Handler sun/net/www/protocol/http/Handler -java/io/ObjectInputStream$BlockDataInputStream -java/io/ObjectInputStream$PeekInputStream -java/io/ObjectInputStream$HandleTable -java/io/ObjectInputStream$ValidationList -java/io/Bits -java/io/ObjectStreamClass$Caches -java/io/ObjectStreamClass$WeakClassKey -java/io/ObjectStreamClass$EntryFuture -java/io/ObjectStreamClass$2 +sun/net/www/protocol/jar/Handler +sun/net/www/protocol/jar/JarFileFactory +sun/net/www/protocol/jar/JarURLConnection +sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream +sun/net/www/protocol/jar/URLJarFile +sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController +sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry +sun/nio/ByteBuffered +sun/nio/ch/DirectBuffer +sun/nio/ch/FileChannelImpl +sun/nio/ch/FileChannelImpl$Unmapper +sun/nio/ch/FileDispatcher +sun/nio/ch/FileDispatcherImpl +sun/nio/ch/IOStatus +sun/nio/ch/IOUtil +sun/nio/ch/IOUtil$1 +sun/nio/ch/Interruptible +sun/nio/ch/NativeDispatcher +sun/nio/ch/NativeThread +sun/nio/ch/NativeThreadSet +sun/nio/ch/Util +sun/nio/ch/Util$1 +sun/nio/ch/Util$4 +sun/nio/ch/Util$BufferCache +sun/nio/cs/ArrayDecoder +sun/nio/cs/ArrayEncoder +sun/nio/cs/FastCharsetProvider +sun/nio/cs/HistoricallyNamedCharset +sun/nio/cs/ISO_8859_1 +sun/nio/cs/ISO_8859_1$Encoder +sun/nio/cs/StandardCharsets +sun/nio/cs/StandardCharsets$Aliases +sun/nio/cs/StandardCharsets$Cache +sun/nio/cs/StandardCharsets$Classes +sun/nio/cs/StreamDecoder +sun/nio/cs/StreamEncoder +sun/nio/cs/Surrogate +sun/nio/cs/Surrogate$Parser +sun/nio/cs/US_ASCII +sun/nio/cs/US_ASCII$Decoder +sun/nio/cs/UTF_16 +sun/nio/cs/UTF_16$Decoder +sun/nio/cs/UTF_16BE +sun/nio/cs/UTF_16LE +sun/nio/cs/UTF_8 +sun/nio/cs/UTF_8$Decoder +sun/nio/cs/UTF_8$Encoder +sun/nio/cs/Unicode +sun/nio/cs/UnicodeDecoder +sun/print/PrinterGraphicsConfig +sun/reflect/AccessorGenerator +sun/reflect/BootstrapConstructorAccessorImpl +sun/reflect/ByteVector +sun/reflect/ByteVectorFactory +sun/reflect/ByteVectorImpl +sun/reflect/CallerSensitive +sun/reflect/ClassDefiner +sun/reflect/ClassDefiner$1 +sun/reflect/ClassFileAssembler +sun/reflect/ClassFileConstants +sun/reflect/ConstantPool +sun/reflect/ConstructorAccessor +sun/reflect/ConstructorAccessorImpl +sun/reflect/DelegatingClassLoader +sun/reflect/DelegatingConstructorAccessorImpl +sun/reflect/DelegatingMethodAccessorImpl +sun/reflect/FieldAccessor +sun/reflect/FieldAccessorImpl +sun/reflect/Label +sun/reflect/Label$PatchInfo +sun/reflect/LangReflectAccess +sun/reflect/MagicAccessorImpl +sun/reflect/MethodAccessor +sun/reflect/MethodAccessorGenerator +sun/reflect/MethodAccessorGenerator$1 +sun/reflect/MethodAccessorImpl +sun/reflect/NativeConstructorAccessorImpl +sun/reflect/NativeMethodAccessorImpl +sun/reflect/Reflection +sun/reflect/ReflectionFactory +sun/reflect/ReflectionFactory$1 +sun/reflect/ReflectionFactory$GetReflectionFactoryAction sun/reflect/SerializationConstructorAccessorImpl -java/io/ObjectStreamClass$FieldReflectorKey -java/io/ObjectStreamClass$FieldReflector -java/io/ObjectStreamClass$1 -java/io/DataOutputStream -java/io/ObjectStreamClass$MemberSignature -java/io/ObjectStreamClass$3 -java/io/ObjectStreamClass$4 -java/io/ObjectStreamClass$5 -java/security/MessageDigest -java/security/MessageDigestSpi +sun/reflect/UTF8 +sun/reflect/UnsafeFieldAccessorFactory +sun/reflect/UnsafeFieldAccessorImpl +sun/reflect/UnsafeObjectFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticLongFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl +sun/reflect/UnsafeStaticFieldAccessorImpl +sun/reflect/annotation/AnnotationType +sun/reflect/generics/repository/AbstractRepository +sun/reflect/generics/repository/ClassRepository +sun/reflect/generics/repository/GenericDeclRepository +sun/reflect/misc/MethodUtil +sun/reflect/misc/MethodUtil$1 +sun/reflect/misc/ReflectUtil +sun/security/action/GetBooleanAction +sun/security/action/GetIntegerAction +sun/security/action/GetPropertyAction sun/security/jca/GetInstance -sun/security/jca/Providers -sun/security/jca/ProviderList +sun/security/jca/GetInstance$Instance sun/security/jca/ProviderConfig -sun/security/jca/ProviderList$3 +sun/security/jca/ProviderConfig$2 +sun/security/jca/ProviderList sun/security/jca/ProviderList$1 sun/security/jca/ProviderList$2 -sun/security/jca/ProviderConfig$1 -sun/security/jca/ProviderConfig$3 -java/security/Provider$Service -java/security/Provider$UString -sun/security/provider/SHA -sun/security/provider/DigestBase -sun/security/jca/GetInstance$Instance -java/security/MessageDigest$Delegate -sun/security/provider/ByteArrayAccess -java/io/ObjectStreamClass$ClassDataSlot -sun/reflect/UnsafeQualifiedStaticLongFieldAccessorImpl -java/security/SignatureException -java/security/InvalidKeyException -java/security/KeyException -java/security/Signature -java/security/SignatureSpi -java/io/ObjectOutputStream$BlockDataOutputStream -sun/security/provider/DSAPublicKey -java/security/interfaces/DSAPublicKey -java/security/interfaces/DSAKey -java/security/PublicKey -java/security/Key -sun/security/x509/X509Key -java/io/ObjectOutputStream$HandleTable -java/io/ObjectOutputStream$ReplaceTable -sun/security/x509/AlgorithmId -sun/security/util/DerEncoder -sun/security/util/BitArray -sun/security/util/DerOutputStream -sun/security/util/DerValue -java/math/BigInteger -java/security/interfaces/DSAParams -sun/security/util/DerInputStream -sun/security/util/DerInputBuffer -sun/security/util/ObjectIdentifier -java/security/AlgorithmParameters -java/security/AlgorithmParametersSpi -sun/security/provider/DSAParameters -sun/security/util/ByteArrayLexOrder -sun/security/util/ByteArrayTagOrder -sun/security/util/DerIndefLenConverter -java/io/InvalidClassException -java/io/ObjectStreamException -java/io/ObjectInputStream$GetFieldImpl -java/io/ObjectInputStream$GetField -sun/security/jca/ServiceId +sun/security/jca/ProviderList$3 sun/security/jca/ProviderList$ServiceList sun/security/jca/ProviderList$ServiceList$1 -java/security/Signature$Delegate -java/security/interfaces/DSAPrivateKey -java/security/PrivateKey -sun/security/provider/DSA$SHA1withDSA +sun/security/jca/Providers +sun/security/jca/ServiceId +sun/security/provider/ByteArrayAccess sun/security/provider/DSA -java/security/spec/DSAParameterSpec -java/security/spec/AlgorithmParameterSpec -java/math/MutableBigInteger -java/math/SignedMutableBigInteger -java/awt/EventQueue$1AWTInvocationLock -java/awt/Component$FlipBufferStrategy -java/awt/SentEvent -sun/awt/X11/XDestroyWindowEvent -sun/awt/X11/XDropTargetRegistry -sun/awt/X11/XEmbeddedFramePeer -sun/awt/X11/XDragAndDropProtocols -sun/awt/X11/XDropTargetContextPeer -sun/awt/dnd/SunDropTargetContextPeer -java/awt/dnd/peer/DropTargetContextPeer -sun/awt/X11/XDropTargetContextPeer$XDropTargetProtocolListenerImpl -sun/awt/X11/XDropTargetProtocolListener -sun/awt/X11/XDnDDragSourceProtocol -sun/awt/X11/XDragSourceProtocol -sun/awt/X11/MotifDnDDragSourceProtocol -sun/awt/X11/XDnDDropTargetProtocol -sun/awt/X11/XDropTargetProtocol -sun/awt/X11/MotifDnDDropTargetProtocol -sun/awt/X11/XDnDConstants -sun/awt/X11/MotifDnDConstants -javax/swing/JTable$2 -javax/swing/JTable$Resizable3 -javax/swing/JTable$Resizable2 -javax/swing/JTable$5 -javax/swing/event/AncestorEvent -sun/font/FontDesignMetrics$MetricsKey -java/awt/geom/Line2D$Float -java/awt/geom/Line2D -com/sun/java/swing/plaf/gtk/GTKLookAndFeel -javax/swing/plaf/synth/SynthLookAndFeel -javax/swing/plaf/synth/DefaultSynthStyleFactory -javax/swing/plaf/synth/SynthStyleFactory -sun/swing/BakedArrayList -javax/swing/plaf/synth/SynthLookAndFeel$Handler -javax/swing/plaf/synth/SynthDefaultLookup -com/sun/java/swing/plaf/gtk/GTKEngine -com/sun/java/swing/plaf/gtk/GTKEngine$Settings -com/sun/java/swing/plaf/gtk/GTKStyleFactory -com/sun/java/swing/plaf/gtk/PangoFonts -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$WeakPCL -javax/swing/plaf/synth/Region -javax/swing/plaf/synth/SynthLookAndFeel$AATextListener -com/sun/java/swing/plaf/gtk/GTKRegion -com/sun/java/swing/plaf/gtk/GTKStyle -com/sun/java/swing/plaf/gtk/GTKConstants -javax/swing/plaf/synth/SynthStyle -javax/swing/plaf/synth/SynthGraphicsUtils -com/sun/java/swing/plaf/gtk/GTKGraphicsUtils -com/sun/java/swing/plaf/gtk/GTKStyle$GTKStockIcon -sun/swing/plaf/synth/SynthIcon -com/sun/java/swing/plaf/gtk/GTKColorType -javax/swing/plaf/synth/ColorType -com/sun/java/swing/plaf/gtk/resources/gtk -com/sun/swing/internal/plaf/synth/resources/synth -com/sun/java/swing/plaf/gtk/GTKStyle$GTKLazyValue -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$1FontLazyValue -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$2 -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$3 -javax/swing/plaf/synth/SynthPanelUI -javax/swing/plaf/synth/SynthConstants -javax/swing/plaf/synth/SynthContext -javax/swing/plaf/synth/SynthBorder -javax/swing/plaf/synth/SynthRootPaneUI -javax/swing/plaf/synth/SynthLabelUI -javax/swing/plaf/synth/SynthButtonUI -javax/swing/plaf/synth/SynthToggleButtonUI -javax/swing/plaf/basic/BasicBorders$FieldBorder -javax/swing/plaf/synth/SynthMenuBarUI -javax/swing/plaf/synth/SynthMenuUI -javax/swing/plaf/synth/SynthUI -com/sun/java/swing/plaf/gtk/GTKIconFactory -com/sun/java/swing/plaf/gtk/GTKIconFactory$MenuArrowIcon -com/sun/java/swing/plaf/gtk/GTKIconFactory$DelegatingIcon -com/sun/java/swing/plaf/gtk/GTKConstants$ArrowType -javax/swing/plaf/basic/BasicIconFactory -javax/swing/plaf/basic/BasicIconFactory$MenuItemCheckIcon -javax/swing/plaf/synth/SynthMenuItemUI -javax/swing/plaf/synth/SynthPopupMenuUI -javax/swing/plaf/synth/SynthSeparatorUI -javax/swing/plaf/synth/SynthScrollBarUI -javax/swing/plaf/synth/SynthArrowButton -javax/swing/plaf/synth/SynthArrowButton$SynthArrowButtonUI -javax/swing/plaf/synth/SynthComboBoxUI -javax/swing/plaf/synth/SynthComboPopup -javax/swing/plaf/synth/SynthListUI -javax/swing/plaf/synth/SynthListUI$SynthListCellRenderer -javax/swing/plaf/synth/SynthViewportUI -javax/swing/plaf/synth/SynthScrollPaneUI -javax/swing/plaf/synth/SynthScrollPaneUI$ViewportBorder -javax/swing/plaf/synth/SynthComboBoxUI$SynthComboBoxRenderer -javax/swing/plaf/synth/SynthComboBoxUI$SynthComboBoxEditor -javax/swing/plaf/synth/SynthTextFieldUI -javax/swing/plaf/synth/SynthToolBarUI -javax/swing/plaf/synth/SynthToolBarUI$SynthToolBarLayoutManager -com/sun/java/swing/plaf/gtk/GTKIconFactory$ToolBarHandleIcon -com/sun/java/swing/plaf/gtk/GTKConstants$Orientation -sun/awt/X11/XTranslateCoordinates -com/sun/java/swing/plaf/gtk/GTKPainter -javax/swing/plaf/synth/SynthPainter -javax/swing/plaf/synth/SynthPainter$1 -com/sun/java/swing/plaf/gtk/GTKConstants$PositionType -com/sun/java/swing/plaf/gtk/GTKConstants$ShadowType -java/io/ObjectInputStream$HandleTable$HandleList -sun/java2d/pipe/ShapeSpanIterator -sun/java2d/pipe/SpanIterator -sun/dc/path/PathConsumer -sun/dc/pr/PathStroker -sun/dc/pr/PathDasher -java/awt/geom/LineIterator -java/awt/geom/PathIterator -sun/applet/Main -sun/applet/AppletMessageHandler -sun/applet/resources/MsgAppletViewer -sun/applet/AppletSecurity -sun/awt/AWTSecurityManager -java/lang/SecurityManager -java/security/DomainCombiner -sun/applet/AppletSecurity$1 -java/lang/SecurityManager$1 -java/security/SecurityPermission -java/util/PropertyPermission -sun/applet/AppletViewer -java/applet/AppletContext -java/awt/print/Printable -sun/security/util/SecurityConstants -java/awt/AWTPermission -java/net/NetPermission -java/net/SocketPermission -javax/security/auth/AuthPermission -java/lang/Thread$1 -java/util/logging/LogManager$5 -sun/applet/StdAppletViewerFactory -sun/applet/AppletViewerFactory -sun/applet/AppletViewer$UserActionListener -sun/applet/AppletViewerPanel -sun/applet/AppletPanel -java/applet/AppletStub -sun/misc/MessageUtils -sun/applet/AppletPanel$10 -java/security/Policy$1 -sun/security/provider/PolicyFile$1 -sun/security/provider/PolicyFile$3 -sun/security/util/PropertyExpander -sun/security/provider/PolicyParser -sun/security/util/PolicyUtil -sun/security/provider/PolicyParser$GrantEntry -sun/security/provider/PolicyParser$PermissionEntry -sun/security/provider/PolicyFile$PolicyEntry -sun/security/provider/PolicyFile$6 -sun/security/provider/PolicyFile$7 -java/net/SocketPermissionCollection -java/util/PropertyPermissionCollection -sun/applet/AppletPanel$9 -sun/applet/AppletClassLoader -sun/applet/AppletThreadGroup -sun/applet/AppContextCreator -sun/applet/AppletPanel$1 -sun/awt/X11/XMenuBarPeer -java/awt/peer/MenuBarPeer -java/awt/peer/MenuComponentPeer -sun/awt/X11/XBaseMenuWindow -sun/awt/X11/XMenuPeer -java/awt/peer/MenuPeer -java/awt/peer/MenuItemPeer -sun/awt/X11/XMenuItemPeer -java/awt/MenuShortcut -sun/awt/X11/XMenuWindow -sun/awt/X11/XMenuItemPeer$TextMetrics -sun/awt/AppContext$3 -sun/awt/X11/XMenuBarPeer$MappingData -sun/awt/X11/XBaseMenuWindow$MappingData -sun/applet/AppletViewer$1 -sun/applet/AppletViewer$1AppletEventListener -sun/applet/AppletListener -sun/applet/AppletEventMulticaster -sun/misc/Queue -sun/misc/QueueElement -sun/applet/AppletEvent -sun/applet/AppletClassLoader$1 -sun/awt/X11/XBaseMenuWindow$3 -java/awt/DefaultKeyboardFocusManager$DefaultKeyboardFocusManagerSentEvent -sun/awt/CausedFocusEvent -sun/awt/X11/XWindow$1 -java/net/URLClassLoader$4 -sun/applet/AppletClassLoader$2 -javax/swing/JApplet -java/lang/ClassLoader$1 -sun/security/provider/PolicyFile$5 -java/security/PermissionsEnumerator -java/util/Collections$1 -sun/applet/AppletPanel$11 -sun/applet/AppletPanel$8 -sun/applet/AppletPanel$2 -sun/applet/AppletPanel$3 -sun/applet/AppletPanel$6 -javax/swing/BufferStrategyPaintManager$1 -# f3ac8b467e7f8c49 +sun/security/provider/DSA$LegacyDSA +sun/security/provider/DSA$SHA1withDSA +sun/security/provider/DSAParameters +sun/security/provider/DSAPublicKey +sun/security/provider/DigestBase +sun/security/provider/NativePRNG +sun/security/provider/NativePRNG$1 +sun/security/provider/NativePRNG$2 +sun/security/provider/NativePRNG$Blocking +sun/security/provider/NativePRNG$NonBlocking +sun/security/provider/NativePRNG$RandomIO +sun/security/provider/NativePRNG$Variant +sun/security/provider/SHA +sun/security/provider/Sun +sun/security/provider/SunEntries +sun/security/provider/SunEntries$1 +sun/security/util/BitArray +sun/security/util/ByteArrayLexOrder +sun/security/util/Debug +sun/security/util/DerEncoder +sun/security/util/DerIndefLenConverter +sun/security/util/DerInputBuffer +sun/security/util/DerInputStream +sun/security/util/DerOutputStream +sun/security/util/DerValue +sun/security/util/ManifestEntryVerifier +sun/security/util/ObjectIdentifier +sun/security/util/SignatureFileVerifier +sun/security/x509/AlgorithmId +sun/security/x509/X509Key +sun/swing/DefaultLookup +sun/swing/ImageIconUIResource +sun/swing/JLightweightFrame +sun/swing/MenuItemLayoutHelper +sun/swing/MenuItemLayoutHelper$ColumnAlignment +sun/swing/MenuItemLayoutHelper$LayoutResult +sun/swing/MenuItemLayoutHelper$RectSize +sun/swing/PrintColorUIResource +sun/swing/StringUIClientPropertyKey +sun/swing/SwingAccessor +sun/swing/SwingAccessor$JTextComponentAccessor +sun/swing/SwingLazyValue +sun/swing/SwingLazyValue$1 +sun/swing/SwingUtilities2 +sun/swing/SwingUtilities2$2 +sun/swing/SwingUtilities2$AATextInfo +sun/swing/SwingUtilities2$LSBCacheEntry +sun/swing/UIAction +sun/swing/UIClientPropertyKey +sun/swing/table/DefaultTableCellHeaderRenderer +sun/swing/table/DefaultTableCellHeaderRenderer$EmptyIcon +sun/text/ComposedCharIter +sun/text/IntHashtable +sun/text/UCompactIntArray +sun/text/normalizer/CharTrie +sun/text/normalizer/CharTrie$FriendAgent +sun/text/normalizer/ICUBinary +sun/text/normalizer/ICUBinary$Authenticate +sun/text/normalizer/ICUData +sun/text/normalizer/IntTrie +sun/text/normalizer/NormalizerDataReader +sun/text/normalizer/NormalizerImpl +sun/text/normalizer/NormalizerImpl$AuxTrieImpl +sun/text/normalizer/NormalizerImpl$DecomposeArgs +sun/text/normalizer/NormalizerImpl$FCDTrieImpl +sun/text/normalizer/NormalizerImpl$NormTrieImpl +sun/text/normalizer/Trie +sun/text/normalizer/Trie$DataManipulate +sun/text/normalizer/UTF16 +sun/text/normalizer/UnicodeMatcher +sun/text/normalizer/UnicodeSet +sun/text/resources/CollationData +sun/text/resources/FormatData +sun/text/resources/en/FormatData_en +sun/text/resources/en/FormatData_en_US +sun/util/CoreResourceBundleControl +sun/util/PreHashedMap +sun/util/ResourceBundleEnumeration +sun/util/calendar/AbstractCalendar +sun/util/calendar/BaseCalendar +sun/util/calendar/BaseCalendar$Date +sun/util/calendar/CalendarDate +sun/util/calendar/CalendarSystem +sun/util/calendar/CalendarUtils +sun/util/calendar/Gregorian +sun/util/calendar/Gregorian$Date +sun/util/calendar/ZoneInfo +sun/util/calendar/ZoneInfoFile +sun/util/calendar/ZoneInfoFile$1 +sun/util/calendar/ZoneInfoFile$Checksum +sun/util/calendar/ZoneInfoFile$ZoneOffsetTransitionRule +sun/util/locale/BaseLocale +sun/util/locale/BaseLocale$Cache +sun/util/locale/BaseLocale$Key +sun/util/locale/LanguageTag +sun/util/locale/LocaleObjectCache +sun/util/locale/LocaleObjectCache$CacheEntry +sun/util/locale/LocaleUtils +sun/util/locale/provider/AuxLocaleProviderAdapter +sun/util/locale/provider/AuxLocaleProviderAdapter$NullProvider +sun/util/locale/provider/AvailableLanguageTags +sun/util/locale/provider/CalendarDataProviderImpl +sun/util/locale/provider/CalendarDataUtility +sun/util/locale/provider/CalendarDataUtility$CalendarWeekParameterGetter +sun/util/locale/provider/CalendarProviderImpl +sun/util/locale/provider/CollatorProviderImpl +sun/util/locale/provider/CurrencyNameProviderImpl +sun/util/locale/provider/DateFormatSymbolsProviderImpl +sun/util/locale/provider/DecimalFormatSymbolsProviderImpl +sun/util/locale/provider/JRELocaleProviderAdapter +sun/util/locale/provider/JRELocaleProviderAdapter$1 +sun/util/locale/provider/LocaleDataMetaInfo +sun/util/locale/provider/LocaleProviderAdapter +sun/util/locale/provider/LocaleProviderAdapter$1 +sun/util/locale/provider/LocaleProviderAdapter$Type +sun/util/locale/provider/LocaleResources +sun/util/locale/provider/LocaleResources$ResourceReference +sun/util/locale/provider/LocaleServiceProviderPool +sun/util/locale/provider/LocaleServiceProviderPool$LocalizedObjectGetter +sun/util/locale/provider/NumberFormatProviderImpl +sun/util/locale/provider/ResourceBundleBasedAdapter +sun/util/locale/provider/SPILocaleProviderAdapter +sun/util/locale/provider/SPILocaleProviderAdapter$1 +sun/util/locale/provider/TimeZoneNameProviderImpl +sun/util/locale/provider/TimeZoneNameUtility +sun/util/locale/provider/TimeZoneNameUtility$TimeZoneNameGetter +sun/util/logging/LoggingProxy +sun/util/logging/LoggingSupport +sun/util/logging/LoggingSupport$1 +sun/util/logging/LoggingSupport$2 +sun/util/logging/PlatformLogger +sun/util/logging/PlatformLogger$1 +sun/util/logging/PlatformLogger$DefaultLoggerProxy +sun/util/logging/PlatformLogger$JavaLoggerProxy +sun/util/logging/PlatformLogger$Level +sun/util/logging/PlatformLogger$LoggerProxy +sun/util/logging/resources/logging +sun/util/resources/CalendarData +sun/util/resources/CurrencyNames +sun/util/resources/LocaleData +sun/util/resources/LocaleData$1 +sun/util/resources/LocaleData$LocaleDataResourceBundleControl +sun/util/resources/LocaleNamesBundle +sun/util/resources/OpenListResourceBundle +sun/util/resources/ParallelListResourceBundle +sun/util/resources/ParallelListResourceBundle$KeySet +sun/util/resources/TimeZoneNames +sun/util/resources/TimeZoneNamesBundle +sun/util/resources/en/CalendarData_en +sun/util/resources/en/CurrencyNames_en_US +sun/util/resources/en/TimeZoneNames_en +sun/util/spi/CalendarProvider +# e4fe875988768cf5 diff --git a/jdk/make/tools/sharing/classlist.macosx b/jdk/make/tools/sharing/classlist.macosx index d07236da9e9..6f854b45e39 100644 --- a/jdk/make/tools/sharing/classlist.macosx +++ b/jdk/make/tools/sharing/classlist.macosx @@ -1,2406 +1,2208 @@ -java/lang/Object -java/lang/String -java/io/Serializable -java/lang/Comparable -java/lang/CharSequence -java/lang/Class -java/lang/reflect/GenericDeclaration -java/lang/reflect/Type -java/lang/reflect/AnnotatedElement -java/lang/Cloneable -java/lang/ClassLoader -java/lang/System -java/lang/Throwable -java/lang/Error -java/lang/ThreadDeath -java/lang/Exception -java/lang/RuntimeException -java/security/ProtectionDomain -java/security/AccessControlContext -java/lang/ClassNotFoundException -java/lang/NoClassDefFoundError -java/lang/LinkageError -java/lang/ClassCastException -java/lang/ArrayStoreException -java/lang/VirtualMachineError -java/lang/OutOfMemoryError -java/lang/StackOverflowError -java/lang/IllegalMonitorStateException -java/lang/ref/Reference -java/lang/ref/SoftReference -java/lang/ref/WeakReference -java/lang/ref/FinalReference -java/lang/ref/PhantomReference -java/lang/ref/Finalizer -java/lang/Thread -java/lang/Runnable -java/lang/ThreadGroup -java/lang/Thread$UncaughtExceptionHandler -java/util/Properties -java/util/Hashtable -java/util/Map -java/util/Dictionary -java/lang/reflect/AccessibleObject -java/lang/reflect/Field -java/lang/reflect/Member -java/lang/reflect/Method -java/lang/reflect/Constructor -sun/reflect/MagicAccessorImpl -sun/reflect/MethodAccessorImpl -sun/reflect/MethodAccessor -sun/reflect/ConstructorAccessorImpl -sun/reflect/ConstructorAccessor -sun/reflect/DelegatingClassLoader -sun/reflect/ConstantPool -sun/reflect/UnsafeStaticFieldAccessorImpl -sun/reflect/UnsafeFieldAccessorImpl -sun/reflect/FieldAccessorImpl -sun/reflect/FieldAccessor -java/util/Vector -java/util/List -java/util/Collection -java/lang/Iterable -java/util/RandomAccess -java/util/AbstractList -java/util/AbstractCollection -java/lang/StringBuffer -java/lang/AbstractStringBuilder -java/lang/Appendable -java/lang/StackTraceElement -java/nio/Buffer -java/lang/Boolean -java/lang/Character -java/lang/Float -java/lang/Number -java/lang/Double -java/lang/Byte -java/lang/Short -java/lang/Integer -java/lang/Long -java/lang/NullPointerException -java/lang/ArithmeticException -java/io/ObjectStreamField -java/lang/String$CaseInsensitiveComparator -java/util/Comparator -java/lang/RuntimePermission -java/security/BasicPermission -java/security/Permission -java/security/Guard -sun/misc/SoftCache -java/util/AbstractMap -java/lang/ref/ReferenceQueue -java/lang/ref/ReferenceQueue$Null -java/lang/ref/ReferenceQueue$Lock -java/util/HashMap -java/lang/annotation/Annotation -java/util/HashMap$Entry -java/util/Map$Entry -java/security/AccessController -java/lang/reflect/ReflectPermission -sun/reflect/ReflectionFactory$GetReflectionFactoryAction -java/security/PrivilegedAction -java/util/Stack -sun/reflect/ReflectionFactory -java/lang/ref/Reference$Lock -java/lang/ref/Reference$ReferenceHandler -java/lang/ref/Finalizer$FinalizerThread -java/util/Hashtable$EmptyEnumerator -java/util/Enumeration -java/util/Hashtable$EmptyIterator -java/util/Iterator -java/util/Hashtable$Entry -java/nio/charset/Charset -sun/nio/cs/StandardCharsets -sun/nio/cs/FastCharsetProvider -java/nio/charset/spi/CharsetProvider -sun/nio/cs/StandardCharsets$Aliases -sun/util/PreHashedMap -sun/nio/cs/StandardCharsets$Classes -sun/nio/cs/StandardCharsets$Cache -java/lang/ThreadLocal -java/util/concurrent/atomic/AtomicInteger -sun/misc/Unsafe -java/lang/NoSuchMethodError -java/lang/IncompatibleClassChangeError -sun/reflect/Reflection -java/util/Collections -java/util/Collections$EmptySet -java/util/AbstractSet -java/util/Set -java/util/Collections$EmptyList -java/util/Collections$EmptyMap -java/util/Collections$ReverseComparator -java/util/Collections$SynchronizedMap -java/lang/Class$3 -java/lang/reflect/Modifier -java/lang/reflect/ReflectAccess -sun/reflect/LangReflectAccess -java/util/Arrays -java/lang/Math -sun/nio/cs/US_ASCII -sun/nio/cs/HistoricallyNamedCharset -sun/misc/VM -java/lang/StringCoding -java/lang/ThreadLocal$ThreadLocalMap -java/lang/ThreadLocal$ThreadLocalMap$Entry -java/lang/StringCoding$StringDecoder -sun/nio/cs/US_ASCII$Decoder -java/nio/charset/CharsetDecoder -java/nio/charset/CodingErrorAction -java/nio/ByteBuffer -java/nio/HeapByteBuffer -java/nio/Bits -java/nio/ByteOrder -java/nio/CharBuffer -java/lang/Readable -java/nio/HeapCharBuffer -java/nio/charset/CoderResult -java/nio/charset/CoderResult$1 -java/nio/charset/CoderResult$Cache -java/nio/charset/CoderResult$2 -sun/misc/Version -java/io/FileInputStream -java/io/InputStream -java/io/Closeable -java/io/FileDescriptor -java/io/FileOutputStream -java/io/OutputStream -java/io/Flushable -java/io/BufferedInputStream -java/io/FilterInputStream -java/util/concurrent/atomic/AtomicReferenceFieldUpdater -java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl -sun/reflect/misc/ReflectUtil -java/io/PrintStream -java/io/FilterOutputStream -java/io/BufferedOutputStream -java/io/OutputStreamWriter -java/io/Writer -sun/nio/cs/StreamEncoder -sun/security/action/GetPropertyAction -sun/nio/cs/US_ASCII$Encoder -java/nio/charset/CharsetEncoder -sun/nio/cs/Surrogate$Parser -sun/nio/cs/Surrogate -java/io/BufferedWriter -java/lang/Runtime -java/io/File -java/io/FileSystem -java/io/UnixFileSystem -java/io/ExpiringCache -java/io/ExpiringCache$1 -java/util/LinkedHashMap -java/util/LinkedHashMap$Entry -java/lang/StringBuilder -java/io/File$1 -sun/misc/JavaIODeleteOnExitAccess -sun/misc/SharedSecrets -java/lang/ClassLoader$3 -java/lang/StringCoding$StringEncoder -java/io/ExpiringCache$Entry -java/lang/ClassLoader$NativeLibrary -java/lang/Terminator -java/lang/Terminator$1 -sun/misc/SignalHandler -sun/misc/Signal -sun/misc/NativeSignalHandler -java/io/Console -java/io/Console$1 -sun/misc/JavaIOAccess -java/io/Console$1$1 -java/lang/Shutdown -java/util/ArrayList -java/lang/Shutdown$Lock -java/lang/ApplicationShutdownHooks -java/util/IdentityHashMap -sun/misc/OSEnvironment -java/lang/System$2 -sun/misc/JavaLangAccess -java/lang/Compiler -java/lang/Compiler$1 -sun/misc/Launcher -sun/misc/Launcher$Factory -java/net/URLStreamHandlerFactory -sun/misc/Launcher$ExtClassLoader -java/net/URLClassLoader -java/security/SecureClassLoader -sun/security/util/Debug -java/net/URLClassLoader$7 -sun/misc/JavaNetAccess -java/util/StringTokenizer -sun/misc/Launcher$ExtClassLoader$1 -java/security/PrivilegedExceptionAction -sun/misc/MetaIndex -java/io/BufferedReader -java/io/Reader -java/io/FileReader -java/io/InputStreamReader -sun/nio/cs/StreamDecoder -java/lang/reflect/Array -sun/net/www/ParseUtil -java/util/BitSet -java/io/ObjectStreamClass -java/net/URL -java/util/Locale -java/util/concurrent/ConcurrentHashMap -java/util/concurrent/ConcurrentMap -java/util/concurrent/ConcurrentHashMap$Segment -java/util/concurrent/locks/ReentrantLock -java/util/concurrent/locks/Lock -java/util/concurrent/locks/ReentrantLock$NonfairSync -java/util/concurrent/locks/ReentrantLock$Sync -java/util/concurrent/locks/AbstractQueuedSynchronizer -java/util/concurrent/locks/AbstractOwnableSynchronizer -java/util/concurrent/locks/AbstractQueuedSynchronizer$Node -java/util/concurrent/ConcurrentHashMap$HashEntry -java/lang/CharacterDataLatin1 -java/net/Parts -sun/net/www/protocol/file/Handler -java/net/URLStreamHandler -java/lang/Class$1 -sun/reflect/ReflectionFactory$1 -sun/reflect/NativeConstructorAccessorImpl -sun/reflect/DelegatingConstructorAccessorImpl -java/util/HashSet -sun/misc/URLClassPath -sun/net/www/protocol/jar/Handler -sun/misc/Launcher$AppClassLoader -sun/misc/Launcher$AppClassLoader$1 -java/lang/SystemClassLoaderAction -java/net/URLClassLoader$1 -sun/misc/URLClassPath$3 -sun/misc/URLClassPath$JarLoader -sun/misc/URLClassPath$Loader -java/security/PrivilegedActionException -sun/misc/URLClassPath$FileLoader -sun/misc/URLClassPath$FileLoader$1 -sun/misc/Resource -sun/nio/ByteBuffered -java/security/CodeSource -java/security/Permissions -java/security/PermissionCollection -sun/net/www/protocol/file/FileURLConnection -sun/net/www/URLConnection -java/net/URLConnection -java/net/UnknownContentHandler -java/net/ContentHandler -sun/net/www/MessageHeader -java/io/FilePermission -java/io/FilePermission$1 -sun/security/provider/PolicyFile -java/security/Policy -java/security/Policy$UnsupportedEmptyCollection -java/io/FilePermissionCollection -java/security/AllPermission -java/security/UnresolvedPermission -java/security/BasicPermissionCollection -java/security/Principal -java/security/cert/Certificate -java/util/AbstractList$Itr -java/util/IdentityHashMap$KeySet -java/util/IdentityHashMap$KeyIterator -java/util/IdentityHashMap$IdentityHashMapIterator -java/io/DeleteOnExitHook -java/util/LinkedHashSet -java/util/HashMap$KeySet -java/util/LinkedHashMap$KeyIterator -java/util/LinkedHashMap$LinkedHashIterator -java/awt/Frame -java/awt/MenuContainer -java/awt/Window -javax/accessibility/Accessible -java/awt/Container -java/awt/Component -java/awt/image/ImageObserver -java/lang/InterruptedException -java/awt/Label -java/util/logging/Logger -java/util/logging/Handler -java/util/logging/Level -java/util/logging/LogManager -java/util/logging/LogManager$1 -java/beans/PropertyChangeSupport -java/util/logging/LogManager$LogNode -java/util/logging/LoggingPermission -java/util/logging/LogManager$Cleaner -java/util/logging/LogManager$RootLogger -java/util/logging/LogManager$2 -java/util/Properties$LineReader -java/util/Hashtable$Enumerator -java/beans/PropertyChangeEvent -java/util/EventObject -java/awt/Component$AWTTreeLock -sun/awt/DebugHelper -sun/awt/NativeLibLoader -sun/security/action/LoadLibraryAction -java/awt/GraphicsEnvironment -java/awt/GraphicsEnvironment$1 -java/lang/ProcessEnvironment -java/lang/ProcessEnvironment$Variable -java/lang/ProcessEnvironment$ExternalData -java/lang/ProcessEnvironment$Value -java/lang/ProcessEnvironment$StringEnvironment -java/util/Collections$UnmodifiableMap -sun/awt/DebugHelperStub -java/awt/Toolkit -java/awt/Toolkit$3 -sun/util/CoreResourceBundleControl -java/util/ResourceBundle$Control -java/util/Arrays$ArrayList -java/util/Collections$UnmodifiableRandomAccessList -java/util/Collections$UnmodifiableList -java/util/Collections$UnmodifiableCollection -java/util/ResourceBundle -java/util/ResourceBundle$1 -java/util/ResourceBundle$RBClassLoader -java/util/ResourceBundle$RBClassLoader$1 -java/util/ResourceBundle$CacheKey -java/util/ResourceBundle$LoaderReference -java/util/ResourceBundle$CacheKeyReference -java/util/ResourceBundle$SingleFormatControl -sun/awt/resources/awt -java/util/ListResourceBundle -java/awt/Toolkit$1 -java/io/FileNotFoundException -java/io/IOException -java/awt/event/KeyEvent -java/awt/event/InputEvent -java/awt/event/ComponentEvent +apple/laf/JRSUIConstants +apple/laf/JRSUIConstants$AlignmentHorizontal +apple/laf/JRSUIConstants$AlignmentVertical +apple/laf/JRSUIConstants$Animating +apple/laf/JRSUIConstants$DoubleValue +apple/laf/JRSUIConstants$Focused +apple/laf/JRSUIConstants$FrameOnly +apple/laf/JRSUIConstants$Hit +apple/laf/JRSUIConstants$IndicatorOnly +apple/laf/JRSUIConstants$Key +apple/laf/JRSUIConstants$NothingToScroll +apple/laf/JRSUIConstants$Orientation +apple/laf/JRSUIConstants$Property +apple/laf/JRSUIConstants$PropertyEncoding +apple/laf/JRSUIConstants$ScrollBarPart +apple/laf/JRSUIConstants$SegmentPosition +apple/laf/JRSUIConstants$SegmentTrailingSeparator +apple/laf/JRSUIConstants$ShowArrows +apple/laf/JRSUIConstants$Size +apple/laf/JRSUIConstants$State +apple/laf/JRSUIConstants$Widget +apple/laf/JRSUIControl +apple/laf/JRSUIControl$BufferState +apple/laf/JRSUIControl$ThreadLocalByteBuffer +apple/laf/JRSUIState +apple/laf/JRSUIState$ScrollBarState +apple/laf/JRSUIState$ValueState +apple/laf/JRSUIStateFactory +apple/laf/JRSUIUtils +apple/laf/JRSUIUtils$NineSliceMetricsProvider +apple/laf/JRSUIUtils$TabbedPane +com/apple/eawt/AboutHandler +com/apple/eawt/AppEventListener +com/apple/eawt/AppReOpenedListener +com/apple/eawt/OpenFilesHandler +com/apple/eawt/PreferencesHandler +com/apple/eawt/PrintFilesHandler +com/apple/eawt/QuitHandler +com/apple/eawt/QuitStrategy +com/apple/eawt/_AppEventHandler +com/apple/eawt/_AppEventHandler$_AboutDispatcher +com/apple/eawt/_AppEventHandler$_AppEventDispatcher +com/apple/eawt/_AppEventHandler$_AppEventMultiplexor +com/apple/eawt/_AppEventHandler$_AppForegroundDispatcher +com/apple/eawt/_AppEventHandler$_AppReOpenedDispatcher +com/apple/eawt/_AppEventHandler$_BooleanAppEventMultiplexor +com/apple/eawt/_AppEventHandler$_HiddenAppDispatcher +com/apple/eawt/_AppEventHandler$_NativeEvent +com/apple/eawt/_AppEventHandler$_OpenAppDispatcher +com/apple/eawt/_AppEventHandler$_OpenFileDispatcher +com/apple/eawt/_AppEventHandler$_OpenURIDispatcher +com/apple/eawt/_AppEventHandler$_PreferencesDispatcher +com/apple/eawt/_AppEventHandler$_PrintFileDispatcher +com/apple/eawt/_AppEventHandler$_QueuingAppEventDispatcher +com/apple/eawt/_AppEventHandler$_QuitDispatcher +com/apple/eawt/_AppEventHandler$_ScreenSleepDispatcher +com/apple/eawt/_AppEventHandler$_SystemSleepDispatcher +com/apple/eawt/_AppEventHandler$_UserSessionDispatcher +com/apple/eawt/_AppEventLegacyHandler +com/apple/eawt/_AppMenuBarHandler +com/apple/eawt/_OpenAppHandler +com/apple/laf/AquaBorder +com/apple/laf/AquaButtonBorder +com/apple/laf/AquaButtonBorder$1 +com/apple/laf/AquaButtonBorder$Dynamic +com/apple/laf/AquaButtonBorder$Dynamic$1 +com/apple/laf/AquaButtonBorder$Named +com/apple/laf/AquaButtonBorder$Toggle +com/apple/laf/AquaButtonBorder$Toolbar +com/apple/laf/AquaButtonExtendedTypes +com/apple/laf/AquaButtonExtendedTypes$1 +com/apple/laf/AquaButtonExtendedTypes$2 +com/apple/laf/AquaButtonExtendedTypes$3 +com/apple/laf/AquaButtonExtendedTypes$4 +com/apple/laf/AquaButtonExtendedTypes$5 +com/apple/laf/AquaButtonExtendedTypes$6 +com/apple/laf/AquaButtonExtendedTypes$7 +com/apple/laf/AquaButtonExtendedTypes$8 +com/apple/laf/AquaButtonExtendedTypes$BorderDefinedTypeSpecifier +com/apple/laf/AquaButtonExtendedTypes$BorderDefinedTypeSpecifier$1 +com/apple/laf/AquaButtonExtendedTypes$SegmentedBorderDefinedTypeSpecifier +com/apple/laf/AquaButtonExtendedTypes$SegmentedNamedBorder +com/apple/laf/AquaButtonExtendedTypes$TypeSpecifier +com/apple/laf/AquaButtonToggleUI +com/apple/laf/AquaButtonUI +com/apple/laf/AquaButtonUI$AquaButtonListener +com/apple/laf/AquaButtonUI$AquaHierarchyButtonListener +com/apple/laf/AquaCaret +com/apple/laf/AquaComboBoxButton +com/apple/laf/AquaComboBoxButton$1 +com/apple/laf/AquaComboBoxPopup +com/apple/laf/AquaComboBoxPopup$1 +com/apple/laf/AquaComboBoxRenderer +com/apple/laf/AquaComboBoxRendererInternal +com/apple/laf/AquaComboBoxUI +com/apple/laf/AquaComboBoxUI$1 +com/apple/laf/AquaComboBoxUI$10 +com/apple/laf/AquaComboBoxUI$11 +com/apple/laf/AquaComboBoxUI$12 +com/apple/laf/AquaComboBoxUI$12$1 +com/apple/laf/AquaComboBoxUI$12$2 +com/apple/laf/AquaComboBoxUI$12$3 +com/apple/laf/AquaComboBoxUI$12$4 +com/apple/laf/AquaComboBoxUI$12$5 +com/apple/laf/AquaComboBoxUI$12$6 +com/apple/laf/AquaComboBoxUI$12$7 +com/apple/laf/AquaComboBoxUI$2 +com/apple/laf/AquaComboBoxUI$3 +com/apple/laf/AquaComboBoxUI$4 +com/apple/laf/AquaComboBoxUI$5 +com/apple/laf/AquaComboBoxUI$6 +com/apple/laf/AquaComboBoxUI$7 +com/apple/laf/AquaComboBoxUI$8 +com/apple/laf/AquaComboBoxUI$9 +com/apple/laf/AquaComboBoxUI$AquaComboBoxEditor +com/apple/laf/AquaComboBoxUI$AquaComboBoxLayoutManager +com/apple/laf/AquaComboBoxUI$AquaCustomComboTextField +com/apple/laf/AquaComboBoxUI$AquaCustomComboTextField$1 +com/apple/laf/AquaComboBoxUI$ComboBoxAction +com/apple/laf/AquaFocusHandler +com/apple/laf/AquaFocusHandler$1 +com/apple/laf/AquaFonts +com/apple/laf/AquaFonts$1 +com/apple/laf/AquaFonts$2 +com/apple/laf/AquaFonts$3 +com/apple/laf/AquaFonts$4 +com/apple/laf/AquaFonts$5 +com/apple/laf/AquaFonts$6 +com/apple/laf/AquaFonts$7 +com/apple/laf/AquaFonts$DerivedUIResourceFont +com/apple/laf/AquaHighlighter +com/apple/laf/AquaHighlighter$1 +com/apple/laf/AquaHighlighter$AquaHighlightPainter +com/apple/laf/AquaIcon$CachingScalingIcon +com/apple/laf/AquaIcon$InvertableIcon +com/apple/laf/AquaIcon$SystemIcon +com/apple/laf/AquaIcon$SystemIconSingleton +com/apple/laf/AquaIcon$SystemIconUIResourceSingleton +com/apple/laf/AquaImageFactory +com/apple/laf/AquaImageFactory$IconUIResourceSingleton +com/apple/laf/AquaImageFactory$InvertableImageIcon +com/apple/laf/AquaImageFactory$NamedImageSingleton +com/apple/laf/AquaImageFactory$SystemColorProxy +com/apple/laf/AquaKeyBindings +com/apple/laf/AquaKeyBindings$AquaMultilineAction +com/apple/laf/AquaKeyBindings$BindingsProvider +com/apple/laf/AquaKeyBindings$LateBoundInputMap +com/apple/laf/AquaKeyBindings$SimpleBinding +com/apple/laf/AquaLabelUI +com/apple/laf/AquaListUI +com/apple/laf/AquaListUI$AquaHomeEndAction +com/apple/laf/AquaListUI$AquaPropertyChangeHandler +com/apple/laf/AquaListUI$FocusHandler +com/apple/laf/AquaListUI$MouseInputHandler +com/apple/laf/AquaLookAndFeel +com/apple/laf/AquaLookAndFeel$1 +com/apple/laf/AquaLookAndFeel$2 +com/apple/laf/AquaLookAndFeel$3 +com/apple/laf/AquaMenuBarBorder +com/apple/laf/AquaMenuBarUI +com/apple/laf/AquaMenuBorder +com/apple/laf/AquaMenuItemUI +com/apple/laf/AquaMenuItemUI$IndeterminateListener +com/apple/laf/AquaMenuPainter +com/apple/laf/AquaMenuPainter$Client +com/apple/laf/AquaMenuPainter$RecyclableBorder +com/apple/laf/AquaMenuUI +com/apple/laf/AquaMenuUI$AquaMouseInputHandler +com/apple/laf/AquaMenuUI$MenuDragMouseHandler +com/apple/laf/AquaMnemonicHandler +com/apple/laf/AquaMnemonicHandler$AltProcessor +com/apple/laf/AquaPainter +com/apple/laf/AquaPainter$1 +com/apple/laf/AquaPainter$AquaNineSlicingImagePainter +com/apple/laf/AquaPainter$AquaSingleImagePainter +com/apple/laf/AquaPanelUI +com/apple/laf/AquaPopupMenuSeparatorUI +com/apple/laf/AquaPopupMenuUI +com/apple/laf/AquaRootPaneUI +com/apple/laf/AquaScrollBarUI +com/apple/laf/AquaScrollBarUI$1 +com/apple/laf/AquaScrollBarUI$ModelListener +com/apple/laf/AquaScrollBarUI$PropertyChangeHandler +com/apple/laf/AquaScrollBarUI$ScrollListener +com/apple/laf/AquaScrollBarUI$TrackListener +com/apple/laf/AquaScrollPaneUI +com/apple/laf/AquaScrollPaneUI$XYMouseWheelHandler +com/apple/laf/AquaScrollRegionBorder +com/apple/laf/AquaTableHeaderBorder +com/apple/laf/AquaTableHeaderBorder$1 +com/apple/laf/AquaTextAreaUI +com/apple/laf/AquaTextFieldBorder +com/apple/laf/AquaTextFieldSearch +com/apple/laf/AquaTextFieldSearch$SearchFieldBorder +com/apple/laf/AquaTextFieldSearch$SearchFieldPropertyListener +com/apple/laf/AquaTextFieldUI +com/apple/laf/AquaToolBarSeparatorUI +com/apple/laf/AquaToolBarUI +com/apple/laf/AquaToolBarUI$ToolBarBorder +com/apple/laf/AquaUtilControlSize +com/apple/laf/AquaUtilControlSize$PropertySizeListener +com/apple/laf/AquaUtilControlSize$SizeDescriptor +com/apple/laf/AquaUtilControlSize$SizeVariant +com/apple/laf/AquaUtilControlSize$Sizeable +com/apple/laf/AquaUtils +com/apple/laf/AquaUtils$2 +com/apple/laf/AquaUtils$5 +com/apple/laf/AquaUtils$6 +com/apple/laf/AquaUtils$JComponentPainter +com/apple/laf/AquaUtils$RecyclableSingleton +com/apple/laf/AquaUtils$RecyclableSingletonFromDefaultConstructor +com/apple/laf/ClientPropertyApplicator +com/apple/laf/ClientPropertyApplicator$Property +com/apple/laf/ImageCache +com/apple/laf/ImageCache$1 +com/apple/laf/ImageCache$PixelCountSoftReference +com/apple/laf/ScreenMenuBar +com/apple/laf/ScreenMenuBarProvider +com/apple/laf/ScreenMenuPropertyHandler +com/apple/laf/ScreenPopupFactory +com/apple/laf/ScreenPopupFactory$1 +com/apple/laf/resources/aqua +com/sun/java/swing/SwingUtilities3 +com/sun/swing/internal/plaf/basic/resources/basic +java/applet/Applet java/awt/AWTEvent -java/awt/event/NativeLibLoader -java/util/WeakHashMap -java/util/WeakHashMap$Entry -java/awt/Component$DummyRequestFocusController -sun/awt/RequestFocusController -java/awt/LayoutManager -java/awt/LightweightDispatcher -java/awt/event/AWTEventListener -java/util/EventListener -java/awt/Dimension -java/awt/geom/Dimension2D -java/util/concurrent/atomic/AtomicBoolean -java/awt/ComponentOrientation -java/awt/Component$2 -java/lang/NoSuchMethodException -sun/awt/AppContext -sun/awt/AppContext$1 -sun/awt/AppContext$2 -sun/awt/MostRecentKeyValue -java/awt/Cursor -sun/awt/X11GraphicsEnvironment -sun/java2d/SunGraphicsEnvironment -sun/java2d/FontSupport -sun/awt/DisplayChangedListener -sun/java2d/SunGraphicsEnvironment$TTFilter -java/io/FilenameFilter -sun/java2d/SunGraphicsEnvironment$T1Filter -sun/awt/X11GraphicsEnvironment$1 -sun/awt/SunToolkit -sun/awt/WindowClosingSupport -sun/awt/WindowClosingListener -sun/awt/ComponentFactory -sun/awt/InputMethodSupport -java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject -java/util/concurrent/locks/Condition -sun/awt/AWTAutoShutdown -sun/awt/AWTAutoShutdown$PeerMap -sun/awt/SunToolkit$6 -java/awt/Dialog$ModalExclusionType -java/lang/Enum -java/awt/Dialog -java/awt/Dialog$ModalityType -java/awt/ModalEventFilter -java/awt/EventFilter -sun/reflect/UnsafeFieldAccessorFactory -sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl -sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl -sun/awt/SunDisplayChanger -sun/java2d/SunGraphicsEnvironment$1 -java/io/StreamTokenizer -sun/font/FontManager -sun/font/FileFont -sun/font/PhysicalFont -sun/font/Font2D -sun/font/CompositeFont -java/util/HashMap$Values -java/util/HashMap$ValueIterator -java/util/HashMap$HashIterator -sun/font/FontManager$1 -java/awt/Font -java/awt/geom/AffineTransform -sun/font/AttributeValues -sun/font/EAttribute -java/text/AttributedCharacterIterator$Attribute -java/lang/Class$4 -sun/reflect/NativeMethodAccessorImpl -sun/reflect/DelegatingMethodAccessorImpl -java/awt/font/TextAttribute -java/lang/Integer$IntegerCache -sun/font/TrueTypeFont -java/awt/font/FontRenderContext -java/awt/RenderingHints -sun/awt/SunHints -sun/awt/SunHints$Key -java/awt/RenderingHints$Key -sun/awt/SunHints$Value -sun/awt/SunHints$LCDContrastKey -sun/font/Type1Font -java/awt/geom/Point2D$Float -java/awt/geom/Point2D -sun/font/StrikeMetrics -java/awt/geom/Rectangle2D$Float -java/awt/geom/Rectangle2D -java/awt/geom/RectangularShape -java/awt/Shape -java/awt/geom/GeneralPath -java/awt/geom/Path2D$Float -java/awt/geom/Path2D -sun/font/CharToGlyphMapper -sun/font/PhysicalStrike -sun/font/FontStrike -sun/font/GlyphList -sun/font/StrikeCache -sun/java2d/Disposer -sun/java2d/Disposer$1 -sun/font/StrikeCache$1 -sun/font/FontManager$FontRegistrationInfo -sun/awt/motif/MFontConfiguration -sun/awt/FontConfiguration -sun/awt/FontDescriptor -java/util/Scanner -java/util/regex/Pattern -java/util/regex/Pattern$8 -java/util/regex/Pattern$Node -java/util/regex/Pattern$LastNode -java/util/regex/Pattern$GroupHead -java/util/regex/Pattern$CharPropertyNames -java/util/regex/Pattern$CharPropertyNames$1 -java/util/regex/Pattern$CharPropertyNames$CharPropertyFactory -java/util/regex/Pattern$CharPropertyNames$2 -java/util/regex/Pattern$CharPropertyNames$5 -java/util/regex/Pattern$CharPropertyNames$3 -java/util/regex/Pattern$CharPropertyNames$6 -java/util/regex/Pattern$CharPropertyNames$CloneableProperty -java/util/regex/Pattern$CharProperty -java/util/regex/Pattern$CharPropertyNames$4 -java/util/regex/Pattern$CharPropertyNames$7 -java/util/regex/Pattern$CharPropertyNames$8 -java/util/regex/Pattern$CharPropertyNames$9 -java/util/regex/Pattern$CharPropertyNames$10 -java/util/regex/Pattern$CharPropertyNames$11 -java/util/regex/Pattern$CharPropertyNames$12 -java/util/regex/Pattern$CharPropertyNames$13 -java/util/regex/Pattern$CharPropertyNames$14 -java/util/regex/Pattern$CharPropertyNames$15 -java/util/regex/Pattern$CharPropertyNames$16 -java/util/regex/Pattern$CharPropertyNames$17 -java/util/regex/Pattern$CharPropertyNames$18 -java/util/regex/Pattern$CharPropertyNames$19 -java/util/regex/Pattern$CharPropertyNames$20 -java/util/regex/Pattern$CharPropertyNames$21 -java/util/regex/Pattern$Curly -java/util/regex/Pattern$Slice -java/util/regex/Pattern$Begin -java/util/regex/Pattern$First -java/util/regex/Pattern$Start -java/util/regex/Pattern$TreeInfo -java/util/regex/Pattern$All -java/util/regex/Pattern$BitClass -java/util/regex/Pattern$BmpCharProperty -java/util/regex/Pattern$6 -java/util/regex/Pattern$CharProperty$1 -java/util/regex/Pattern$10 -sun/nio/ch/FileChannelImpl -java/nio/channels/FileChannel -java/nio/channels/ByteChannel -java/nio/channels/ReadableByteChannel -java/nio/channels/Channel -java/nio/channels/WritableByteChannel -java/nio/channels/GatheringByteChannel -java/nio/channels/ScatteringByteChannel -java/nio/channels/spi/AbstractInterruptibleChannel -java/nio/channels/InterruptibleChannel -sun/nio/ch/Util -sun/nio/ch/IOUtil -sun/nio/ch/FileDispatcher -sun/nio/ch/NativeDispatcher -sun/nio/ch/Reflect -java/nio/MappedByteBuffer -sun/nio/ch/Reflect$1 -sun/nio/ch/NativeThreadSet -java/nio/channels/Channels -java/util/Scanner$1 -sun/misc/LRUCache -java/util/regex/Matcher -java/util/regex/MatchResult -java/text/NumberFormat -java/text/Format -java/text/spi/NumberFormatProvider -java/util/spi/LocaleServiceProvider -sun/util/LocaleServiceProviderPool -sun/util/LocaleServiceProviderPool$1 -java/util/ServiceLoader -java/util/ServiceLoader$LazyIterator -java/util/ServiceLoader$1 -java/util/HashMap$EntrySet -java/util/LinkedHashMap$EntryIterator -sun/misc/Launcher$1 -sun/misc/URLClassPath$2 -java/lang/ClassLoader$2 -sun/misc/URLClassPath$1 -java/net/URLClassLoader$3 -sun/misc/CompoundEnumeration -sun/misc/URLClassPath$JarLoader$1 -sun/misc/FileURLMapper -java/net/URLClassLoader$3$1 -sun/util/resources/LocaleData -sun/util/resources/LocaleData$1 -sun/util/resources/LocaleData$LocaleDataResourceBundleControl -sun/util/LocaleDataMetaInfo -sun/text/resources/FormatData -java/util/ResourceBundle$BundleReference -sun/text/resources/FormatData_en -sun/text/resources/FormatData_en_US -java/text/DecimalFormatSymbols -java/text/spi/DecimalFormatSymbolsProvider -java/util/Currency -java/util/Currency$1 -java/util/CurrencyData -java/util/spi/CurrencyNameProvider -sun/util/resources/CurrencyNames -sun/util/resources/LocaleNamesBundle -sun/util/resources/OpenListResourceBundle -sun/util/resources/CurrencyNames_en_US -java/text/DecimalFormat -java/text/FieldPosition -java/text/DigitList -java/math/RoundingMode -java/util/regex/Pattern$GroupTail -java/util/regex/Pattern$Ctype -java/util/regex/Pattern$Ques -java/util/regex/Pattern$GroupCurly -java/util/regex/Pattern$5 -java/util/regex/Pattern$Loop -java/util/regex/Pattern$Prolog -java/util/regex/Pattern$9 -java/util/regex/Pattern$BranchConn -java/util/regex/Pattern$Branch -java/nio/channels/spi/AbstractInterruptibleChannel$1 -sun/nio/ch/Interruptible -sun/nio/ch/NativeThread -sun/nio/ch/DirectBuffer -java/nio/DirectByteBuffer -java/nio/DirectByteBuffer$Deallocator -sun/misc/Cleaner -sun/nio/ch/IOStatus -java/util/regex/ASCII -java/io/DataInputStream -java/io/DataInput -java/lang/Short$ShortCache -java/util/HashMap$KeyIterator -sun/font/CompositeFontDescriptor -sun/font/Font2DHandle -sun/font/FontFamily -java/awt/GraphicsDevice -sun/awt/X11GraphicsDevice -sun/awt/X11GraphicsConfig -java/awt/GraphicsConfiguration -java/awt/ImageCapabilities -sun/java2d/x11/X11SurfaceData -sun/java2d/SurfaceData -java/awt/Transparency -sun/java2d/DisposerTarget -sun/java2d/InvalidPipeException -java/lang/IllegalStateException -sun/java2d/NullSurfaceData -sun/java2d/loops/SurfaceType -sun/awt/image/PixelConverter -sun/awt/image/PixelConverter$Xrgb -sun/awt/image/PixelConverter$Argb -sun/awt/image/PixelConverter$ArgbPre -sun/awt/image/PixelConverter$Xbgr -sun/awt/image/PixelConverter$Rgba -sun/awt/image/PixelConverter$RgbaPre -sun/awt/image/PixelConverter$Ushort565Rgb -sun/awt/image/PixelConverter$Ushort555Rgb -sun/awt/image/PixelConverter$Ushort555Rgbx -sun/awt/image/PixelConverter$Ushort4444Argb -sun/awt/image/PixelConverter$ByteGray -sun/awt/image/PixelConverter$UshortGray -sun/awt/image/PixelConverter$Rgbx -sun/awt/image/PixelConverter$Bgrx -sun/awt/image/PixelConverter$ArgbBm -java/awt/image/ColorModel -java/awt/image/DirectColorModel -java/awt/image/PackedColorModel -java/awt/color/ColorSpace -java/awt/color/ICC_Profile -sun/awt/color/ProfileDeferralInfo -sun/awt/color/ProfileDeferralMgr -java/awt/color/ICC_ProfileRGB -java/awt/color/ICC_Profile$1 -sun/awt/color/ProfileActivator -java/awt/color/ICC_ColorSpace -sun/java2d/pipe/NullPipe -sun/java2d/pipe/PixelDrawPipe -sun/java2d/pipe/PixelFillPipe -sun/java2d/pipe/ShapeDrawPipe -sun/java2d/pipe/TextPipe -sun/java2d/pipe/DrawImagePipe -java/awt/image/IndexColorModel -sun/java2d/pipe/LoopPipe -sun/java2d/pipe/OutlineTextRenderer -sun/java2d/pipe/SolidTextRenderer -sun/java2d/pipe/GlyphListLoopPipe -sun/java2d/pipe/GlyphListPipe -sun/java2d/pipe/AATextRenderer -sun/java2d/pipe/LCDTextRenderer -sun/java2d/pipe/AlphaColorPipe -sun/java2d/pipe/CompositePipe -sun/java2d/pipe/PixelToShapeConverter -sun/java2d/pipe/TextRenderer -sun/java2d/pipe/SpanClipRenderer -sun/java2d/pipe/Region -sun/java2d/pipe/RegionIterator -sun/java2d/pipe/DuctusShapeRenderer -sun/java2d/pipe/DuctusRenderer -sun/java2d/pipe/AlphaPaintPipe -sun/java2d/pipe/SpanShapeRenderer$Composite -sun/java2d/pipe/SpanShapeRenderer -sun/java2d/pipe/GeneralCompositePipe -sun/java2d/pipe/DrawImage -sun/java2d/loops/RenderCache -sun/java2d/loops/RenderCache$Entry -sun/java2d/loops/XORComposite -java/awt/Composite -sun/font/X11TextRenderer -sun/java2d/loops/GraphicsPrimitive -sun/java2d/x11/X11PMBlitLoops -sun/java2d/loops/Blit -sun/java2d/loops/GraphicsPrimitiveMgr -sun/java2d/loops/CompositeType -sun/java2d/SunGraphics2D -sun/awt/ConstrainableGraphics -java/awt/Graphics2D -java/awt/Graphics -java/awt/Color -java/awt/Paint -java/awt/AlphaComposite -sun/java2d/loops/BlitBg -sun/java2d/loops/ScaledBlit -sun/java2d/loops/FillRect -sun/java2d/loops/FillSpans -sun/java2d/loops/DrawLine -sun/java2d/loops/DrawRect -sun/java2d/loops/DrawPolygons -sun/java2d/loops/DrawPath -sun/java2d/loops/FillPath -sun/java2d/loops/MaskBlit -sun/java2d/loops/MaskFill -sun/java2d/loops/DrawGlyphList -sun/java2d/loops/DrawGlyphListAA -sun/java2d/loops/DrawGlyphListLCD -sun/java2d/loops/TransformHelper -java/awt/BasicStroke -java/awt/Stroke -sun/misc/PerformanceLogger -sun/misc/PerformanceLogger$TimeData -sun/java2d/pipe/ValidatePipe -sun/java2d/loops/CustomComponent -sun/java2d/loops/GraphicsPrimitiveProxy -sun/java2d/loops/GeneralRenderer -sun/java2d/loops/GraphicsPrimitiveMgr$1 -sun/java2d/loops/GraphicsPrimitiveMgr$2 -sun/java2d/x11/X11PMBlitLoops$DelegateBlitLoop -sun/java2d/x11/X11PMBlitBgLoops -sun/java2d/x11/X11SurfaceData$LazyPipe -sun/awt/X11GraphicsConfig$X11GCDisposerRecord -sun/java2d/DisposerRecord -java/awt/BorderLayout -java/awt/LayoutManager2 -java/awt/Rectangle -java/awt/Toolkit$2 -sun/awt/X11/XToolkit -sun/awt/X11/XConstants -sun/awt/UNIXToolkit -java/util/TreeMap -java/util/NavigableMap -java/util/SortedMap -sun/awt/X11/XlibWrapper -sun/awt/X11/XUtilConstants -sun/awt/X11/XProtocolConstants -sun/awt/X11/XCursorFontConstants -sun/awt/X11/XlibWrapper$1 -sun/awt/X11/XToolkit$4 -sun/awt/X11/XModifierKeymap -sun/awt/X11/XWrapperBase -sun/awt/X11/Native -sun/awt/X11/Native$1 -java/awt/EventQueue -sun/awt/X11/XToolkit$7 -java/util/EmptyStackException -java/lang/reflect/InvocationTargetException -java/awt/EventDispatchThread -java/awt/event/PaintEvent -java/awt/event/MouseEvent -sun/awt/PeerEvent -java/awt/event/InvocationEvent -java/awt/ActiveEvent -java/awt/EventQueueItem -sun/awt/X11/XToolkit$1 -sun/awt/X11/XToolkit$XErrorHandler -sun/awt/X11/XToolkit$5 -sun/awt/X11/XEventDispatcher -sun/awt/SunToolkit$ModalityListenerList -sun/awt/ModalityListener -sun/awt/SunToolkit$1 -java/util/MissingResourceException -java/awt/Queue -sun/awt/PostEventQueue -java/util/LinkedList -java/util/Deque -java/util/Queue -java/util/AbstractSequentialList -java/util/LinkedList$Entry -sun/awt/X11/AwtScreenData -sun/awt/X11/XWM -sun/awt/X11/MWMConstants -sun/awt/X11/XAtom -java/awt/Insets -sun/awt/X11/XWM$1 -sun/awt/X11/XWM$2 -sun/awt/X11/XSetWindowAttributes -sun/awt/X11/XErrorEvent -sun/awt/X11/XNETProtocol -sun/awt/X11/XStateProtocol -sun/awt/X11/XLayerProtocol -sun/awt/X11/XProtocol -sun/awt/X11/XProtocol$1 -sun/awt/X11/WindowPropertyGetter -sun/awt/X11/UnsafeXDisposerRecord -sun/awt/X11/XPropertyCache -sun/awt/X11/XWINProtocol -sun/awt/X11/XAtomList -sun/awt/X11/XToolkit$3 -sun/awt/X11/XAnyEvent -sun/awt/X11/IXAnyEvent -java/awt/Window$WindowDisposerRecord -java/awt/KeyboardFocusManager -java/awt/KeyEventDispatcher -java/awt/KeyEventPostProcessor +java/awt/AWTEvent$1 +java/awt/AWTEvent$2 +java/awt/AWTEventMulticaster java/awt/AWTKeyStroke java/awt/AWTKeyStroke$1 -java/awt/DefaultKeyboardFocusManager -java/awt/DefaultFocusTraversalPolicy -java/awt/ContainerOrderFocusTraversalPolicy -java/awt/FocusTraversalPolicy -java/awt/MutableBoolean -java/util/Collections$UnmodifiableSet -sun/awt/HeadlessToolkit -sun/awt/X11/XKeyboardFocusManagerPeer -java/awt/peer/KeyboardFocusManagerPeer -sun/awt/X11/XKeyboardFocusManagerPeer$1 -sun/awt/X11/XFramePeer -java/awt/peer/FramePeer -java/awt/peer/WindowPeer -java/awt/peer/ContainerPeer -java/awt/peer/ComponentPeer -sun/awt/X11/XDecoratedPeer -sun/awt/X11/XWindowPeer -sun/awt/X11/XPanelPeer -java/awt/peer/PanelPeer -sun/awt/X11/XCanvasPeer -java/awt/peer/CanvasPeer -sun/awt/X11/XComponentPeer -java/awt/dnd/peer/DropTargetPeer -sun/awt/X11/XWindow -sun/awt/X11ComponentPeer -sun/awt/X11/XBaseWindow -sun/awt/X11/XCreateWindowParams -java/lang/Long$LongCache -sun/awt/X11/XBaseWindow$InitialiseState -sun/awt/X11/XBaseWindow$StateLock -sun/awt/X11/AwtGraphicsConfigData -sun/awt/X11/XVisualInfo -java/awt/SystemColor -sun/awt/X11/MotifColorUtilities -java/lang/StrictMath -sun/awt/X11/XRepaintArea -sun/awt/RepaintArea -sun/awt/X11/XWindowAttributesData -java/util/concurrent/locks/LockSupport -sun/awt/X11/WindowDimensions -java/awt/Point -java/util/TreeMap$Entry -sun/nio/cs/UTF_8 -sun/nio/cs/Unicode -sun/nio/cs/UTF_8$Encoder -sun/nio/cs/UTF_8$Decoder -sun/nio/cs/Surrogate$Generator -sun/awt/X11/XPropertyEvent -sun/awt/X11/XDropTargetEventProcessor -sun/awt/X11/XDragSourceContextPeer -sun/awt/X11/XDragSourceProtocolListener -sun/awt/dnd/SunDragSourceContextPeer -java/awt/dnd/peer/DragSourceContextPeer -sun/awt/X11/XAwtState -sun/awt/X11/XBaseWindow$1 -sun/awt/X11/XRootWindow -sun/nio/cs/ISO_8859_1 -sun/nio/cs/ISO_8859_1$Encoder -sun/nio/cs/ISO_8859_1$Decoder -sun/java2d/x11/X11SurfaceData$X11WindowSurfaceData -sun/java2d/loops/RenderLoops -sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec -sun/java2d/DefaultDisposerRecord -sun/java2d/x11/X11Renderer -sun/awt/X11/XGlobalCursorManager -sun/awt/GlobalCursorManager -sun/awt/X11/XToolkit$6 -java/awt/Cursor$CursorDisposer -java/awt/AWTException -java/awt/HeadlessException -java/lang/UnsupportedOperationException -sun/reflect/UnsafeLongFieldAccessorImpl -sun/reflect/UnsafeIntegerFieldAccessorImpl -sun/awt/X11/XClientMessageEvent -sun/awt/X11/XIconInfo -sun/awt/X11/XAWTIcon32_java_icon16_png -sun/awt/X11/XAWTIcon32_java_icon24_png -sun/awt/X11/XAWTIcon32_java_icon32_png -sun/awt/X11/XAWTIcon32_java_icon48_png -sun/awt/X11/XSizeHints -sun/awt/X11/XContentWindow -sun/awt/X11/XFocusProxyWindow -sun/awt/X11/XWMHints -java/util/LinkedList$ListItr -java/util/ListIterator -sun/awt/SunToolkit$2 -java/awt/image/BufferStrategy -java/awt/dnd/DropTarget -java/awt/dnd/DropTargetListener -java/awt/event/ComponentListener -java/awt/event/FocusListener -java/awt/event/HierarchyListener -java/awt/event/HierarchyBoundsListener -java/awt/event/KeyListener -java/awt/event/MouseListener -java/awt/event/MouseMotionListener -java/awt/event/MouseWheelListener -java/awt/event/InputMethodListener -java/awt/Component$NativeInLightFixer -java/awt/event/ContainerListener -javax/accessibility/AccessibleContext -sun/reflect/UnsafeObjectFieldAccessorImpl -java/awt/peer/LightweightPeer -sun/awt/X11/XLabelPeer -java/awt/peer/LabelPeer -sun/awt/X11/XMapEvent -sun/awt/X11/XQueryTree -sun/awt/X11/XConfigureEvent -sun/awt/X11/PropMwmHints -sun/awt/GlobalCursorManager$NativeUpdater -javax/swing/JFrame -javax/swing/WindowConstants -javax/swing/RootPaneContainer -javax/swing/TransferHandler$HasGetTransferHandler -javax/swing/JLabel -javax/swing/SwingConstants -javax/swing/JComponent -javax/swing/JComponent$1 -javax/swing/SwingUtilities -javax/swing/JRootPane -sun/security/action/GetBooleanAction -javax/swing/event/EventListenerList -javax/swing/JPanel -java/awt/FlowLayout -javax/swing/UIManager -javax/swing/UIManager$LookAndFeelInfo -sun/swing/SwingUtilities2 -sun/swing/SwingUtilities2$LSBCacheEntry -javax/swing/UIManager$LAFState -javax/swing/UIDefaults -javax/swing/MultiUIDefaults -javax/swing/UIManager$1 -javax/swing/plaf/metal/MetalLookAndFeel -javax/swing/plaf/basic/BasicLookAndFeel -javax/swing/LookAndFeel -sun/swing/DefaultLookup -javax/swing/plaf/metal/OceanTheme -javax/swing/plaf/metal/DefaultMetalTheme -javax/swing/plaf/metal/MetalTheme -javax/swing/plaf/ColorUIResource -javax/swing/plaf/UIResource -sun/swing/PrintColorUIResource -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate -javax/swing/plaf/FontUIResource -sun/swing/SwingLazyValue -javax/swing/UIDefaults$LazyValue -javax/swing/UIDefaults$ActiveValue -javax/swing/plaf/InsetsUIResource -sun/swing/SwingUtilities2$2 -javax/swing/plaf/basic/BasicLookAndFeel$2 -javax/swing/plaf/DimensionUIResource -javax/swing/UIDefaults$LazyInputMap -java/lang/Character$CharacterCache -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue -javax/swing/plaf/metal/MetalLookAndFeel$FontActiveValue -java/awt/print/PrinterJob -sun/swing/SwingUtilities2$AATextInfo -sun/awt/X11/XAWTXSettings -sun/awt/X11/XMSelectionListener -sun/awt/XSettings -sun/awt/X11/XMSelection -sun/awt/X11/XMSelection$1 -javax/swing/plaf/metal/MetalLookAndFeel$AATextListener -java/beans/PropertyChangeListener -java/beans/PropertyChangeListenerProxy -java/util/EventListenerProxy -sun/awt/EventListenerAggregate -javax/swing/UIDefaults$ProxyLazyValue -javax/swing/plaf/metal/OceanTheme$1 -javax/swing/plaf/metal/OceanTheme$2 -javax/swing/plaf/metal/OceanTheme$3 -javax/swing/plaf/metal/OceanTheme$4 -javax/swing/plaf/metal/OceanTheme$5 -javax/swing/plaf/metal/OceanTheme$6 -javax/swing/RepaintManager -javax/swing/RepaintManager$DisplayChangedHandler -javax/swing/SwingPaintEventDispatcher -sun/awt/PaintEventDispatcher -javax/swing/UIManager$2 -javax/swing/UIManager$3 -java/awt/PopupMenu -java/awt/Menu -java/awt/MenuItem -java/awt/MenuComponent -java/io/ObjectOutputStream -java/io/ObjectOutput -java/io/DataOutput -java/io/ObjectStreamConstants -java/io/PrintWriter -java/io/ObjectInputStream -java/io/ObjectInput -java/awt/Event -java/awt/im/InputContext -java/awt/event/MouseWheelEvent -java/awt/BufferCapabilities -sun/awt/CausedFocusEvent$Cause -java/awt/PointerInfo -java/awt/Component$BaselineResizeBehavior -java/awt/FontMetrics -java/awt/Image -java/awt/image/ImageProducer -java/awt/image/VolatileImage -java/awt/im/InputMethodRequests -java/awt/event/FocusEvent -java/awt/event/InputMethodEvent -java/awt/event/HierarchyEvent -javax/accessibility/AccessibleStateSet -com/sun/swing/internal/plaf/metal/resources/metal -sun/util/ResourceBundleEnumeration -com/sun/swing/internal/plaf/basic/resources/basic -javax/swing/plaf/basic/BasicPanelUI -javax/swing/plaf/PanelUI -javax/swing/plaf/ComponentUI -sun/reflect/misc/MethodUtil -sun/reflect/misc/MethodUtil$1 -java/util/jar/JarFile -java/util/zip/ZipFile -java/util/zip/ZipConstants -java/util/jar/JavaUtilJarAccessImpl -sun/misc/JavaUtilJarAccess -sun/misc/JarIndex -java/util/zip/ZipEntry -java/util/jar/JarFile$JarFileEntry -java/util/jar/JarEntry -sun/misc/URLClassPath$JarLoader$2 -sun/net/www/protocol/jar/JarURLConnection -java/net/JarURLConnection -sun/net/www/protocol/jar/JarFileFactory -sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController -java/net/HttpURLConnection -sun/net/www/protocol/jar/URLJarFile -sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry -sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream -java/util/zip/ZipFile$ZipFileInputStream -java/security/AllPermissionCollection -java/lang/IllegalAccessException -javax/swing/JPasswordField -javax/swing/JTextField -javax/swing/text/JTextComponent -javax/swing/Scrollable -javax/swing/JLayeredPane -javax/swing/JRootPane$1 -javax/swing/ArrayTable -javax/swing/JInternalFrame -javax/swing/JRootPane$RootLayout -javax/swing/BufferStrategyPaintManager -javax/swing/RepaintManager$PaintManager -javax/swing/plaf/metal/MetalRootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI -javax/swing/plaf/RootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap -javax/swing/plaf/ComponentInputMapUIResource -javax/swing/ComponentInputMap -javax/swing/InputMap -javax/swing/plaf/InputMapUIResource -javax/swing/KeyStroke -java/awt/VKCollection -sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl -javax/swing/plaf/basic/LazyActionMap -javax/swing/plaf/ActionMapUIResource -javax/swing/ActionMap -javax/swing/LayoutFocusTraversalPolicy -javax/swing/SortingFocusTraversalPolicy -javax/swing/InternalFrameFocusTraversalPolicy -javax/swing/SwingContainerOrderFocusTraversalPolicy -javax/swing/SwingDefaultFocusTraversalPolicy -javax/swing/LayoutComparator -javax/swing/plaf/metal/MetalLabelUI -javax/swing/plaf/basic/BasicLabelUI -javax/swing/plaf/LabelUI -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 -javax/swing/plaf/basic/BasicHTML -javax/swing/SystemEventQueueUtilities -javax/swing/SystemEventQueueUtilities$SystemEventQueue -sun/awt/NullComponentPeer -java/awt/event/WindowEvent -java/awt/EventQueue$1 -java/awt/EventDispatchThread$1 -java/awt/Conditional -java/awt/EventDispatchThread$HierarchyEventFilter -java/awt/EventFilter$FilterAction -sun/awt/dnd/SunDropTargetEvent -java/awt/event/ActionEvent -java/util/jar/Manifest -java/io/ByteArrayInputStream -java/util/jar/Attributes -java/util/jar/Manifest$FastInputStream -java/util/jar/Attributes$Name -sun/misc/ASCIICaseInsensitiveComparator -java/util/jar/JarVerifier -java/io/ByteArrayOutputStream -sun/misc/ExtensionDependency -java/lang/Package -sun/security/util/ManifestEntryVerifier -sun/security/provider/Sun -java/security/Provider -java/security/Provider$ServiceKey -java/security/Provider$EngineDescription -sun/security/provider/Sun$1 -java/security/Security -java/security/Security$1 -sun/misc/FloatingDecimal -sun/misc/FloatingDecimal$1 -sun/security/provider/NativePRNG -java/security/SecureRandomSpi -sun/security/provider/NativePRNG$1 -sun/security/provider/NativePRNG$RandomIO -sun/misc/BASE64Decoder -sun/misc/CharacterDecoder -sun/security/util/SignatureFileVerifier -java/awt/event/KeyAdapter -java/lang/NumberFormatException -java/lang/IllegalArgumentException -java/io/FileWriter -java/net/Authenticator -java/net/MalformedURLException -javax/swing/text/Element -javax/swing/text/Document -javax/swing/text/PlainDocument -javax/swing/text/AbstractDocument -javax/swing/text/GapContent -javax/swing/text/AbstractDocument$Content -javax/swing/text/GapVector -javax/swing/text/GapContent$MarkVector -javax/swing/text/GapContent$MarkData -javax/swing/text/StyleContext -javax/swing/text/AbstractDocument$AttributeContext -javax/swing/text/StyleConstants -javax/swing/text/StyleConstants$CharacterConstants -javax/swing/text/AttributeSet$CharacterAttribute -javax/swing/text/StyleConstants$FontConstants -javax/swing/text/AttributeSet$FontAttribute -javax/swing/text/StyleConstants$ColorConstants -javax/swing/text/AttributeSet$ColorAttribute -javax/swing/text/StyleConstants$ParagraphConstants -javax/swing/text/AttributeSet$ParagraphAttribute -javax/swing/text/StyleContext$FontKey -javax/swing/text/SimpleAttributeSet -javax/swing/text/MutableAttributeSet -javax/swing/text/AttributeSet -javax/swing/text/SimpleAttributeSet$EmptyAttributeSet -javax/swing/text/StyleContext$NamedStyle -javax/swing/text/Style -javax/swing/text/SimpleAttributeSet$1 -javax/swing/text/StyleContext$SmallAttributeSet -javax/swing/text/AbstractDocument$BidiRootElement -javax/swing/text/AbstractDocument$BranchElement -javax/swing/text/AbstractDocument$AbstractElement -javax/swing/tree/TreeNode -javax/swing/text/AbstractDocument$1 -javax/swing/text/AbstractDocument$BidiElement -javax/swing/text/AbstractDocument$LeafElement -javax/swing/text/GapContent$StickyPosition -javax/swing/text/Position -javax/swing/text/StyleContext$KeyEnumeration -javax/swing/text/GapContent$InsertUndo -javax/swing/undo/AbstractUndoableEdit -javax/swing/undo/UndoableEdit -javax/swing/text/AbstractDocument$DefaultDocumentEvent -javax/swing/event/DocumentEvent -javax/swing/undo/CompoundEdit -javax/swing/event/DocumentEvent$EventType -javax/swing/text/Segment -java/text/CharacterIterator -javax/swing/text/Utilities -javax/swing/text/SegmentCache -javax/swing/text/SegmentCache$CachedSegment -javax/swing/event/UndoableEditEvent -javax/swing/text/AbstractDocument$ElementEdit -javax/swing/event/DocumentEvent$ElementChange -java/net/Socket -java/net/InetAddress -java/net/InetAddress$Cache -java/net/InetAddress$Cache$Type -java/net/InetAddressImplFactory -java/net/Inet4AddressImpl -java/net/InetAddressImpl -java/net/InetAddress$1 -sun/net/spi/nameservice/NameService -sun/net/util/IPAddressUtil -java/util/RandomAccessSubList -java/util/SubList -java/util/SubList$1 -java/util/AbstractList$ListItr -java/net/Inet4Address -java/net/InetSocketAddress -java/net/SocketAddress -java/net/SocksSocketImpl -java/net/SocksConsts -java/net/PlainSocketImpl -java/net/SocketImpl -java/net/SocketOptions -java/net/SocketException -java/net/SocksSocketImpl$5 -java/net/ProxySelector -sun/net/spi/DefaultProxySelector -sun/net/spi/DefaultProxySelector$1 -sun/net/NetProperties -sun/net/NetProperties$1 -sun/net/spi/DefaultProxySelector$NonProxyInfo -java/net/Inet6Address -java/net/URI -java/net/URI$Parser -java/net/Proxy -java/net/Proxy$Type -java/net/ConnectException -javax/swing/JMenu -javax/swing/MenuElement -javax/swing/JMenuItem -javax/swing/AbstractButton -java/awt/ItemSelectable -javax/swing/event/MenuListener -javax/swing/JCheckBoxMenuItem -javax/swing/Icon -javax/swing/JButton -java/awt/event/WindowListener -java/net/URLClassLoader$2 -javax/swing/ImageIcon -javax/swing/ImageIcon$1 -java/awt/MediaTracker -sun/misc/SoftCache$ValueCell -sun/awt/image/URLImageSource -sun/awt/image/InputStreamImageSource -sun/awt/image/ImageFetchable -sun/awt/image/ToolkitImage -java/awt/Image$1 -sun/awt/image/SurfaceManager$ImageAccessor -sun/awt/image/SurfaceManager -sun/awt/image/NativeLibLoader -java/awt/ImageMediaEntry -java/awt/MediaEntry -sun/awt/image/ImageRepresentation -java/awt/image/ImageConsumer -sun/awt/image/ImageWatched -sun/awt/image/ImageWatched$Link -sun/awt/image/ImageWatched$WeakLink -sun/awt/image/ImageConsumerQueue -sun/awt/image/ImageFetcher -sun/awt/image/FetcherInfo -sun/awt/image/ImageFetcher$1 -sun/awt/image/GifImageDecoder -sun/awt/image/ImageDecoder -sun/awt/image/GifFrame -java/awt/image/Raster -java/awt/image/DataBufferByte -java/awt/image/DataBuffer -java/awt/image/PixelInterleavedSampleModel -java/awt/image/ComponentSampleModel -java/awt/image/SampleModel -sun/awt/image/ByteInterleavedRaster -sun/awt/image/ByteComponentRaster -sun/awt/image/SunWritableRaster -java/awt/image/WritableRaster -java/awt/image/BufferedImage -java/awt/image/WritableRenderedImage -java/awt/image/RenderedImage -sun/awt/image/IntegerComponentRaster -sun/awt/image/BytePackedRaster +java/awt/ActiveEvent +java/awt/Adjustable +java/awt/AlphaComposite +java/awt/BasicStroke +java/awt/BorderLayout java/awt/Canvas -sun/font/FontDesignMetrics -sun/font/FontStrikeDesc -sun/font/CompositeStrike -sun/font/FontStrikeDisposer -sun/font/StrikeCache$SoftDisposerRef -sun/font/StrikeCache$DisposableStrike -sun/font/TrueTypeFont$TTDisposerRecord -sun/font/TrueTypeFont$1 -java/io/RandomAccessFile -java/nio/ByteBufferAsIntBufferB -java/nio/IntBuffer -sun/font/TrueTypeFont$DirectoryEntry -java/nio/ByteBufferAsShortBufferB -java/nio/ShortBuffer -sun/nio/cs/UTF_16 -sun/nio/cs/UTF_16$Decoder -sun/nio/cs/UnicodeDecoder -sun/font/FileFontStrike -sun/font/FileFont$FileFontDisposer -sun/font/TrueTypeGlyphMapper -sun/font/CMap -sun/font/CMap$NullCMapClass -sun/font/CMap$CMapFormat4 -java/nio/ByteBufferAsCharBufferB -sun/font/FontDesignMetrics$KeyReference -sun/awt/image/PNGImageDecoder -sun/awt/image/PNGFilterInputStream -java/util/zip/InflaterInputStream -java/util/zip/Inflater -sun/awt/EventQueueItem -sun/awt/SunToolkit$3 -sun/awt/X11/XExposeEvent -sun/awt/X11/ComponentAccessor -sun/awt/X11/ComponentAccessor$1 -sun/reflect/UnsafeBooleanFieldAccessorImpl -sun/awt/event/IgnorePaintEvent -java/awt/image/DataBufferInt -java/awt/image/SinglePixelPackedSampleModel -sun/awt/image/IntegerInterleavedRaster -sun/java2d/x11/X11RemoteOffScreenImage -sun/awt/image/RemoteOffScreenImage -sun/awt/image/OffScreenImage -sun/java2d/x11/X11RemoteOffScreenImage$X11RemoteSurfaceManager -sun/awt/image/OffScreenSurfaceManager -sun/awt/image/CachingSurfaceManager -sun/awt/image/RasterListener -sun/awt/image/BufImgSurfaceData -sun/java2d/opengl/GLXGraphicsConfig -sun/java2d/opengl/OGLGraphicsConfig -sun/java2d/x11/X11SurfaceData$X11PixmapSurfaceData -sun/awt/image/WritableRasterNative -sun/awt/image/DataBufferNative -sun/java2d/SurfaceManagerFactory -sun/java2d/x11/X11CachingSurfaceManager -sun/java2d/opengl/GLXSurfaceData -sun/java2d/opengl/OGLSurfaceData -sun/font/CompositeGlyphMapper -sun/java2d/loops/FontInfo -java/util/Date -sun/util/calendar/CalendarSystem -sun/util/calendar/Gregorian -sun/util/calendar/BaseCalendar -sun/util/calendar/AbstractCalendar -java/util/TimeZone -java/lang/InheritableThreadLocal -sun/util/calendar/ZoneInfo -sun/util/calendar/ZoneInfoFile -sun/util/calendar/ZoneInfoFile$1 -java/util/TimeZone$1 -sun/util/calendar/Gregorian$Date -sun/util/calendar/BaseCalendar$Date -sun/util/calendar/CalendarDate -sun/util/calendar/CalendarUtils -java/util/TimeZone$DisplayNames -sun/util/TimeZoneNameUtility -sun/util/resources/TimeZoneNames -sun/util/resources/TimeZoneNamesBundle -sun/util/resources/TimeZoneNames_en -java/util/spi/TimeZoneNameProvider -java/lang/ProcessBuilder -java/lang/ProcessImpl -java/lang/UNIXProcess -java/lang/Process -java/lang/UNIXProcess$Gate -java/lang/UNIXProcess$1 -java/lang/UNIXProcess$1$1 -java/lang/UNIXProcess$1$1$1 -java/net/ServerSocket -java/util/Random -java/util/concurrent/atomic/AtomicLong -java/lang/InternalError -java/io/StringReader -java/lang/SecurityException -java/io/FilterReader -java/lang/reflect/Proxy -java/lang/reflect/InvocationHandler -java/lang/NoSuchFieldException -java/lang/InstantiationException -java/lang/ArrayIndexOutOfBoundsException -java/lang/IndexOutOfBoundsException -javax/swing/JDialog -sun/awt/X11/XClipboard -sun/awt/datatransfer/SunClipboard +java/awt/CardLayout +java/awt/Color +java/awt/Component +java/awt/Component$1 +java/awt/Component$3 +java/awt/Component$AWTTreeLock +java/awt/Component$DummyRequestFocusController +java/awt/ComponentOrientation +java/awt/Composite +java/awt/Conditional +java/awt/Container +java/awt/Container$1 +java/awt/Container$EventTargetFilter +java/awt/Container$MouseEventTargetFilter +java/awt/ContainerOrderFocusTraversalPolicy +java/awt/Cursor +java/awt/Cursor$1 +java/awt/DefaultFocusTraversalPolicy +java/awt/DefaultKeyboardFocusManager +java/awt/DefaultKeyboardFocusManager$1 +java/awt/DefaultKeyboardFocusManager$DefaultKeyboardFocusManagerSentEvent +java/awt/DefaultKeyboardFocusManager$TypeAheadMarker +java/awt/Dialog +java/awt/Dialog$1 +java/awt/Dialog$3 +java/awt/Dialog$ModalExclusionType +java/awt/Dialog$ModalityType +java/awt/Dimension +java/awt/Event +java/awt/EventDispatchThread +java/awt/EventDispatchThread$1 +java/awt/EventDispatchThread$HierarchyEventFilter +java/awt/EventFilter +java/awt/EventFilter$FilterAction +java/awt/EventQueue +java/awt/EventQueue$1 +java/awt/EventQueue$2 +java/awt/EventQueue$3 +java/awt/EventQueue$4 +java/awt/EventQueue$5 +java/awt/FlowLayout +java/awt/FocusTraversalPolicy +java/awt/Font +java/awt/Font$FontAccessImpl +java/awt/FontMetrics +java/awt/Frame +java/awt/Frame$1 +java/awt/Graphics +java/awt/Graphics2D +java/awt/GraphicsCallback +java/awt/GraphicsCallback$PaintCallback +java/awt/GraphicsConfiguration +java/awt/GraphicsDevice +java/awt/GraphicsEnvironment +java/awt/GraphicsEnvironment$1 +java/awt/Image +java/awt/Image$1 +java/awt/ImageCapabilities +java/awt/ImageMediaEntry +java/awt/Insets +java/awt/ItemSelectable +java/awt/KeyEventDispatcher +java/awt/KeyEventPostProcessor +java/awt/KeyboardFocusManager +java/awt/KeyboardFocusManager$1 +java/awt/KeyboardFocusManager$2 +java/awt/KeyboardFocusManager$3 +java/awt/KeyboardFocusManager$HeavyweightFocusRequest +java/awt/KeyboardFocusManager$LightweightFocusRequest +java/awt/Label +java/awt/LayoutManager +java/awt/LayoutManager2 +java/awt/LightweightDispatcher +java/awt/LightweightDispatcher$1 +java/awt/LightweightDispatcher$2 +java/awt/MediaEntry +java/awt/MediaTracker +java/awt/MenuBar +java/awt/MenuComponent +java/awt/MenuContainer +java/awt/ModalEventFilter +java/awt/ModalEventFilter$1 +java/awt/ModalEventFilter$ApplicationModalEventFilter +java/awt/Paint +java/awt/Panel +java/awt/Point +java/awt/PrintGraphics +java/awt/Queue +java/awt/Rectangle +java/awt/RenderingHints +java/awt/RenderingHints$Key +java/awt/SecondaryLoop +java/awt/SentEvent +java/awt/SequencedEvent +java/awt/Shape +java/awt/SplashScreen +java/awt/Stroke +java/awt/SystemColor +java/awt/Toolkit +java/awt/Toolkit$1 +java/awt/Toolkit$2 +java/awt/Toolkit$3 +java/awt/Toolkit$4 +java/awt/Toolkit$5 +java/awt/Toolkit$DesktopPropertyChangeSupport +java/awt/Toolkit$SelectiveAWTEventListener +java/awt/Toolkit$ToolkitEventMulticaster +java/awt/Transparency +java/awt/TrayIcon +java/awt/VKCollection +java/awt/WaitDispatchSupport +java/awt/WaitDispatchSupport$1 +java/awt/WaitDispatchSupport$2 +java/awt/WaitDispatchSupport$5 +java/awt/Window +java/awt/Window$1 +java/awt/Window$1DisposeAction +java/awt/Window$Type +java/awt/Window$WindowDisposerRecord +java/awt/color/ColorSpace +java/awt/color/ICC_ColorSpace +java/awt/color/ICC_Profile +java/awt/color/ICC_Profile$1 +java/awt/color/ICC_ProfileRGB java/awt/datatransfer/Clipboard -java/awt/datatransfer/SystemFlavorMap +java/awt/datatransfer/ClipboardOwner +java/awt/datatransfer/DataFlavor java/awt/datatransfer/FlavorMap java/awt/datatransfer/FlavorTable -java/awt/datatransfer/SystemFlavorMap$1 -sun/net/ProgressMonitor -sun/net/DefaultProgressMeteringPolicy -sun/net/ProgressMeteringPolicy -java/awt/datatransfer/SystemFlavorMap$2 java/awt/datatransfer/MimeType -java/io/Externalizable java/awt/datatransfer/MimeTypeParameterList -sun/awt/datatransfer/DataTransferer -java/util/Collections$SynchronizedSet -java/util/Collections$SynchronizedCollection -java/awt/datatransfer/DataFlavor -java/awt/datatransfer/DataFlavor$1 -sun/awt/datatransfer/DataTransferer$CharsetComparator -sun/awt/datatransfer/DataTransferer$IndexedComparator -sun/nio/cs/UTF_16LE -sun/nio/cs/UTF_16BE -sun/awt/datatransfer/DataTransferer$DataFlavorComparator -java/rmi/Remote -sun/awt/datatransfer/DataTransferer$1 -sun/awt/X11/XDataTransferer -sun/awt/datatransfer/ToolkitThreadBlockedHandler -javax/imageio/ImageTypeSpecifier -sun/awt/X11/XSelection -sun/security/action/GetIntegerAction -sun/awt/X11/XSelection$IncrementalTransferHandler -sun/awt/X11/XSelection$SelectionEventHandler +java/awt/datatransfer/MimeTypeParseException +java/awt/datatransfer/SystemFlavorMap +java/awt/datatransfer/SystemFlavorMap$1 +java/awt/datatransfer/SystemFlavorMap$2 java/awt/datatransfer/Transferable +java/awt/dnd/DropTarget +java/awt/dnd/DropTargetContext +java/awt/dnd/DropTargetListener +java/awt/dnd/peer/DragSourceContextPeer +java/awt/dnd/peer/DropTargetPeer +java/awt/event/AWTEventListener +java/awt/event/AWTEventListenerProxy +java/awt/event/ActionEvent +java/awt/event/ActionListener +java/awt/event/AdjustmentEvent +java/awt/event/AdjustmentListener +java/awt/event/ComponentAdapter +java/awt/event/ComponentEvent +java/awt/event/ComponentListener +java/awt/event/ContainerEvent +java/awt/event/ContainerListener +java/awt/event/FocusAdapter +java/awt/event/FocusEvent +java/awt/event/FocusListener +java/awt/event/HierarchyBoundsListener +java/awt/event/HierarchyEvent +java/awt/event/HierarchyListener +java/awt/event/InputEvent +java/awt/event/InputEvent$1 +java/awt/event/InputMethodEvent +java/awt/event/InputMethodListener +java/awt/event/InvocationEvent +java/awt/event/ItemListener +java/awt/event/KeyAdapter +java/awt/event/KeyEvent +java/awt/event/KeyEvent$1 +java/awt/event/KeyListener +java/awt/event/MouseAdapter +java/awt/event/MouseEvent +java/awt/event/MouseListener +java/awt/event/MouseMotionAdapter +java/awt/event/MouseMotionListener +java/awt/event/MouseWheelEvent +java/awt/event/MouseWheelListener +java/awt/event/NativeLibLoader +java/awt/event/NativeLibLoader$1 +java/awt/event/PaintEvent +java/awt/event/TextListener +java/awt/event/WindowAdapter +java/awt/event/WindowEvent +java/awt/event/WindowFocusListener +java/awt/event/WindowListener +java/awt/event/WindowStateListener +java/awt/font/FontRenderContext +java/awt/font/GlyphVector +java/awt/font/LineMetrics +java/awt/font/TextAttribute +java/awt/geom/AffineTransform +java/awt/geom/Dimension2D +java/awt/geom/GeneralPath +java/awt/geom/Path2D +java/awt/geom/Path2D$Float +java/awt/geom/Point2D +java/awt/geom/Point2D$Double +java/awt/geom/Point2D$Float +java/awt/geom/Rectangle2D +java/awt/geom/Rectangle2D$Double +java/awt/geom/Rectangle2D$Float +java/awt/geom/RectangularShape +java/awt/im/InputContext +java/awt/im/InputMethodRequests +java/awt/im/spi/InputMethod +java/awt/im/spi/InputMethodContext +java/awt/im/spi/InputMethodDescriptor +java/awt/image/BufferStrategy +java/awt/image/BufferedImage +java/awt/image/BufferedImage$1 +java/awt/image/ColorModel +java/awt/image/ColorModel$1 +java/awt/image/ComponentSampleModel +java/awt/image/DataBuffer +java/awt/image/DataBuffer$1 +java/awt/image/DataBufferByte +java/awt/image/DataBufferInt +java/awt/image/DirectColorModel +java/awt/image/FilteredImageSource +java/awt/image/ImageConsumer +java/awt/image/ImageFilter +java/awt/image/ImageObserver +java/awt/image/ImageProducer +java/awt/image/IndexColorModel +java/awt/image/PackedColorModel +java/awt/image/PixelInterleavedSampleModel +java/awt/image/RGBImageFilter +java/awt/image/Raster +java/awt/image/RenderedImage +java/awt/image/SampleModel +java/awt/image/SinglePixelPackedSampleModel +java/awt/image/VolatileImage +java/awt/image/WritableRaster +java/awt/image/WritableRenderedImage +java/awt/peer/CanvasPeer +java/awt/peer/ComponentPeer +java/awt/peer/ContainerPeer +java/awt/peer/DialogPeer +java/awt/peer/FramePeer +java/awt/peer/KeyboardFocusManagerPeer +java/awt/peer/LabelPeer +java/awt/peer/LightweightPeer +java/awt/peer/PanelPeer +java/awt/peer/WindowPeer +java/awt/print/PrinterGraphics +java/beans/ChangeListenerMap +java/beans/PropertyChangeEvent +java/beans/PropertyChangeListener +java/beans/PropertyChangeListenerProxy +java/beans/PropertyChangeSupport +java/beans/PropertyChangeSupport$PropertyChangeListenerMap +java/io/Bits +java/io/BufferedInputStream +java/io/BufferedOutputStream +java/io/BufferedReader +java/io/BufferedWriter +java/io/ByteArrayInputStream +java/io/ByteArrayOutputStream +java/io/Closeable +java/io/DataInput +java/io/DataInputStream +java/io/DataOutput +java/io/DataOutputStream +java/io/DefaultFileSystem java/io/EOFException -java/util/Vector$1 -java/util/zip/ZipFile$1 -java/util/zip/ZipFile$2 -java/util/jar/JarFile$1 -java/util/PropertyResourceBundle -java/util/ResourceBundle$Control$1 -java/util/Hashtable$EntrySet +java/io/ExpiringCache +java/io/ExpiringCache$1 +java/io/ExpiringCache$Entry +java/io/Externalizable +java/io/File +java/io/File$PathStatus +java/io/FileDescriptor +java/io/FileDescriptor$1 +java/io/FileInputStream +java/io/FileInputStream$1 +java/io/FileNotFoundException +java/io/FileOutputStream +java/io/FileOutputStream$1 +java/io/FilePermission +java/io/FilePermission$1 +java/io/FilePermissionCollection +java/io/FileReader +java/io/FileSystem +java/io/FileWriter +java/io/FilenameFilter +java/io/FilterInputStream +java/io/FilterOutputStream +java/io/FilterReader +java/io/Flushable +java/io/IOException +java/io/InputStream +java/io/InputStreamReader +java/io/ObjectInput +java/io/ObjectInputStream +java/io/ObjectOutput +java/io/ObjectOutputStream +java/io/ObjectOutputStream$BlockDataOutputStream +java/io/ObjectOutputStream$HandleTable +java/io/ObjectOutputStream$ReplaceTable +java/io/ObjectStreamClass +java/io/ObjectStreamClass$2 +java/io/ObjectStreamClass$Caches +java/io/ObjectStreamClass$EntryFuture +java/io/ObjectStreamClass$FieldReflector +java/io/ObjectStreamClass$FieldReflectorKey +java/io/ObjectStreamClass$WeakClassKey +java/io/ObjectStreamConstants +java/io/ObjectStreamField +java/io/OutputStream +java/io/OutputStreamWriter +java/io/PrintStream +java/io/PrintWriter +java/io/RandomAccessFile +java/io/Reader +java/io/Serializable +java/io/StringReader +java/io/StringWriter +java/io/UnixFileSystem +java/io/UnsupportedEncodingException +java/io/Writer +java/lang/AbstractStringBuilder +java/lang/Appendable +java/lang/ApplicationShutdownHooks +java/lang/ApplicationShutdownHooks$1 +java/lang/ArithmeticException +java/lang/ArrayIndexOutOfBoundsException +java/lang/ArrayStoreException +java/lang/AutoCloseable +java/lang/Boolean +java/lang/BootstrapMethodError +java/lang/Byte +java/lang/CharSequence +java/lang/Character +java/lang/Character$CharacterCache +java/lang/CharacterData +java/lang/CharacterDataLatin1 +java/lang/Class +java/lang/Class$1 +java/lang/Class$3 +java/lang/Class$4 +java/lang/Class$AnnotationData +java/lang/Class$Atomic +java/lang/Class$ReflectionData +java/lang/ClassCastException +java/lang/ClassLoader +java/lang/ClassLoader$2 +java/lang/ClassLoader$3 +java/lang/ClassLoader$NativeLibrary +java/lang/ClassLoader$ParallelLoaders +java/lang/ClassLoaderHelper +java/lang/ClassNotFoundException +java/lang/ClassValue$ClassValueMap +java/lang/CloneNotSupportedException +java/lang/Cloneable +java/lang/Comparable +java/lang/Compiler +java/lang/Compiler$1 +java/lang/Double +java/lang/Enum +java/lang/Error +java/lang/Exception +java/lang/ExceptionInInitializerError +java/lang/Float java/lang/IllegalAccessError +java/lang/IllegalAccessException +java/lang/IllegalArgumentException +java/lang/IllegalMonitorStateException +java/lang/IllegalStateException +java/lang/IncompatibleClassChangeError +java/lang/IndexOutOfBoundsException +java/lang/InstantiationException +java/lang/Integer +java/lang/Integer$IntegerCache +java/lang/InternalError +java/lang/InterruptedException +java/lang/Iterable +java/lang/LinkageError +java/lang/Long +java/lang/Long$LongCache +java/lang/Math +java/lang/NoClassDefFoundError +java/lang/NoSuchFieldException +java/lang/NoSuchMethodError +java/lang/NoSuchMethodException +java/lang/NullPointerException +java/lang/Number +java/lang/NumberFormatException +java/lang/Object +java/lang/OutOfMemoryError +java/lang/Package +java/lang/Process +java/lang/ProcessBuilder +java/lang/ProcessBuilder$NullInputStream +java/lang/ProcessBuilder$NullOutputStream +java/lang/ProcessEnvironment +java/lang/ProcessEnvironment$ExternalData +java/lang/ProcessEnvironment$StringEnvironment +java/lang/ProcessEnvironment$Value +java/lang/ProcessEnvironment$Variable +java/lang/ProcessImpl +java/lang/Readable +java/lang/ReflectiveOperationException +java/lang/Runnable +java/lang/Runtime +java/lang/RuntimeException +java/lang/RuntimePermission +java/lang/SecurityException +java/lang/SecurityManager +java/lang/Short +java/lang/Short$ShortCache +java/lang/Shutdown +java/lang/Shutdown$Lock +java/lang/StackOverflowError +java/lang/StackTraceElement +java/lang/StrictMath +java/lang/String +java/lang/String$CaseInsensitiveComparator +java/lang/StringBuffer +java/lang/StringBuilder +java/lang/StringCoding +java/lang/StringCoding$StringDecoder +java/lang/StringCoding$StringEncoder +java/lang/StringIndexOutOfBoundsException +java/lang/System +java/lang/System$2 +java/lang/SystemClassLoaderAction +java/lang/Terminator +java/lang/Terminator$1 +java/lang/Thread +java/lang/Thread$UncaughtExceptionHandler +java/lang/ThreadDeath +java/lang/ThreadGroup +java/lang/ThreadLocal +java/lang/ThreadLocal$ThreadLocalMap +java/lang/ThreadLocal$ThreadLocalMap$Entry +java/lang/Throwable +java/lang/Throwable$PrintStreamOrWriter +java/lang/Throwable$WrappedPrintStream +java/lang/Throwable$WrappedPrintWriter +java/lang/UNIXProcess +java/lang/UNIXProcess$1 +java/lang/UNIXProcess$2 +java/lang/UNIXProcess$3 +java/lang/UNIXProcess$4 +java/lang/UNIXProcess$LaunchMechanism +java/lang/UNIXProcess$ProcessPipeInputStream +java/lang/UNIXProcess$ProcessPipeOutputStream +java/lang/UNIXProcess$ProcessReaperThreadFactory +java/lang/UNIXProcess$ProcessReaperThreadFactory$1 +java/lang/UnsatisfiedLinkError +java/lang/UnsupportedOperationException +java/lang/VirtualMachineError +java/lang/Void +java/lang/annotation/Annotation +java/lang/invoke/CallSite +java/lang/invoke/ConstantCallSite +java/lang/invoke/DirectMethodHandle +java/lang/invoke/Invokers +java/lang/invoke/LambdaForm +java/lang/invoke/LambdaForm$NamedFunction +java/lang/invoke/MagicLambdaImpl +java/lang/invoke/MemberName +java/lang/invoke/MemberName$Factory +java/lang/invoke/MethodHandle +java/lang/invoke/MethodHandleImpl +java/lang/invoke/MethodHandleNatives +java/lang/invoke/MethodHandleStatics +java/lang/invoke/MethodHandleStatics$1 +java/lang/invoke/MethodType +java/lang/invoke/MethodType$ConcurrentWeakInternSet +java/lang/invoke/MethodType$ConcurrentWeakInternSet$WeakEntry +java/lang/invoke/MethodTypeForm +java/lang/invoke/MutableCallSite +java/lang/invoke/VolatileCallSite +java/lang/ref/FinalReference +java/lang/ref/Finalizer +java/lang/ref/Finalizer$FinalizerThread +java/lang/ref/PhantomReference +java/lang/ref/Reference +java/lang/ref/Reference$Lock +java/lang/ref/Reference$ReferenceHandler +java/lang/ref/ReferenceQueue +java/lang/ref/ReferenceQueue$Lock +java/lang/ref/ReferenceQueue$Null +java/lang/ref/SoftReference +java/lang/ref/WeakReference +java/lang/reflect/AccessibleObject +java/lang/reflect/AnnotatedElement +java/lang/reflect/Array +java/lang/reflect/Constructor +java/lang/reflect/Executable +java/lang/reflect/Field +java/lang/reflect/GenericDeclaration +java/lang/reflect/InvocationHandler +java/lang/reflect/InvocationTargetException +java/lang/reflect/Member +java/lang/reflect/Method +java/lang/reflect/Modifier +java/lang/reflect/Parameter +java/lang/reflect/Proxy +java/lang/reflect/Proxy$KeyFactory +java/lang/reflect/Proxy$ProxyClassFactory +java/lang/reflect/ReflectAccess +java/lang/reflect/ReflectPermission +java/lang/reflect/Type +java/lang/reflect/WeakCache +java/net/AbstractPlainSocketImpl +java/net/AbstractPlainSocketImpl$1 +java/net/Authenticator +java/net/ConnectException +java/net/DefaultInterface +java/net/HttpURLConnection +java/net/Inet4Address +java/net/Inet6Address +java/net/Inet6Address$Inet6AddressHolder +java/net/Inet6AddressImpl +java/net/InetAddress +java/net/InetAddress$1 +java/net/InetAddress$2 +java/net/InetAddress$Cache +java/net/InetAddress$Cache$Type +java/net/InetAddress$InetAddressHolder +java/net/InetAddressImpl +java/net/InetAddressImplFactory +java/net/InetSocketAddress +java/net/InetSocketAddress$InetSocketAddressHolder +java/net/InterfaceAddress +java/net/JarURLConnection +java/net/MalformedURLException +java/net/NetworkInterface +java/net/NetworkInterface$1 +java/net/NetworkInterface$2 +java/net/Parts +java/net/PlainSocketImpl +java/net/Proxy +java/net/Proxy$Type +java/net/ProxySelector +java/net/ServerSocket +java/net/Socket +java/net/SocketAddress +java/net/SocketException +java/net/SocketImpl +java/net/SocketOptions +java/net/SocksConsts +java/net/SocksSocketImpl +java/net/SocksSocketImpl$3 +java/net/URI +java/net/URI$Parser +java/net/URL +java/net/URLClassLoader +java/net/URLClassLoader$1 +java/net/URLClassLoader$2 +java/net/URLClassLoader$3 +java/net/URLClassLoader$3$1 +java/net/URLClassLoader$7 +java/net/URLConnection +java/net/URLStreamHandler +java/net/URLStreamHandlerFactory +java/nio/Bits +java/nio/Bits$1 +java/nio/Buffer +java/nio/ByteBuffer +java/nio/ByteBufferAsIntBufferB +java/nio/ByteBufferAsShortBufferB +java/nio/ByteOrder +java/nio/CharBuffer +java/nio/DirectByteBuffer +java/nio/DirectByteBuffer$Deallocator +java/nio/DirectLongBufferU +java/nio/HeapByteBuffer +java/nio/HeapCharBuffer +java/nio/IntBuffer +java/nio/LongBuffer +java/nio/MappedByteBuffer +java/nio/ShortBuffer +java/nio/channels/ByteChannel +java/nio/channels/Channel +java/nio/channels/FileChannel +java/nio/channels/GatheringByteChannel +java/nio/channels/InterruptibleChannel +java/nio/channels/ReadableByteChannel +java/nio/channels/ScatteringByteChannel +java/nio/channels/SeekableByteChannel +java/nio/channels/WritableByteChannel +java/nio/channels/spi/AbstractInterruptibleChannel +java/nio/channels/spi/AbstractInterruptibleChannel$1 +java/nio/charset/Charset +java/nio/charset/CharsetDecoder +java/nio/charset/CharsetEncoder +java/nio/charset/CoderResult +java/nio/charset/CoderResult$1 +java/nio/charset/CoderResult$2 +java/nio/charset/CoderResult$Cache +java/nio/charset/CodingErrorAction +java/nio/charset/StandardCharsets +java/nio/charset/spi/CharsetProvider +java/nio/file/Path +java/nio/file/Watchable +java/nio/file/attribute/FileAttribute +java/rmi/MarshalledObject +java/rmi/Remote +java/security/AccessControlContext +java/security/AccessController +java/security/AllPermission +java/security/AllPermissionCollection +java/security/BasicPermission +java/security/BasicPermissionCollection +java/security/CodeSigner +java/security/CodeSource +java/security/Guard +java/security/Permission +java/security/PermissionCollection +java/security/Permissions +java/security/Principal +java/security/PrivilegedAction +java/security/PrivilegedActionException +java/security/PrivilegedExceptionAction +java/security/ProtectionDomain +java/security/ProtectionDomain$1 +java/security/ProtectionDomain$3 +java/security/ProtectionDomain$Key +java/security/SecureClassLoader +java/security/UnresolvedPermission +java/security/cert/Certificate +java/text/AttributedCharacterIterator +java/text/AttributedCharacterIterator$Attribute +java/text/AttributedString +java/text/AttributedString$AttributedStringIterator +java/text/CharacterIterator +java/text/FieldPosition +java/text/Format +java/text/Format$Field java/text/MessageFormat java/text/MessageFormat$Field -java/text/Format$Field -java/lang/CloneNotSupportedException -sun/reflect/MethodAccessorGenerator -sun/reflect/AccessorGenerator -sun/reflect/ClassFileConstants -java/lang/Void -sun/reflect/ByteVectorFactory -sun/reflect/ByteVectorImpl -sun/reflect/ByteVector -sun/reflect/ClassFileAssembler -sun/reflect/UTF8 -sun/reflect/Label -sun/reflect/Label$PatchInfo -sun/reflect/MethodAccessorGenerator$1 -sun/reflect/ClassDefiner -sun/reflect/ClassDefiner$1 -sun/reflect/BootstrapConstructorAccessorImpl -java/awt/event/ActionListener +java/text/spi/BreakIteratorProvider +java/text/spi/CollatorProvider +java/text/spi/DateFormatProvider +java/text/spi/DateFormatSymbolsProvider +java/text/spi/DecimalFormatSymbolsProvider +java/text/spi/NumberFormatProvider +java/util/AbstractCollection +java/util/AbstractList +java/util/AbstractList$Itr +java/util/AbstractMap +java/util/AbstractQueue +java/util/AbstractSequentialList +java/util/AbstractSet +java/util/ArrayDeque +java/util/ArrayList +java/util/ArrayList$Itr +java/util/ArrayList$ListItr +java/util/ArrayList$SubList +java/util/ArrayList$SubList$1 +java/util/Arrays +java/util/Arrays$ArrayList +java/util/Arrays$LegacyMergeSort +java/util/BitSet +java/util/Collection +java/util/Collections +java/util/Collections$EmptyEnumeration +java/util/Collections$EmptyList +java/util/Collections$EmptyMap +java/util/Collections$EmptySet +java/util/Collections$SetFromMap +java/util/Collections$SynchronizedCollection +java/util/Collections$SynchronizedMap +java/util/Collections$SynchronizedSet +java/util/Collections$UnmodifiableCollection +java/util/Collections$UnmodifiableCollection$1 +java/util/Collections$UnmodifiableList +java/util/Collections$UnmodifiableMap +java/util/Collections$UnmodifiableRandomAccessList +java/util/Collections$UnmodifiableSet +java/util/Collections$UnmodifiableSortedSet +java/util/ComparableTimSort +java/util/Comparator +java/util/Date +java/util/Deque +java/util/Dictionary +java/util/Enumeration +java/util/EventListener +java/util/EventListenerProxy +java/util/EventObject +java/util/HashMap +java/util/HashMap$EntryIterator +java/util/HashMap$EntrySet +java/util/HashMap$HashIterator +java/util/HashMap$KeyIterator +java/util/HashMap$KeySet +java/util/HashMap$Node +java/util/HashMap$TreeNode +java/util/HashMap$ValueIterator +java/util/HashMap$Values +java/util/HashSet +java/util/Hashtable +java/util/Hashtable$Entry +java/util/Hashtable$EntrySet +java/util/Hashtable$Enumerator +java/util/Hashtable$ValueCollection +java/util/IdentityHashMap +java/util/IdentityHashMap$IdentityHashMapIterator +java/util/IdentityHashMap$KeyIterator +java/util/IdentityHashMap$KeySet +java/util/Iterator +java/util/LinkedHashMap +java/util/LinkedHashMap$Entry +java/util/LinkedHashMap$LinkedEntryIterator +java/util/LinkedHashMap$LinkedEntrySet +java/util/LinkedHashMap$LinkedHashIterator +java/util/LinkedHashMap$LinkedKeyIterator +java/util/LinkedHashMap$LinkedKeySet +java/util/LinkedHashSet +java/util/LinkedList +java/util/LinkedList$ListItr +java/util/LinkedList$Node +java/util/List +java/util/ListIterator +java/util/ListResourceBundle +java/util/Locale +java/util/Locale$1 +java/util/Locale$Cache +java/util/Locale$Category +java/util/Locale$LocaleKey +java/util/Map +java/util/Map$Entry +java/util/MissingResourceException +java/util/NavigableMap +java/util/NavigableSet +java/util/Objects +java/util/PriorityQueue +java/util/Properties +java/util/Properties$LineReader +java/util/PropertyResourceBundle +java/util/Queue +java/util/Random +java/util/RandomAccess +java/util/ResourceBundle +java/util/ResourceBundle$1 +java/util/ResourceBundle$BundleReference +java/util/ResourceBundle$CacheKey +java/util/ResourceBundle$CacheKeyReference +java/util/ResourceBundle$Control +java/util/ResourceBundle$Control$1 +java/util/ResourceBundle$Control$CandidateListCache +java/util/ResourceBundle$LoaderReference +java/util/ResourceBundle$RBClassLoader +java/util/ResourceBundle$RBClassLoader$1 +java/util/ResourceBundle$SingleFormatControl +java/util/ServiceLoader +java/util/ServiceLoader$1 +java/util/ServiceLoader$LazyIterator +java/util/Set +java/util/SortedMap +java/util/SortedSet +java/util/Stack +java/util/StringTokenizer +java/util/TimSort +java/util/TimeZone +java/util/TimeZone$1 +java/util/TreeMap +java/util/TreeMap$Entry +java/util/TreeMap$KeyIterator +java/util/TreeMap$KeySet +java/util/TreeMap$PrivateEntryIterator +java/util/TreeSet +java/util/Vector +java/util/Vector$1 +java/util/Vector$Itr +java/util/Vector$ListItr +java/util/WeakHashMap +java/util/WeakHashMap$Entry +java/util/WeakHashMap$HashIterator +java/util/WeakHashMap$KeyIterator +java/util/WeakHashMap$KeySet +java/util/concurrent/AbstractExecutorService +java/util/concurrent/BlockingQueue +java/util/concurrent/ConcurrentHashMap +java/util/concurrent/ConcurrentHashMap$BaseIterator +java/util/concurrent/ConcurrentHashMap$CollectionView +java/util/concurrent/ConcurrentHashMap$CounterCell +java/util/concurrent/ConcurrentHashMap$EntrySetView +java/util/concurrent/ConcurrentHashMap$ForwardingNode +java/util/concurrent/ConcurrentHashMap$KeyIterator +java/util/concurrent/ConcurrentHashMap$KeySetView +java/util/concurrent/ConcurrentHashMap$Node +java/util/concurrent/ConcurrentHashMap$Segment +java/util/concurrent/ConcurrentHashMap$Traverser +java/util/concurrent/ConcurrentHashMap$ValuesView +java/util/concurrent/ConcurrentMap +java/util/concurrent/CopyOnWriteArrayList +java/util/concurrent/DelayQueue +java/util/concurrent/Delayed +java/util/concurrent/Executor +java/util/concurrent/ExecutorService +java/util/concurrent/Executors +java/util/concurrent/RejectedExecutionHandler +java/util/concurrent/SynchronousQueue +java/util/concurrent/SynchronousQueue$TransferStack +java/util/concurrent/SynchronousQueue$TransferStack$SNode +java/util/concurrent/SynchronousQueue$Transferer +java/util/concurrent/ThreadFactory +java/util/concurrent/ThreadPoolExecutor +java/util/concurrent/ThreadPoolExecutor$AbortPolicy +java/util/concurrent/ThreadPoolExecutor$Worker +java/util/concurrent/TimeUnit +java/util/concurrent/TimeUnit$1 +java/util/concurrent/TimeUnit$2 +java/util/concurrent/TimeUnit$3 +java/util/concurrent/TimeUnit$4 +java/util/concurrent/TimeUnit$5 +java/util/concurrent/TimeUnit$6 +java/util/concurrent/TimeUnit$7 +java/util/concurrent/atomic/AtomicBoolean +java/util/concurrent/atomic/AtomicInteger +java/util/concurrent/atomic/AtomicLong +java/util/concurrent/atomic/AtomicReferenceFieldUpdater +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl$1 +java/util/concurrent/locks/AbstractOwnableSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject +java/util/concurrent/locks/AbstractQueuedSynchronizer$Node +java/util/concurrent/locks/Condition +java/util/concurrent/locks/Lock +java/util/concurrent/locks/LockSupport +java/util/concurrent/locks/ReadWriteLock +java/util/concurrent/locks/ReentrantLock +java/util/concurrent/locks/ReentrantLock$NonfairSync +java/util/concurrent/locks/ReentrantLock$Sync +java/util/concurrent/locks/ReentrantReadWriteLock +java/util/concurrent/locks/ReentrantReadWriteLock$NonfairSync +java/util/concurrent/locks/ReentrantReadWriteLock$ReadLock +java/util/concurrent/locks/ReentrantReadWriteLock$Sync +java/util/concurrent/locks/ReentrantReadWriteLock$Sync$ThreadLocalHoldCounter +java/util/concurrent/locks/ReentrantReadWriteLock$WriteLock +java/util/function/BiFunction +java/util/jar/Attributes +java/util/jar/Attributes$Name +java/util/jar/JarEntry +java/util/jar/JarFile +java/util/jar/JarFile$JarEntryIterator +java/util/jar/JarFile$JarFileEntry +java/util/jar/JarVerifier +java/util/jar/JarVerifier$3 +java/util/jar/JavaUtilJarAccessImpl +java/util/jar/Manifest +java/util/jar/Manifest$FastInputStream +java/util/logging/Handler +java/util/logging/Level +java/util/logging/Level$KnownLevel +java/util/logging/LogManager +java/util/logging/LogManager$1 +java/util/logging/LogManager$2 +java/util/logging/LogManager$3 +java/util/logging/LogManager$5 +java/util/logging/LogManager$Cleaner +java/util/logging/LogManager$LogNode +java/util/logging/LogManager$LoggerContext +java/util/logging/LogManager$LoggerContext$1 +java/util/logging/LogManager$LoggerWeakRef +java/util/logging/LogManager$RootLogger +java/util/logging/LogManager$SystemLoggerContext +java/util/logging/Logger +java/util/logging/Logger$1 +java/util/logging/LoggingPermission +java/util/logging/LoggingProxyImpl +java/util/spi/CalendarDataProvider +java/util/spi/CurrencyNameProvider +java/util/spi/LocaleNameProvider +java/util/spi/LocaleServiceProvider +java/util/spi/ResourceBundleControlProvider +java/util/spi/TimeZoneNameProvider +java/util/zip/CRC32 +java/util/zip/Checksum +java/util/zip/Inflater +java/util/zip/InflaterInputStream +java/util/zip/ZStreamRef +java/util/zip/ZipCoder +java/util/zip/ZipConstants +java/util/zip/ZipEntry +java/util/zip/ZipException +java/util/zip/ZipFile +java/util/zip/ZipFile$1 +java/util/zip/ZipFile$ZipEntryIterator +java/util/zip/ZipFile$ZipFileInflaterInputStream +java/util/zip/ZipFile$ZipFileInputStream +java/util/zip/ZipUtils +javax/accessibility/Accessible +javax/accessibility/AccessibleContext +javax/swing/AbstractAction +javax/swing/AbstractButton +javax/swing/AbstractButton$Handler +javax/swing/AbstractListModel +javax/swing/Action +javax/swing/ActionMap +javax/swing/AncestorNotifier +javax/swing/ArrayTable +javax/swing/Autoscroller +javax/swing/BorderFactory +javax/swing/BoundedRangeModel +javax/swing/Box +javax/swing/Box$Filler +javax/swing/BoxLayout +javax/swing/ButtonGroup +javax/swing/ButtonModel +javax/swing/CellRendererPane +javax/swing/ClientPropertyKey +javax/swing/ClientPropertyKey$1 +javax/swing/ComboBoxEditor +javax/swing/ComboBoxModel +javax/swing/ComponentInputMap +javax/swing/DefaultBoundedRangeModel +javax/swing/DefaultButtonModel +javax/swing/DefaultComboBoxModel +javax/swing/DefaultListCellRenderer +javax/swing/DefaultListCellRenderer$UIResource +javax/swing/DefaultListSelectionModel +javax/swing/DefaultSingleSelectionModel +javax/swing/DropMode +javax/swing/FocusManager +javax/swing/GrayFilter +javax/swing/Icon +javax/swing/ImageIcon +javax/swing/ImageIcon$1 +javax/swing/ImageIcon$2 +javax/swing/ImageIcon$2$1 +javax/swing/ImageIcon$3 +javax/swing/InputMap +javax/swing/InternalFrameFocusTraversalPolicy +javax/swing/JButton +javax/swing/JCheckBox +javax/swing/JCheckBoxMenuItem +javax/swing/JComboBox +javax/swing/JComboBox$1 +javax/swing/JComboBox$KeySelectionManager +javax/swing/JComponent +javax/swing/JComponent$1 +javax/swing/JComponent$2 +javax/swing/JDialog +javax/swing/JEditorPane +javax/swing/JFrame +javax/swing/JInternalFrame +javax/swing/JLabel +javax/swing/JLayer +javax/swing/JLayeredPane +javax/swing/JList +javax/swing/JMenu +javax/swing/JMenu$MenuChangeListener +javax/swing/JMenu$WinListener +javax/swing/JMenuBar +javax/swing/JMenuItem +javax/swing/JMenuItem$MenuItemFocusListener +javax/swing/JPanel +javax/swing/JPasswordField +javax/swing/JPopupMenu +javax/swing/JPopupMenu$Separator +javax/swing/JRadioButton +javax/swing/JRadioButtonMenuItem +javax/swing/JRootPane +javax/swing/JRootPane$1 +javax/swing/JRootPane$RootLayout +javax/swing/JScrollBar +javax/swing/JScrollBar$ModelListener +javax/swing/JScrollPane +javax/swing/JScrollPane$ScrollBar +javax/swing/JSeparator +javax/swing/JSplitPane +javax/swing/JTextArea +javax/swing/JTextField +javax/swing/JTextField$NotifyAction +javax/swing/JTextField$ScrollRepainter +javax/swing/JToggleButton +javax/swing/JToggleButton$ToggleButtonModel +javax/swing/JToolBar +javax/swing/JToolBar$DefaultToolBarLayout +javax/swing/JToolBar$Separator +javax/swing/JViewport +javax/swing/JViewport$ViewListener +javax/swing/JWindow +javax/swing/KeyStroke +javax/swing/KeyboardManager +javax/swing/KeyboardManager$ComponentKeyStrokePair +javax/swing/LayoutComparator +javax/swing/LayoutFocusTraversalPolicy +javax/swing/ListCellRenderer +javax/swing/ListModel +javax/swing/ListSelectionModel +javax/swing/LookAndFeel +javax/swing/MenuElement +javax/swing/MenuSelectionManager +javax/swing/MultiUIDefaults +javax/swing/MutableComboBoxModel +javax/swing/PopupFactory +javax/swing/RepaintManager +javax/swing/RepaintManager$2 +javax/swing/RepaintManager$3 +javax/swing/RepaintManager$DisplayChangedHandler +javax/swing/RepaintManager$PaintManager +javax/swing/RepaintManager$ProcessingRunnable +javax/swing/RootPaneContainer +javax/swing/ScrollPaneConstants +javax/swing/ScrollPaneLayout +javax/swing/ScrollPaneLayout$UIResource +javax/swing/Scrollable +javax/swing/SingleSelectionModel +javax/swing/SizeRequirements +javax/swing/SortingFocusTraversalPolicy +javax/swing/SwingConstants +javax/swing/SwingContainerOrderFocusTraversalPolicy +javax/swing/SwingDefaultFocusTraversalPolicy +javax/swing/SwingHeavyWeight +javax/swing/SwingPaintEventDispatcher +javax/swing/SwingUtilities +javax/swing/SwingUtilities$SharedOwnerFrame javax/swing/Timer javax/swing/Timer$DoPostEvent javax/swing/TimerQueue javax/swing/TimerQueue$1 +javax/swing/TimerQueue$DelayedTimer javax/swing/ToolTipManager -java/awt/event/MouseAdapter +javax/swing/ToolTipManager$AccessibilityKeyListener +javax/swing/ToolTipManager$MoveBeforeEnterListener javax/swing/ToolTipManager$insideTimerAction javax/swing/ToolTipManager$outsideTimerAction javax/swing/ToolTipManager$stillInsideTimerAction -javax/swing/ToolTipManager$Actions -sun/swing/UIAction -javax/swing/Action -javax/swing/ToolTipManager$MoveBeforeEnterListener -java/awt/event/MouseMotionAdapter -java/util/Hashtable$ValueCollection -javax/swing/event/CaretListener -javax/swing/JToolBar -javax/swing/JSplitPane -javax/swing/border/Border -javax/swing/JToggleButton -javax/swing/border/EmptyBorder +javax/swing/TransferHandler +javax/swing/TransferHandler$DropHandler +javax/swing/TransferHandler$HasGetTransferHandler +javax/swing/TransferHandler$SwingDropTarget +javax/swing/TransferHandler$TransferAction +javax/swing/TransferHandler$TransferAction$1 +javax/swing/TransferHandler$TransferAction$2 +javax/swing/TransferHandler$TransferSupport +javax/swing/UIDefaults +javax/swing/UIDefaults$ActiveValue +javax/swing/UIDefaults$LazyInputMap +javax/swing/UIDefaults$LazyValue +javax/swing/UIDefaults$TextAndMnemonicHashMap +javax/swing/UIManager +javax/swing/UIManager$1 +javax/swing/UIManager$2 +javax/swing/UIManager$LAFState +javax/swing/UIManager$LookAndFeelInfo +javax/swing/ViewportLayout +javax/swing/WindowConstants javax/swing/border/AbstractBorder -javax/swing/DefaultButtonModel -javax/swing/ButtonModel -javax/swing/AbstractButton$Handler -javax/swing/event/ChangeListener -java/awt/event/ItemListener -javax/swing/plaf/metal/MetalButtonUI -javax/swing/plaf/basic/BasicButtonUI -javax/swing/plaf/ButtonUI -javax/swing/plaf/metal/MetalBorders -javax/swing/plaf/BorderUIResource$CompoundBorderUIResource +javax/swing/border/BevelBorder +javax/swing/border/Border javax/swing/border/CompoundBorder -javax/swing/plaf/metal/MetalBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$MarginBorder -javax/swing/plaf/basic/BasicButtonListener -java/awt/AWTEventMulticaster -java/awt/event/WindowFocusListener -java/awt/event/WindowStateListener -java/awt/event/AdjustmentListener -java/awt/event/TextListener +javax/swing/border/EmptyBorder +javax/swing/border/EtchedBorder +javax/swing/border/LineBorder +javax/swing/border/MatteBorder +javax/swing/event/AncestorEvent javax/swing/event/AncestorListener -java/beans/VetoableChangeListener -javax/swing/ButtonGroup -javax/swing/JToggleButton$ToggleButtonModel -javax/swing/plaf/metal/MetalToggleButtonUI -javax/swing/plaf/basic/BasicToggleButtonUI -javax/swing/plaf/metal/MetalBorders$ToggleButtonBorder -java/awt/CardLayout -javax/swing/Box -javax/swing/plaf/metal/MetalBorders$TextFieldBorder -javax/swing/plaf/metal/MetalBorders$Flush3DBorder -javax/swing/BoxLayout -javax/swing/JMenuBar -javax/swing/DefaultSingleSelectionModel -javax/swing/SingleSelectionModel -javax/swing/plaf/basic/BasicMenuBarUI -javax/swing/plaf/MenuBarUI -javax/swing/plaf/basic/DefaultMenuLayout -javax/swing/plaf/metal/MetalBorders$MenuBarBorder -javax/swing/plaf/basic/BasicMenuBarUI$Handler -javax/swing/KeyboardManager -javax/swing/event/MenuEvent -javax/swing/JMenu$MenuChangeListener -javax/swing/JMenuItem$MenuItemFocusListener -javax/swing/plaf/basic/BasicMenuUI -javax/swing/plaf/basic/BasicMenuItemUI -javax/swing/plaf/MenuItemUI -javax/swing/plaf/metal/MetalBorders$MenuItemBorder -javax/swing/plaf/metal/MetalIconFactory -javax/swing/plaf/metal/MetalIconFactory$MenuArrowIcon -javax/swing/plaf/basic/BasicMenuUI$Handler -javax/swing/event/MenuKeyListener -javax/swing/plaf/basic/BasicMenuItemUI$Handler -javax/swing/event/MenuDragMouseListener -javax/swing/event/MouseInputListener +javax/swing/event/CaretEvent +javax/swing/event/CaretListener javax/swing/event/ChangeEvent -java/awt/event/ContainerEvent -javax/swing/plaf/metal/MetalIconFactory$MenuItemArrowIcon -javax/swing/JPopupMenu -javax/swing/plaf/basic/BasicPopupMenuUI -javax/swing/plaf/PopupMenuUI -javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper -java/awt/event/AWTEventListenerProxy -java/awt/Toolkit$SelectiveAWTEventListener -java/awt/Toolkit$ToolkitEventMulticaster -javax/swing/plaf/basic/BasicLookAndFeel$1 -javax/swing/plaf/metal/MetalBorders$PopupMenuBorder -javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener +javax/swing/event/ChangeListener +javax/swing/event/DocumentEvent +javax/swing/event/DocumentEvent$ElementChange +javax/swing/event/DocumentEvent$EventType +javax/swing/event/DocumentListener +javax/swing/event/EventListenerList +javax/swing/event/ListDataListener +javax/swing/event/ListSelectionListener +javax/swing/event/MenuDragMouseListener +javax/swing/event/MenuEvent +javax/swing/event/MenuKeyListener +javax/swing/event/MenuListener +javax/swing/event/MouseInputAdapter +javax/swing/event/MouseInputListener javax/swing/event/PopupMenuListener +javax/swing/event/UndoableEditEvent +javax/swing/event/UndoableEditListener +javax/swing/plaf/ActionMapUIResource +javax/swing/plaf/BorderUIResource +javax/swing/plaf/BorderUIResource$EmptyBorderUIResource +javax/swing/plaf/BorderUIResource$LineBorderUIResource +javax/swing/plaf/ButtonUI +javax/swing/plaf/ColorUIResource +javax/swing/plaf/ComboBoxUI +javax/swing/plaf/ComponentInputMapUIResource +javax/swing/plaf/ComponentUI +javax/swing/plaf/DimensionUIResource +javax/swing/plaf/FontUIResource +javax/swing/plaf/IconUIResource +javax/swing/plaf/InputMapUIResource +javax/swing/plaf/InsetsUIResource +javax/swing/plaf/LabelUI +javax/swing/plaf/ListUI +javax/swing/plaf/MenuBarUI +javax/swing/plaf/MenuItemUI +javax/swing/plaf/PanelUI +javax/swing/plaf/PopupMenuUI +javax/swing/plaf/RootPaneUI +javax/swing/plaf/ScrollBarUI +javax/swing/plaf/ScrollPaneUI +javax/swing/plaf/SeparatorUI +javax/swing/plaf/TextUI +javax/swing/plaf/ToolBarUI +javax/swing/plaf/UIResource +javax/swing/plaf/ViewportUI +javax/swing/plaf/basic/BasicBorders$ButtonBorder +javax/swing/plaf/basic/BasicBorders$MarginBorder +javax/swing/plaf/basic/BasicBorders$RadioButtonBorder +javax/swing/plaf/basic/BasicBorders$RolloverButtonBorder +javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder +javax/swing/plaf/basic/BasicButtonListener +javax/swing/plaf/basic/BasicButtonUI +javax/swing/plaf/basic/BasicComboBoxEditor +javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField +javax/swing/plaf/basic/BasicComboBoxEditor$UIResource +javax/swing/plaf/basic/BasicComboBoxUI +javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager +javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager +javax/swing/plaf/basic/BasicComboBoxUI$FocusHandler +javax/swing/plaf/basic/BasicComboBoxUI$Handler +javax/swing/plaf/basic/BasicComboPopup +javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass +javax/swing/plaf/basic/BasicComboPopup$Handler +javax/swing/plaf/basic/BasicGraphicsUtils +javax/swing/plaf/basic/BasicHTML +javax/swing/plaf/basic/BasicIconFactory +javax/swing/plaf/basic/BasicIconFactory$MenuItemArrowIcon +javax/swing/plaf/basic/BasicIconFactory$MenuItemCheckIcon +javax/swing/plaf/basic/BasicLabelUI +javax/swing/plaf/basic/BasicListUI +javax/swing/plaf/basic/BasicListUI$FocusHandler +javax/swing/plaf/basic/BasicListUI$Handler +javax/swing/plaf/basic/BasicListUI$ListTransferHandler +javax/swing/plaf/basic/BasicListUI$MouseInputHandler +javax/swing/plaf/basic/BasicListUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicLookAndFeel +javax/swing/plaf/basic/BasicLookAndFeel$1 +javax/swing/plaf/basic/BasicLookAndFeel$2 +javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper +javax/swing/plaf/basic/BasicMenuBarUI +javax/swing/plaf/basic/BasicMenuBarUI$Handler +javax/swing/plaf/basic/BasicMenuItemUI +javax/swing/plaf/basic/BasicMenuItemUI$Handler +javax/swing/plaf/basic/BasicMenuUI +javax/swing/plaf/basic/BasicMenuUI$ChangeHandler +javax/swing/plaf/basic/BasicMenuUI$Handler +javax/swing/plaf/basic/BasicMenuUI$MouseInputHandler +javax/swing/plaf/basic/BasicPanelUI +javax/swing/plaf/basic/BasicPopupMenuUI javax/swing/plaf/basic/BasicPopupMenuUI$BasicMenuKeyListener -javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber -javax/swing/MenuSelectionManager +javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper$1 -java/awt/event/FocusAdapter -javax/swing/JMenu$WinListener -java/awt/event/WindowAdapter -javax/swing/JPopupMenu$Separator -javax/swing/JSeparator -javax/swing/plaf/metal/MetalPopupMenuSeparatorUI -javax/swing/plaf/metal/MetalSeparatorUI -javax/swing/plaf/basic/BasicSeparatorUI -javax/swing/plaf/SeparatorUI -javax/swing/JComboBox -javax/swing/event/ListDataListener -javax/swing/event/CaretEvent -javax/swing/text/TabExpander -javax/swing/JScrollBar -java/awt/Adjustable -javax/swing/event/MouseInputAdapter -javax/swing/JScrollBar$ModelListener -javax/swing/DefaultBoundedRangeModel -javax/swing/BoundedRangeModel -javax/swing/plaf/metal/MetalScrollBarUI -javax/swing/plaf/basic/BasicScrollBarUI -javax/swing/plaf/ScrollBarUI -javax/swing/plaf/metal/MetalBumps -javax/swing/plaf/metal/MetalScrollButton -javax/swing/plaf/basic/BasicArrowButton -javax/swing/plaf/basic/BasicScrollBarUI$TrackListener -javax/swing/plaf/basic/BasicScrollBarUI$ArrowButtonListener -javax/swing/plaf/basic/BasicScrollBarUI$ModelListener -javax/swing/plaf/metal/MetalScrollBarUI$ScrollBarListener -javax/swing/plaf/basic/BasicScrollBarUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicScrollBarUI$Handler -javax/swing/plaf/basic/BasicScrollBarUI$ScrollListener -javax/swing/CellRendererPane -java/util/HashMap$EntryIterator -javax/swing/border/MatteBorder -sun/font/StandardGlyphVector -java/awt/font/GlyphVector -sun/font/StandardGlyphVector$GlyphStrike -sun/font/CoreMetrics -sun/font/FontLineMetrics -java/awt/font/LineMetrics -javax/swing/ComboBoxModel -javax/swing/ListModel -javax/swing/ListCellRenderer -javax/swing/DefaultComboBoxModel -javax/swing/MutableComboBoxModel -javax/swing/AbstractListModel -javax/swing/JComboBox$1 -javax/swing/AncestorNotifier -javax/swing/plaf/metal/MetalComboBoxUI -javax/swing/plaf/basic/BasicComboBoxUI -javax/swing/plaf/ComboBoxUI -javax/swing/plaf/metal/MetalComboBoxUI$MetalComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboPopup -javax/swing/plaf/basic/ComboPopup -javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass -javax/swing/border/LineBorder -javax/swing/plaf/basic/BasicComboPopup$1 -javax/swing/JList -javax/swing/DropMode -javax/swing/DefaultListSelectionModel -javax/swing/ListSelectionModel -javax/swing/plaf/basic/BasicListUI -javax/swing/plaf/ListUI -javax/swing/plaf/basic/BasicListUI$ListTransferHandler -javax/swing/TransferHandler -javax/swing/TransferHandler$TransferAction -javax/swing/DefaultListCellRenderer$UIResource -javax/swing/DefaultListCellRenderer -javax/swing/TransferHandler$SwingDropTarget -java/awt/dnd/DropTargetContext -javax/swing/TransferHandler$DropHandler -javax/swing/TransferHandler$TransferSupport -javax/swing/plaf/basic/BasicListUI$Handler -javax/swing/event/ListSelectionListener -javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag -javax/swing/plaf/basic/BasicComboPopup$Handler -javax/swing/JScrollPane -javax/swing/ScrollPaneConstants -javax/swing/ScrollPaneLayout$UIResource -javax/swing/ScrollPaneLayout -javax/swing/JViewport -javax/swing/ViewportLayout -javax/swing/plaf/basic/BasicViewportUI -javax/swing/plaf/ViewportUI -javax/swing/JScrollPane$ScrollBar -javax/swing/JViewport$ViewListener -java/awt/event/ComponentAdapter -javax/swing/plaf/metal/MetalScrollPaneUI +javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber +javax/swing/plaf/basic/BasicRootPaneUI +javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap javax/swing/plaf/basic/BasicScrollPaneUI -javax/swing/plaf/ScrollPaneUI -javax/swing/plaf/metal/MetalBorders$ScrollPaneBorder javax/swing/plaf/basic/BasicScrollPaneUI$Handler -javax/swing/plaf/metal/MetalScrollPaneUI$1 -javax/swing/plaf/basic/BasicComboBoxRenderer$UIResource -javax/swing/plaf/basic/BasicComboBoxRenderer -javax/swing/plaf/metal/MetalComboBoxEditor$UIResource -javax/swing/plaf/metal/MetalComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor -javax/swing/ComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField -javax/swing/JTextField$NotifyAction -javax/swing/text/TextAction -javax/swing/AbstractAction -javax/swing/text/JTextComponent$MutableCaretEvent -javax/swing/plaf/metal/MetalTextFieldUI +javax/swing/plaf/basic/BasicScrollPaneUI$MouseWheelHandler +javax/swing/plaf/basic/BasicSeparatorUI +javax/swing/plaf/basic/BasicTextAreaUI javax/swing/plaf/basic/BasicTextFieldUI javax/swing/plaf/basic/BasicTextUI -javax/swing/text/ViewFactory -javax/swing/plaf/TextUI javax/swing/plaf/basic/BasicTextUI$BasicCursor +javax/swing/plaf/basic/BasicTextUI$DragListener +javax/swing/plaf/basic/BasicTextUI$FocusAction +javax/swing/plaf/basic/BasicTextUI$RootView +javax/swing/plaf/basic/BasicTextUI$TextActionWrapper +javax/swing/plaf/basic/BasicTextUI$TextTransferHandler +javax/swing/plaf/basic/BasicTextUI$TextTransferHandler$TextTransferable +javax/swing/plaf/basic/BasicTextUI$UpdateHandler +javax/swing/plaf/basic/BasicToolBarSeparatorUI +javax/swing/plaf/basic/BasicToolBarUI +javax/swing/plaf/basic/BasicToolBarUI$Handler +javax/swing/plaf/basic/BasicTransferable +javax/swing/plaf/basic/BasicViewportUI +javax/swing/plaf/basic/ComboPopup +javax/swing/plaf/basic/DefaultMenuLayout +javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag +javax/swing/plaf/basic/LazyActionMap +javax/swing/plaf/metal/DefaultMetalTheme +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 +javax/swing/plaf/metal/MetalLookAndFeel +javax/swing/plaf/metal/MetalTheme +javax/swing/plaf/synth/SynthConstants +javax/swing/plaf/synth/SynthUI +javax/swing/text/AbstractDocument +javax/swing/text/AbstractDocument$1 +javax/swing/text/AbstractDocument$AbstractElement +javax/swing/text/AbstractDocument$AttributeContext +javax/swing/text/AbstractDocument$BidiElement +javax/swing/text/AbstractDocument$BidiRootElement +javax/swing/text/AbstractDocument$BranchElement +javax/swing/text/AbstractDocument$Content +javax/swing/text/AbstractDocument$DefaultDocumentEvent +javax/swing/text/AbstractDocument$ElementEdit +javax/swing/text/AbstractDocument$InsertStringResult +javax/swing/text/AbstractDocument$LeafElement +javax/swing/text/AttributeSet +javax/swing/text/AttributeSet$CharacterAttribute +javax/swing/text/AttributeSet$ColorAttribute +javax/swing/text/AttributeSet$FontAttribute +javax/swing/text/AttributeSet$ParagraphAttribute +javax/swing/text/Caret +javax/swing/text/DefaultCaret +javax/swing/text/DefaultCaret$1 +javax/swing/text/DefaultCaret$Handler javax/swing/text/DefaultEditorKit -javax/swing/text/EditorKit -javax/swing/text/DefaultEditorKit$InsertContentAction -javax/swing/text/DefaultEditorKit$DeletePrevCharAction -javax/swing/text/DefaultEditorKit$DeleteNextCharAction -javax/swing/text/DefaultEditorKit$ReadOnlyAction -javax/swing/text/DefaultEditorKit$DeleteWordAction -javax/swing/text/DefaultEditorKit$WritableAction -javax/swing/text/DefaultEditorKit$CutAction -javax/swing/text/DefaultEditorKit$CopyAction -javax/swing/text/DefaultEditorKit$PasteAction -javax/swing/text/DefaultEditorKit$VerticalPageAction -javax/swing/text/DefaultEditorKit$PageAction -javax/swing/text/DefaultEditorKit$InsertBreakAction javax/swing/text/DefaultEditorKit$BeepAction -javax/swing/text/DefaultEditorKit$NextVisualPositionAction -javax/swing/text/DefaultEditorKit$BeginWordAction -javax/swing/text/DefaultEditorKit$EndWordAction -javax/swing/text/DefaultEditorKit$PreviousWordAction -javax/swing/text/DefaultEditorKit$NextWordAction -javax/swing/text/DefaultEditorKit$BeginLineAction -javax/swing/text/DefaultEditorKit$EndLineAction -javax/swing/text/DefaultEditorKit$BeginParagraphAction -javax/swing/text/DefaultEditorKit$EndParagraphAction javax/swing/text/DefaultEditorKit$BeginAction -javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$BeginLineAction +javax/swing/text/DefaultEditorKit$BeginParagraphAction +javax/swing/text/DefaultEditorKit$BeginWordAction +javax/swing/text/DefaultEditorKit$CopyAction +javax/swing/text/DefaultEditorKit$CutAction javax/swing/text/DefaultEditorKit$DefaultKeyTypedAction +javax/swing/text/DefaultEditorKit$DeleteNextCharAction +javax/swing/text/DefaultEditorKit$DeletePrevCharAction +javax/swing/text/DefaultEditorKit$DeleteWordAction +javax/swing/text/DefaultEditorKit$DumpModelAction +javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$EndLineAction +javax/swing/text/DefaultEditorKit$EndParagraphAction +javax/swing/text/DefaultEditorKit$EndWordAction +javax/swing/text/DefaultEditorKit$InsertBreakAction +javax/swing/text/DefaultEditorKit$InsertContentAction javax/swing/text/DefaultEditorKit$InsertTabAction -javax/swing/text/DefaultEditorKit$SelectWordAction +javax/swing/text/DefaultEditorKit$NextVisualPositionAction +javax/swing/text/DefaultEditorKit$NextWordAction +javax/swing/text/DefaultEditorKit$PageAction +javax/swing/text/DefaultEditorKit$PasteAction +javax/swing/text/DefaultEditorKit$PreviousWordAction +javax/swing/text/DefaultEditorKit$ReadOnlyAction +javax/swing/text/DefaultEditorKit$SelectAllAction javax/swing/text/DefaultEditorKit$SelectLineAction javax/swing/text/DefaultEditorKit$SelectParagraphAction -javax/swing/text/DefaultEditorKit$SelectAllAction -javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$SelectWordAction javax/swing/text/DefaultEditorKit$ToggleComponentOrientationAction -javax/swing/text/DefaultEditorKit$DumpModelAction -javax/swing/plaf/basic/BasicTextUI$TextTransferHandler -javax/swing/text/Position$Bias -javax/swing/plaf/basic/BasicTextUI$RootView -javax/swing/text/View -javax/swing/plaf/basic/BasicTextUI$UpdateHandler -javax/swing/event/DocumentListener -javax/swing/plaf/basic/BasicTextUI$DragListener -javax/swing/plaf/basic/BasicComboBoxEditor$UIResource -javax/swing/plaf/basic/BasicTextUI$BasicCaret -javax/swing/text/DefaultCaret -javax/swing/text/Caret -javax/swing/text/DefaultCaret$Handler -java/awt/datatransfer/ClipboardOwner -javax/swing/plaf/basic/BasicTextUI$BasicHighlighter +javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$VerticalPageAction +javax/swing/text/DefaultEditorKit$WritableAction javax/swing/text/DefaultHighlighter -javax/swing/text/LayeredHighlighter +javax/swing/text/DefaultHighlighter$DefaultHighlightPainter +javax/swing/text/DefaultHighlighter$HighlightInfo +javax/swing/text/DefaultHighlighter$LayeredHighlightInfo +javax/swing/text/DefaultHighlighter$SafeDamager +javax/swing/text/Document +javax/swing/text/EditorKit +javax/swing/text/Element +javax/swing/text/FieldView +javax/swing/text/GapContent +javax/swing/text/GapContent$InsertUndo +javax/swing/text/GapContent$MarkData +javax/swing/text/GapContent$MarkVector +javax/swing/text/GapContent$StickyPosition +javax/swing/text/GapVector javax/swing/text/Highlighter javax/swing/text/Highlighter$Highlight -javax/swing/text/DefaultHighlighter$DefaultHighlightPainter -javax/swing/text/LayeredHighlighter$LayerPainter javax/swing/text/Highlighter$HighlightPainter -javax/swing/text/DefaultHighlighter$SafeDamager -javax/swing/text/FieldView -javax/swing/text/PlainView +javax/swing/text/JTextComponent +javax/swing/text/JTextComponent$1 javax/swing/text/JTextComponent$DefaultKeymap -javax/swing/text/Keymap -javax/swing/text/JTextComponent$KeymapWrapper javax/swing/text/JTextComponent$KeymapActionMap -javax/swing/plaf/basic/BasicTextUI$FocusAction -javax/swing/plaf/basic/BasicTextUI$TextActionWrapper -javax/swing/JTextArea -javax/swing/JEditorPane -javax/swing/JTextField$ScrollRepainter -javax/swing/plaf/metal/MetalComboBoxEditor$1 -javax/swing/plaf/metal/MetalComboBoxEditor$EditorBorder -javax/swing/plaf/metal/MetalComboBoxUI$MetalPropertyChangeListener -javax/swing/plaf/basic/BasicComboBoxUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicComboBoxUI$Handler -javax/swing/plaf/metal/MetalComboBoxButton -javax/swing/plaf/metal/MetalComboBoxIcon -javax/swing/plaf/metal/MetalComboBoxButton$1 -javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager -javax/swing/JComboBox$KeySelectionManager -javax/swing/JToolBar$DefaultToolBarLayout -javax/swing/plaf/metal/MetalToolBarUI -javax/swing/plaf/basic/BasicToolBarUI -javax/swing/plaf/ToolBarUI -javax/swing/plaf/metal/MetalBorders$ToolBarBorder -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue$1 -javax/swing/plaf/metal/MetalBorders$RolloverButtonBorder -javax/swing/plaf/metal/MetalBorders$RolloverMarginBorder -javax/swing/plaf/basic/BasicBorders$RadioButtonBorder -javax/swing/plaf/basic/BasicBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder -javax/swing/plaf/metal/MetalToolBarUI$MetalDockingListener -javax/swing/plaf/basic/BasicToolBarUI$DockingListener -javax/swing/plaf/basic/BasicToolBarUI$Handler -javax/swing/border/EtchedBorder -javax/swing/JToolBar$Separator -javax/swing/plaf/basic/BasicToolBarSeparatorUI -sun/awt/color/CMM -java/applet/Applet -java/awt/Panel -com/sun/awt/AWTUtilities -javax/swing/KeyboardManager$ComponentKeyStrokePair -sun/awt/EmbeddedFrame -sun/awt/im/InputMethodContext -java/awt/im/spi/InputMethodContext -sun/awt/im/InputContext -sun/awt/im/InputMethodManager -sun/awt/im/ExecutableInputMethodManager -sun/awt/X11/XInputMethodDescriptor -sun/awt/X11InputMethodDescriptor -java/awt/im/spi/InputMethodDescriptor -sun/awt/im/InputMethodLocator -sun/awt/im/ExecutableInputMethodManager$2 -sun/misc/Service -sun/misc/Service$LazyIterator -java/util/TreeSet -java/util/NavigableSet -java/util/SortedSet -javax/swing/SizeRequirements -javax/swing/plaf/basic/BasicGraphicsUtils -java/awt/event/AdjustmentEvent -java/awt/MenuBar -sun/awt/X11/XComponentPeer$2 -java/awt/SequencedEvent -java/beans/PropertyVetoException -java/awt/DefaultKeyboardFocusManager$TypeAheadMarker -java/awt/KeyboardFocusManager$HeavyweightFocusRequest -java/awt/KeyboardFocusManager$LightweightFocusRequest -sun/awt/KeyboardFocusManagerPeerImpl -sun/awt/SunToolkit$7 -java/awt/Window$1DisposeAction -java/awt/LightweightDispatcher$2 -sun/awt/X11/XReparentEvent -sun/awt/X11/XWindowAttributes -javax/swing/SystemEventQueueUtilities$ComponentWorkRequest -sun/awt/X11/XFocusChangeEvent -sun/awt/X11/XComponentPeer$1 -sun/awt/X11/XUnmapEvent -java/io/StringWriter -javax/swing/JWindow -java/io/UnsupportedEncodingException -java/net/UnknownHostException -java/nio/channels/SocketChannel -java/nio/channels/spi/AbstractSelectableChannel -java/nio/channels/SelectableChannel -java/net/SocketImplFactory -javax/swing/UnsupportedLookAndFeelException -java/lang/UnsatisfiedLinkError -javax/swing/Box$Filler -javax/swing/JComponent$2 -sun/net/www/MimeTable -java/net/FileNameMap -sun/net/www/MimeTable$1 -sun/net/www/MimeTable$2 -sun/net/www/MimeEntry -java/net/URLConnection$1 -java/text/SimpleDateFormat -java/text/DateFormat -java/text/DateFormat$Field -java/util/Calendar -java/util/GregorianCalendar -sun/util/resources/CalendarData -sun/util/resources/CalendarData_en -java/text/DateFormatSymbols -java/text/spi/DateFormatSymbolsProvider -java/text/DontCareFieldPosition -java/text/DontCareFieldPosition$1 -java/text/Format$FieldDelegate -javax/swing/plaf/BorderUIResource -javax/swing/BorderFactory -javax/swing/border/BevelBorder -javax/swing/plaf/metal/MetalIconFactory$TreeFolderIcon -javax/swing/plaf/metal/MetalIconFactory$FolderIcon16 -java/util/zip/ZipInputStream -java/io/PushbackInputStream -java/util/zip/CRC32 -java/util/zip/Checksum -java/lang/Thread$State -javax/swing/SwingUtilities$SharedOwnerFrame -javax/swing/JTable -javax/swing/event/TableModelListener -javax/swing/event/TableColumnModelListener -javax/swing/event/CellEditorListener -javax/swing/event/RowSorterListener -javax/swing/BufferStrategyPaintManager$BufferInfo -java/awt/Component$BltSubRegionBufferStrategy -sun/awt/SubRegionShowable -java/awt/Component$BltBufferStrategy -sun/awt/image/SunVolatileImage -sun/awt/image/BufferedImageGraphicsConfig -sun/print/PrinterGraphicsConfig -sun/java2d/x11/X11VolatileSurfaceManager -sun/awt/image/VolatileSurfaceManager -java/awt/print/PrinterGraphics -java/awt/PrintGraphics -java/awt/GraphicsCallback$PaintCallback -java/awt/GraphicsCallback -sun/awt/SunGraphicsCallback -javax/swing/JRadioButton -java/lang/ClassFormatError -javax/swing/JTabbedPane -javax/swing/JTabbedPane$ModelListener -javax/swing/plaf/metal/MetalTabbedPaneUI -javax/swing/plaf/basic/BasicTabbedPaneUI -javax/swing/plaf/TabbedPaneUI -javax/swing/plaf/metal/MetalTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneScrollLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$Handler -sun/swing/ImageIconUIResource -javax/swing/GrayFilter -java/awt/image/RGBImageFilter -java/awt/image/ImageFilter -java/awt/image/FilteredImageSource -org/w3c/dom/Node -org/xml/sax/SAXException -javax/xml/parsers/ParserConfigurationException -org/xml/sax/EntityResolver -java/security/NoSuchAlgorithmException -java/security/GeneralSecurityException -java/util/zip/GZIPInputStream -java/util/zip/DeflaterOutputStream -org/xml/sax/InputSource -javax/xml/parsers/DocumentBuilderFactory -javax/xml/parsers/FactoryFinder -javax/xml/parsers/SecuritySupport -javax/xml/parsers/SecuritySupport$2 -javax/xml/parsers/SecuritySupport$5 -javax/xml/parsers/SecuritySupport$1 -javax/xml/parsers/SecuritySupport$4 -javax/xml/parsers/DocumentBuilder -org/w3c/dom/Document -org/xml/sax/helpers/DefaultHandler -org/xml/sax/DTDHandler -org/xml/sax/ContentHandler -org/xml/sax/ErrorHandler -org/xml/sax/SAXNotSupportedException -org/xml/sax/Locator -org/xml/sax/SAXNotRecognizedException -org/xml/sax/SAXParseException -org/w3c/dom/NodeList -org/w3c/dom/events/EventTarget -org/w3c/dom/traversal/DocumentTraversal -org/w3c/dom/events/DocumentEvent -org/w3c/dom/ranges/DocumentRange -org/w3c/dom/Entity -org/w3c/dom/Element -org/w3c/dom/CharacterData -org/w3c/dom/CDATASection -org/w3c/dom/Text -org/xml/sax/AttributeList -org/w3c/dom/DOMException -org/w3c/dom/Notation -org/w3c/dom/DocumentType -org/w3c/dom/Attr -org/w3c/dom/EntityReference -org/w3c/dom/ProcessingInstruction -org/w3c/dom/Comment -org/w3c/dom/DocumentFragment -org/w3c/dom/events/Event -org/w3c/dom/events/MutationEvent -org/w3c/dom/traversal/TreeWalker -org/w3c/dom/ranges/Range -org/w3c/dom/traversal/NodeIterator -org/w3c/dom/events/EventException -org/w3c/dom/NamedNodeMap -java/lang/StringIndexOutOfBoundsException -java/awt/GridLayout -javax/swing/plaf/metal/MetalRadioButtonUI -javax/swing/plaf/basic/BasicRadioButtonUI -javax/swing/plaf/basic/BasicBorders -javax/swing/plaf/metal/MetalIconFactory$RadioButtonIcon -java/awt/event/ItemEvent -java/awt/CardLayout$Card -javax/swing/JCheckBox -javax/swing/event/ListSelectionEvent -javax/swing/plaf/metal/MetalCheckBoxUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxIcon -java/lang/ExceptionInInitializerError -com/sun/java/swing/plaf/windows/WindowsTabbedPaneUI -javax/swing/JProgressBar -javax/swing/JProgressBar$ModelListener -javax/swing/plaf/metal/MetalProgressBarUI -javax/swing/plaf/basic/BasicProgressBarUI -javax/swing/plaf/ProgressBarUI -javax/swing/plaf/BorderUIResource$LineBorderUIResource -javax/swing/plaf/basic/BasicProgressBarUI$Handler -javax/swing/tree/TreeModel -javax/swing/table/TableCellRenderer -javax/swing/table/JTableHeader -javax/swing/event/TreeExpansionListener -javax/swing/table/AbstractTableModel -javax/swing/table/TableModel -javax/swing/table/DefaultTableCellRenderer -javax/swing/JTree -javax/swing/tree/TreeSelectionModel -javax/swing/tree/DefaultTreeCellRenderer -javax/swing/tree/TreeCellRenderer -javax/swing/table/TableCellEditor -javax/swing/CellEditor -javax/swing/JToolTip -javax/swing/table/TableColumn -javax/swing/table/DefaultTableColumnModel -javax/swing/table/TableColumnModel -javax/swing/table/DefaultTableModel -javax/swing/event/TableModelEvent -sun/swing/table/DefaultTableCellHeaderRenderer -javax/swing/plaf/basic/BasicTableHeaderUI -javax/swing/plaf/TableHeaderUI -javax/swing/plaf/basic/BasicTableHeaderUI$1 -javax/swing/plaf/basic/BasicTableHeaderUI$MouseInputHandler -javax/swing/DefaultCellEditor -javax/swing/tree/TreeCellEditor -javax/swing/AbstractCellEditor -javax/swing/plaf/basic/BasicTableUI -javax/swing/plaf/TableUI -javax/swing/plaf/basic/BasicTableUI$TableTransferHandler -javax/swing/plaf/basic/BasicTableUI$Handler -javax/swing/tree/DefaultTreeSelectionModel -javax/swing/tree/TreePath -javax/swing/plaf/metal/MetalTreeUI -javax/swing/plaf/basic/BasicTreeUI -javax/swing/plaf/TreeUI -javax/swing/plaf/basic/BasicTreeUI$Actions -javax/swing/plaf/basic/BasicTreeUI$TreeTransferHandler -javax/swing/plaf/metal/MetalTreeUI$LineListener -javax/swing/plaf/basic/BasicTreeUI$Handler -javax/swing/event/TreeModelListener -javax/swing/event/TreeSelectionListener -javax/swing/event/SwingPropertyChangeSupport -javax/swing/tree/VariableHeightLayoutCache -javax/swing/tree/AbstractLayoutCache -javax/swing/tree/RowMapper -javax/swing/plaf/basic/BasicTreeUI$NodeDimensionsHandler -javax/swing/tree/AbstractLayoutCache$NodeDimensions -javax/swing/JTree$TreeModelHandler -javax/swing/tree/VariableHeightLayoutCache$TreeStateNode -javax/swing/tree/DefaultMutableTreeNode -javax/swing/tree/MutableTreeNode -javax/swing/tree/DefaultMutableTreeNode$1 -javax/swing/tree/DefaultMutableTreeNode$PreorderEnumeration -javax/swing/event/TableColumnModelEvent -java/text/ParseException -java/text/NumberFormat$Field -javax/swing/event/UndoableEditListener -javax/swing/filechooser/FileFilter -javax/swing/tree/DefaultTreeModel -javax/swing/tree/DefaultTreeCellEditor -javax/swing/tree/DefaultTreeCellEditor$1 -javax/swing/tree/DefaultTreeCellEditor$DefaultTextField -javax/swing/DefaultCellEditor$1 -javax/swing/DefaultCellEditor$EditorDelegate -javax/swing/tree/DefaultTreeCellEditor$EditorContainer -javax/swing/JTree$TreeSelectionRedirector -javax/swing/event/TreeModelEvent -javax/swing/plaf/metal/MetalSplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneUI -javax/swing/plaf/SplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneDivider -javax/swing/plaf/basic/BasicBorders$SplitPaneBorder -javax/swing/plaf/metal/MetalSplitPaneDivider -javax/swing/plaf/basic/BasicSplitPaneDivider$DividerLayout -javax/swing/plaf/basic/BasicSplitPaneDivider$MouseHandler -javax/swing/plaf/basic/BasicBorders$SplitPaneDividerBorder -javax/swing/plaf/basic/BasicSplitPaneUI$BasicHorizontalLayoutManager -javax/swing/plaf/basic/BasicSplitPaneUI$1 -javax/swing/plaf/basic/BasicSplitPaneUI$Handler -javax/swing/plaf/metal/MetalSplitPaneDivider$1 -javax/swing/plaf/basic/BasicSplitPaneDivider$OneTouchActionHandler -javax/swing/plaf/metal/MetalSplitPaneDivider$2 -javax/swing/border/TitledBorder -javax/swing/plaf/basic/BasicTextAreaUI -java/util/Collections$UnmodifiableCollection$1 -java/io/InterruptedIOException -java/net/NoRouteToHostException -java/net/BindException -javax/swing/tree/PathPlaceHolder -javax/swing/event/TreeSelectionEvent -javax/swing/JList$3 -javax/swing/JList$ListSelectionHandler -javax/swing/JSlider -javax/swing/JSlider$ModelListener -javax/swing/plaf/metal/MetalSliderUI -javax/swing/plaf/basic/BasicSliderUI -javax/swing/plaf/SliderUI -javax/swing/plaf/basic/BasicSliderUI$Actions -javax/swing/plaf/metal/MetalIconFactory$HorizontalSliderThumbIcon -javax/swing/plaf/metal/MetalIconFactory$VerticalSliderThumbIcon -javax/swing/plaf/basic/BasicSliderUI$TrackListener -javax/swing/plaf/basic/BasicSliderUI$Handler -javax/swing/plaf/basic/BasicSliderUI$ScrollListener -javax/swing/plaf/metal/MetalSliderUI$MetalPropertyListener -javax/swing/plaf/basic/BasicSliderUI$PropertyChangeHandler -sun/java2d/HeadlessGraphicsEnvironment -java/util/Hashtable$KeySet -java/awt/FontFormatException -sun/java2d/SunGraphicsEnvironment$2 -sun/font/Type1Font$1 -java/nio/channels/FileChannel$MapMode -sun/nio/ch/FileChannelImpl$Unmapper -sun/nio/ch/Util$3 -java/nio/DirectByteBufferR -java/nio/charset/Charset$3 -sun/nio/cs/ext/ExtendedCharsets -sun/nio/cs/AbstractCharsetProvider -sun/nio/cs/ext/SJIS -sun/nio/cs/ext/SJIS$Decoder -sun/nio/cs/ext/DelegatableDecoder -sun/nio/cs/ext/JIS_X_0208_Decoder -sun/nio/cs/ext/DoubleByteDecoder -sun/nio/cs/ext/JIS_X_0201$Decoder -sun/nio/cs/SingleByteDecoder -java/lang/CharacterData00 -javax/swing/DefaultListModel -javax/swing/event/ListDataEvent -javax/sound/sampled/DataLine -javax/sound/sampled/Line -javax/sound/sampled/Line$Info -javax/sound/sampled/DataLine$Info -javax/sound/sampled/Control$Type -javax/sound/sampled/FloatControl$Type -javax/sound/sampled/LineUnavailableException -javax/sound/sampled/UnsupportedAudioFileException -javax/swing/JRadioButtonMenuItem -javax/swing/JMenuItem$AccessibleJMenuItem -javax/swing/AbstractButton$AccessibleAbstractButton -javax/accessibility/AccessibleAction -javax/accessibility/AccessibleValue -javax/accessibility/AccessibleText -javax/accessibility/AccessibleExtendedComponent -javax/accessibility/AccessibleComponent -javax/swing/JComponent$AccessibleJComponent -java/awt/Container$AccessibleAWTContainer -java/awt/Component$AccessibleAWTComponent -javax/accessibility/AccessibleRelationSet -javax/accessibility/AccessibleState -javax/accessibility/AccessibleBundle -javax/swing/plaf/basic/BasicCheckBoxMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxMenuItemIcon -javax/swing/JCheckBoxMenuItem$AccessibleJCheckBoxMenuItem -javax/swing/plaf/basic/BasicRadioButtonMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$RadioButtonMenuItemIcon -sun/awt/image/ImageDecoder$1 -javax/swing/JTabbedPane$Page -java/net/DatagramSocket -java/net/MulticastSocket -java/net/DatagramPacket -sun/net/InetAddressCachePolicy -sun/net/InetAddressCachePolicy$1 -sun/net/InetAddressCachePolicy$2 -java/net/InetAddress$CacheEntry -java/net/PlainDatagramSocketImpl -java/net/DatagramSocketImpl -java/net/NetworkInterface -java/net/InterfaceAddress -java/text/Collator -java/text/spi/CollatorProvider -sun/text/resources/CollationData -sun/text/resources/CollationData_en -sun/util/EmptyListResourceBundle -java/text/RuleBasedCollator -java/text/CollationRules -java/text/RBCollationTables -java/text/RBTableBuilder -java/text/RBCollationTables$BuildAPI -sun/text/IntHashtable -sun/text/UCompactIntArray -sun/text/normalizer/NormalizerImpl -sun/text/normalizer/ICUData -sun/text/normalizer/NormalizerDataReader -sun/text/normalizer/ICUBinary$Authenticate -sun/text/normalizer/ICUBinary -sun/text/normalizer/NormalizerImpl$FCDTrieImpl -sun/text/normalizer/Trie$DataManipulate -sun/text/normalizer/NormalizerImpl$NormTrieImpl -sun/text/normalizer/NormalizerImpl$AuxTrieImpl -sun/text/normalizer/IntTrie -sun/text/normalizer/Trie -sun/text/normalizer/CharTrie -sun/text/normalizer/CharTrie$FriendAgent -sun/text/normalizer/UnicodeSet -sun/text/normalizer/UnicodeMatcher -sun/text/normalizer/NormalizerImpl$DecomposeArgs -java/text/MergeCollation -java/text/PatternEntry$Parser -java/text/PatternEntry -java/text/EntryPair -sun/text/ComposedCharIter -sun/text/normalizer/UTF16 -sun/net/www/protocol/http/Handler -java/io/ObjectInputStream$BlockDataInputStream -java/io/ObjectInputStream$PeekInputStream -java/io/ObjectInputStream$HandleTable -java/io/ObjectInputStream$ValidationList -java/io/Bits -java/io/ObjectStreamClass$Caches -java/io/ObjectStreamClass$WeakClassKey -java/io/ObjectStreamClass$EntryFuture -java/io/ObjectStreamClass$2 -sun/reflect/SerializationConstructorAccessorImpl -java/io/ObjectStreamClass$FieldReflectorKey -java/io/ObjectStreamClass$FieldReflector -java/io/ObjectStreamClass$1 -java/io/DataOutputStream -java/io/ObjectStreamClass$MemberSignature -java/io/ObjectStreamClass$3 -java/io/ObjectStreamClass$4 -java/io/ObjectStreamClass$5 -java/security/MessageDigest -java/security/MessageDigestSpi -sun/security/jca/GetInstance -sun/security/jca/Providers -sun/security/jca/ProviderList -sun/security/jca/ProviderConfig -sun/security/jca/ProviderList$3 -sun/security/jca/ProviderList$1 -sun/security/jca/ProviderList$2 -sun/security/jca/ProviderConfig$1 -sun/security/jca/ProviderConfig$3 -java/security/Provider$Service -java/security/Provider$UString -sun/security/provider/SHA -sun/security/provider/DigestBase -sun/security/jca/GetInstance$Instance -java/security/MessageDigest$Delegate -sun/security/provider/ByteArrayAccess -java/io/ObjectStreamClass$ClassDataSlot -java/io/ObjectInputStream$CallbackContext -sun/reflect/UnsafeQualifiedStaticLongFieldAccessorImpl -java/security/SignatureException -java/security/InvalidKeyException -java/security/KeyException -java/security/Signature -java/security/SignatureSpi -java/io/ObjectOutputStream$BlockDataOutputStream -sun/security/provider/DSAPublicKey -java/security/interfaces/DSAPublicKey -java/security/interfaces/DSAKey -java/security/PublicKey -java/security/Key -sun/security/x509/X509Key -java/io/ObjectOutputStream$HandleTable -java/io/ObjectOutputStream$ReplaceTable -sun/security/x509/AlgorithmId -sun/security/util/DerEncoder -sun/security/util/BitArray -sun/security/util/DerOutputStream -sun/security/util/DerValue -java/math/BigInteger -java/security/interfaces/DSAParams -sun/security/util/DerInputStream -sun/security/util/DerInputBuffer -sun/security/util/ObjectIdentifier -java/security/AlgorithmParameters -java/security/AlgorithmParametersSpi -sun/security/provider/DSAParameters -sun/security/util/ByteArrayLexOrder -sun/security/util/ByteArrayTagOrder -sun/security/util/DerIndefLenConverter -java/io/InvalidClassException -java/io/ObjectStreamException -java/io/ObjectInputStream$GetFieldImpl -java/io/ObjectInputStream$GetField -sun/security/jca/ServiceId -sun/security/jca/ProviderList$ServiceList -sun/security/jca/ProviderList$ServiceList$1 -java/security/Signature$Delegate -java/security/interfaces/DSAPrivateKey -java/security/PrivateKey -sun/security/provider/DSA$SHA1withDSA -sun/security/provider/DSA -java/security/spec/DSAParameterSpec -java/security/spec/AlgorithmParameterSpec -java/math/MutableBigInteger -java/math/SignedMutableBigInteger -java/awt/EventQueue$1AWTInvocationLock -javax/swing/SystemEventQueueUtilities$RunnableCanvas -javax/swing/SystemEventQueueUtilities$RunnableCanvasGraphics -java/awt/Component$FlipBufferStrategy -java/awt/SentEvent -sun/awt/X11/XDestroyWindowEvent -sun/awt/X11/XDropTargetRegistry -sun/awt/X11/XEmbeddedFramePeer -sun/awt/X11/XDragAndDropProtocols -sun/awt/X11/XDropTargetContextPeer -sun/awt/dnd/SunDropTargetContextPeer -java/awt/dnd/peer/DropTargetContextPeer -sun/awt/X11/XDropTargetContextPeer$XDropTargetProtocolListenerImpl -sun/awt/X11/XDropTargetProtocolListener -sun/awt/X11/XDnDDragSourceProtocol -sun/awt/X11/XDragSourceProtocol -sun/awt/X11/MotifDnDDragSourceProtocol -sun/awt/X11/XDnDDropTargetProtocol -sun/awt/X11/XDropTargetProtocol -sun/awt/X11/MotifDnDDropTargetProtocol -sun/awt/X11/XDnDConstants -sun/awt/X11/MotifDnDConstants -javax/swing/JTable$2 -javax/swing/JTable$Resizable3 -javax/swing/JTable$Resizable2 -javax/swing/JTable$5 -javax/swing/event/AncestorEvent -sun/font/FontDesignMetrics$MetricsKey -java/awt/geom/Line2D$Float -java/awt/geom/Line2D -com/sun/java/swing/plaf/gtk/GTKLookAndFeel -javax/swing/plaf/synth/SynthLookAndFeel -javax/swing/plaf/synth/DefaultSynthStyleFactory -javax/swing/plaf/synth/SynthStyleFactory -sun/swing/BakedArrayList -javax/swing/plaf/synth/SynthLookAndFeel$Handler -javax/swing/plaf/synth/SynthDefaultLookup -com/sun/java/swing/plaf/gtk/GTKEngine -com/sun/java/swing/plaf/gtk/GTKDefaultEngine -com/sun/java/swing/plaf/gtk/GTKEngine$Settings -com/sun/java/swing/plaf/gtk/GTKStyleFactory -com/sun/java/swing/plaf/gtk/PangoFonts -sun/font/FontManager$FontConfigInfo -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$WeakPCL -javax/swing/plaf/synth/Region -javax/swing/plaf/synth/SynthLookAndFeel$AATextListener -com/sun/java/swing/plaf/gtk/GTKNativeEngine -com/sun/java/swing/plaf/gtk/GTKNativeEngine$WidgetType -com/sun/java/swing/plaf/gtk/GTKRegion -com/sun/java/swing/plaf/gtk/GTKDefaultStyle -com/sun/java/swing/plaf/gtk/GTKStyle -com/sun/java/swing/plaf/gtk/GTKConstants -javax/swing/plaf/synth/SynthStyle -javax/swing/plaf/synth/SynthGraphicsUtils -com/sun/java/swing/plaf/gtk/GTKGraphicsUtils -com/sun/java/swing/plaf/gtk/GTKStyle$GTKStockIcon -sun/swing/plaf/synth/SynthIcon -com/sun/java/swing/plaf/gtk/GTKColorType -javax/swing/plaf/synth/ColorType -com/sun/java/swing/plaf/gtk/resources/gtk -com/sun/swing/internal/plaf/synth/resources/synth -com/sun/java/swing/plaf/gtk/GTKStyle$GTKLazyValue -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$1FontLazyValue -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$2 -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$3 -javax/swing/plaf/synth/SynthPanelUI -javax/swing/plaf/synth/SynthConstants -javax/swing/plaf/synth/SynthContext -javax/swing/plaf/synth/SynthBorder -javax/swing/plaf/synth/SynthRootPaneUI -javax/swing/plaf/synth/SynthLabelUI -javax/swing/plaf/synth/SynthButtonUI -javax/swing/plaf/synth/SynthToggleButtonUI -javax/swing/plaf/basic/BasicBorders$FieldBorder -javax/swing/plaf/synth/SynthMenuBarUI -javax/swing/plaf/synth/DefaultMenuLayout -javax/swing/plaf/synth/SynthMenuUI -javax/swing/plaf/synth/SynthUI -com/sun/java/swing/plaf/gtk/GTKIconFactory -com/sun/java/swing/plaf/gtk/GTKIconFactory$MenuArrowIcon -com/sun/java/swing/plaf/gtk/GTKIconFactory$DelegatingIcon -com/sun/java/swing/plaf/gtk/GTKConstants$ArrowType -javax/swing/plaf/basic/BasicIconFactory -javax/swing/plaf/basic/BasicIconFactory$MenuItemCheckIcon -javax/swing/plaf/synth/SynthMenuItemUI -javax/swing/plaf/synth/SynthPopupMenuUI -javax/swing/plaf/synth/SynthSeparatorUI -javax/swing/plaf/synth/SynthScrollBarUI -javax/swing/plaf/synth/SynthArrowButton -javax/swing/plaf/synth/SynthArrowButton$SynthArrowButtonUI -javax/swing/plaf/synth/SynthComboBoxUI -javax/swing/plaf/synth/SynthComboPopup -javax/swing/plaf/synth/SynthListUI -javax/swing/plaf/synth/SynthListUI$SynthListCellRenderer -javax/swing/plaf/synth/SynthViewportUI -javax/swing/plaf/synth/SynthScrollPaneUI -javax/swing/plaf/synth/SynthScrollPaneUI$ViewportBorder -javax/swing/plaf/synth/SynthComboBoxUI$SynthComboBoxRenderer -javax/swing/plaf/synth/SynthComboBoxUI$SynthComboBoxEditor -javax/swing/plaf/synth/SynthTextFieldUI -javax/swing/plaf/synth/SynthToolBarUI -javax/swing/plaf/synth/SynthToolBarUI$SynthToolBarLayoutManager -com/sun/java/swing/plaf/gtk/GTKIconFactory$ToolBarHandleIcon -com/sun/java/swing/plaf/gtk/GTKConstants$Orientation -sun/awt/X11/XTranslateCoordinates -com/sun/java/swing/plaf/gtk/GTKPainter -javax/swing/plaf/synth/SynthPainter -javax/swing/plaf/synth/SynthPainter$1 -com/sun/java/swing/plaf/gtk/GTKConstants$PositionType -com/sun/java/swing/plaf/gtk/GTKConstants$ShadowType -java/io/ObjectInputStream$HandleTable$HandleList -sun/java2d/pipe/ShapeSpanIterator -sun/java2d/pipe/SpanIterator -sun/dc/path/PathConsumer -sun/dc/pr/PathStroker -sun/dc/pr/PathDasher -java/awt/geom/LineIterator -java/awt/geom/PathIterator -sun/applet/Main -sun/applet/AppletMessageHandler -sun/applet/resources/MsgAppletViewer -sun/applet/AppletSecurity -sun/awt/AWTSecurityManager -java/lang/SecurityManager -java/security/DomainCombiner -sun/applet/AppletSecurity$1 -java/lang/SecurityManager$1 -java/security/SecurityPermission -java/util/PropertyPermission -sun/applet/AppletViewer -java/applet/AppletContext -java/awt/print/Printable -sun/security/util/SecurityConstants -java/awt/AWTPermission -java/net/NetPermission -java/net/SocketPermission -javax/security/auth/AuthPermission -java/lang/Thread$1 -java/util/logging/LogManager$5 -java/util/logging/LogManager$6 -sun/applet/StdAppletViewerFactory -sun/applet/AppletViewerFactory -sun/applet/AppletViewer$UserActionListener -sun/applet/AppletViewerPanel -sun/applet/AppletPanel -java/applet/AppletStub -sun/misc/MessageUtils -sun/applet/AppletPanel$10 -java/security/Policy$1 -sun/security/provider/PolicyFile$1 -sun/security/provider/PolicyInfo -sun/security/provider/PolicyFile$3 -sun/security/util/PropertyExpander -sun/security/provider/PolicyParser -sun/security/util/PolicyUtil -sun/security/provider/PolicyParser$GrantEntry -sun/security/provider/PolicyParser$PermissionEntry -sun/security/provider/PolicyFile$PolicyEntry -sun/security/provider/PolicyFile$6 -sun/security/provider/PolicyFile$7 -sun/security/provider/SelfPermission -java/net/SocketPermissionCollection -java/util/PropertyPermissionCollection -sun/applet/AppletPanel$9 -sun/applet/AppletClassLoader -sun/applet/AppletClassLoader$4 -sun/applet/AppletThreadGroup -sun/applet/AppContextCreator -sun/applet/AppletPanel$1 -sun/awt/X11/XMenuBarPeer -java/awt/peer/MenuBarPeer -java/awt/peer/MenuComponentPeer -sun/awt/X11/XBaseMenuWindow -sun/awt/X11/XMenuPeer -java/awt/peer/MenuPeer -java/awt/peer/MenuItemPeer -sun/awt/X11/XMenuItemPeer -java/awt/MenuShortcut -sun/awt/X11/XMenuWindow -sun/awt/X11/XMenuBarPeer$1 -sun/awt/X11/XMenuItemPeer$TextMetrics +javax/swing/text/JTextComponent$KeymapWrapper +javax/swing/text/JTextComponent$MutableCaretEvent +javax/swing/text/Keymap +javax/swing/text/LayeredHighlighter +javax/swing/text/LayeredHighlighter$LayerPainter +javax/swing/text/MutableAttributeSet +javax/swing/text/PlainDocument +javax/swing/text/PlainView +javax/swing/text/Position +javax/swing/text/Position$Bias +javax/swing/text/Segment +javax/swing/text/SegmentCache +javax/swing/text/SegmentCache$CachedSegment +javax/swing/text/SimpleAttributeSet +javax/swing/text/SimpleAttributeSet$EmptyAttributeSet +javax/swing/text/Style +javax/swing/text/StyleConstants +javax/swing/text/StyleConstants$CharacterConstants +javax/swing/text/StyleConstants$ColorConstants +javax/swing/text/StyleConstants$FontConstants +javax/swing/text/StyleConstants$ParagraphConstants +javax/swing/text/StyleContext +javax/swing/text/StyleContext$FontKey +javax/swing/text/StyleContext$KeyEnumeration +javax/swing/text/StyleContext$NamedStyle +javax/swing/text/StyleContext$SmallAttributeSet +javax/swing/text/TabExpander +javax/swing/text/TextAction +javax/swing/text/Utilities +javax/swing/text/View +javax/swing/text/ViewFactory +javax/swing/tree/TreeNode +javax/swing/undo/AbstractUndoableEdit +javax/swing/undo/CompoundEdit +javax/swing/undo/UndoableEdit +sun/awt/AWTAccessor +sun/awt/AWTAccessor$AWTEventAccessor +sun/awt/AWTAccessor$ClientPropertyKeyAccessor +sun/awt/AWTAccessor$ComponentAccessor +sun/awt/AWTAccessor$ContainerAccessor +sun/awt/AWTAccessor$CursorAccessor +sun/awt/AWTAccessor$DefaultKeyboardFocusManagerAccessor +sun/awt/AWTAccessor$EventQueueAccessor +sun/awt/AWTAccessor$FrameAccessor +sun/awt/AWTAccessor$InputEventAccessor +sun/awt/AWTAccessor$KeyEventAccessor +sun/awt/AWTAccessor$KeyboardFocusManagerAccessor +sun/awt/AWTAccessor$ToolkitAccessor +sun/awt/AWTAccessor$WindowAccessor +sun/awt/AWTAutoShutdown +sun/awt/AppContext +sun/awt/AppContext$1 +sun/awt/AppContext$2 sun/awt/AppContext$3 -sun/awt/MostRecentThreadAppContext -sun/awt/X11/XMenuBarPeer$MappingData -sun/awt/X11/XBaseMenuWindow$MappingData -sun/applet/AppletViewer$1 -sun/applet/AppletViewer$1AppletEventListener -sun/applet/AppletListener -sun/applet/AppletEventMulticaster -sun/misc/Queue -sun/misc/QueueElement -sun/applet/AppletEvent -sun/applet/AppletClassLoader$1 -sun/awt/X11/XBaseMenuWindow$3 -java/awt/DefaultKeyboardFocusManager$DefaultKeyboardFocusManagerSentEvent +sun/awt/AppContext$6 +sun/awt/AppContext$State +sun/awt/CGraphicsConfig +sun/awt/CGraphicsDevice +sun/awt/CGraphicsEnvironment +sun/awt/CGraphicsEnvironment$1 +sun/awt/CGraphicsEnvironment$2 sun/awt/CausedFocusEvent -sun/awt/X11/XWindow$1 -java/net/URLClassLoader$4 -sun/applet/AppletClassLoader$2 -javax/swing/JApplet -java/lang/ClassLoader$1 -sun/security/provider/PolicyFile$5 -java/security/PermissionsEnumerator -java/util/Collections$1 -sun/applet/AppletPanel$11 -sun/applet/AppletPanel$8 -sun/applet/AppletPanel$2 -sun/applet/AppletPanel$3 -sun/applet/AppletPanel$6 -javax/swing/BufferStrategyPaintManager$1 -# f3ac8b467e7f8c49 +sun/awt/CausedFocusEvent$Cause +sun/awt/ComponentFactory +sun/awt/ConstrainableGraphics +sun/awt/DisplayChangedListener +sun/awt/EmbeddedFrame +sun/awt/EventQueueDelegate +sun/awt/EventQueueItem +sun/awt/FontConfiguration +sun/awt/FontDescriptor +sun/awt/FullScreenCapable +sun/awt/HeadlessToolkit +sun/awt/InputMethodSupport +sun/awt/KeyboardFocusManagerPeerImpl +sun/awt/KeyboardFocusManagerPeerProvider +sun/awt/LightweightFrame +sun/awt/ModalExclude +sun/awt/ModalityEvent +sun/awt/ModalityListener +sun/awt/MostRecentKeyValue +sun/awt/Mutex +sun/awt/NullComponentPeer +sun/awt/OSInfo +sun/awt/OSInfo$1 +sun/awt/OSInfo$OSType +sun/awt/OSInfo$WindowsVersion +sun/awt/PaintEventDispatcher +sun/awt/PeerEvent +sun/awt/PostEventQueue +sun/awt/RepaintArea +sun/awt/RequestFocusController +sun/awt/SunDisplayChanger +sun/awt/SunGraphicsCallback +sun/awt/SunHints +sun/awt/SunHints$Key +sun/awt/SunHints$LCDContrastKey +sun/awt/SunHints$Value +sun/awt/SunToolkit +sun/awt/SunToolkit$1 +sun/awt/SunToolkit$ModalityListenerList +sun/awt/TimedWindowEvent +sun/awt/WindowClosingListener +sun/awt/WindowClosingSupport +sun/awt/datatransfer/DataTransferer +sun/awt/datatransfer/DataTransferer$1 +sun/awt/datatransfer/DataTransferer$CharsetComparator +sun/awt/datatransfer/DataTransferer$IndexOrderComparator +sun/awt/datatransfer/DataTransferer$IndexedComparator +sun/awt/datatransfer/DataTransferer$RMI +sun/awt/datatransfer/DataTransferer$StandardEncodingsHolder +sun/awt/datatransfer/SunClipboard +sun/awt/datatransfer/ToolkitThreadBlockedHandler +sun/awt/datatransfer/TransferableProxy +sun/awt/dnd/SunDragSourceContextPeer +sun/awt/dnd/SunDropTargetEvent +sun/awt/event/IgnorePaintEvent +sun/awt/im/CompositionAreaHandler +sun/awt/im/ExecutableInputMethodManager +sun/awt/im/ExecutableInputMethodManager$3 +sun/awt/im/InputContext +sun/awt/im/InputMethodAdapter +sun/awt/im/InputMethodContext +sun/awt/im/InputMethodLocator +sun/awt/im/InputMethodManager +sun/awt/im/InputMethodWindow +sun/awt/image/BufImgSurfaceData +sun/awt/image/BufImgSurfaceData$ICMColorData +sun/awt/image/BufImgSurfaceManager +sun/awt/image/BufferedImageGraphicsConfig +sun/awt/image/ByteComponentRaster +sun/awt/image/ByteInterleavedRaster +sun/awt/image/BytePackedRaster +sun/awt/image/FetcherInfo +sun/awt/image/GifFrame +sun/awt/image/GifImageDecoder +sun/awt/image/ImageConsumerQueue +sun/awt/image/ImageDecoder +sun/awt/image/ImageFetchable +sun/awt/image/ImageFetcher +sun/awt/image/ImageFetcher$1 +sun/awt/image/ImageRepresentation +sun/awt/image/ImageWatched +sun/awt/image/ImageWatched$Link +sun/awt/image/ImageWatched$WeakLink +sun/awt/image/InputStreamImageSource +sun/awt/image/IntegerComponentRaster +sun/awt/image/IntegerInterleavedRaster +sun/awt/image/NativeLibLoader +sun/awt/image/NativeLibLoader$1 +sun/awt/image/OffScreenImage +sun/awt/image/OffScreenImageSource +sun/awt/image/PNGFilterInputStream +sun/awt/image/PNGImageDecoder +sun/awt/image/PixelConverter +sun/awt/image/PixelConverter$Argb +sun/awt/image/PixelConverter$ArgbBm +sun/awt/image/PixelConverter$ArgbPre +sun/awt/image/PixelConverter$Bgrx +sun/awt/image/PixelConverter$ByteGray +sun/awt/image/PixelConverter$Rgba +sun/awt/image/PixelConverter$RgbaPre +sun/awt/image/PixelConverter$Rgbx +sun/awt/image/PixelConverter$Ushort4444Argb +sun/awt/image/PixelConverter$Ushort555Rgb +sun/awt/image/PixelConverter$Ushort555Rgbx +sun/awt/image/PixelConverter$Ushort565Rgb +sun/awt/image/PixelConverter$UshortGray +sun/awt/image/PixelConverter$Xbgr +sun/awt/image/PixelConverter$Xrgb +sun/awt/image/SunVolatileImage +sun/awt/image/SunWritableRaster +sun/awt/image/SunWritableRaster$DataStealer +sun/awt/image/SurfaceManager +sun/awt/image/SurfaceManager$FlushableCacheData +sun/awt/image/SurfaceManager$ImageAccessor +sun/awt/image/SurfaceManager$ProxiedGraphicsConfig +sun/awt/image/ToolkitImage +sun/awt/image/URLImageSource +sun/awt/image/VolatileSurfaceManager +sun/awt/resources/awt +sun/awt/resources/awtosx +sun/awt/util/IdentityArrayList +sun/awt/util/IdentityLinkedList +sun/awt/util/IdentityLinkedList$Entry +sun/awt/util/IdentityLinkedList$ListItr +sun/dc/DuctusRenderingEngine +sun/font/AttributeValues +sun/font/CCharToGlyphMapper +sun/font/CCharToGlyphMapper$Cache +sun/font/CFont +sun/font/CFontConfiguration +sun/font/CFontManager +sun/font/CFontManager$4 +sun/font/CStrike +sun/font/CStrike$GlyphAdvanceCache +sun/font/CStrike$GlyphInfoCache +sun/font/CStrikeDisposer +sun/font/CharToGlyphMapper +sun/font/CompositeFont +sun/font/CompositeFontDescriptor +sun/font/CoreMetrics +sun/font/EAttribute +sun/font/FileFont +sun/font/Font2D +sun/font/Font2DHandle +sun/font/FontAccess +sun/font/FontDesignMetrics +sun/font/FontDesignMetrics$KeyReference +sun/font/FontDesignMetrics$MetricsKey +sun/font/FontFamily +sun/font/FontLineMetrics +sun/font/FontManager +sun/font/FontManagerFactory +sun/font/FontManagerFactory$1 +sun/font/FontManagerForSGE +sun/font/FontManagerNativeLibrary +sun/font/FontManagerNativeLibrary$1 +sun/font/FontStrike +sun/font/FontStrikeDesc +sun/font/FontStrikeDisposer +sun/font/FontUtilities +sun/font/FontUtilities$1 +sun/font/GlyphList +sun/font/PhysicalFont +sun/font/PhysicalStrike +sun/font/StandardGlyphVector +sun/font/StandardGlyphVector$GlyphStrike +sun/font/StrikeCache +sun/font/StrikeCache$1 +sun/font/StrikeCache$DisposableStrike +sun/font/StrikeCache$SoftDisposerRef +sun/font/StrikeMetrics +sun/font/SunFontManager +sun/font/SunFontManager$1 +sun/font/SunFontManager$11 +sun/font/SunFontManager$2 +sun/font/SunFontManager$3 +sun/font/SunFontManager$FontRegistrationInfo +sun/font/SunFontManager$T1Filter +sun/font/SunFontManager$TTFilter +sun/font/TrueTypeFont +sun/font/TrueTypeFont$1 +sun/font/TrueTypeFont$DirectoryEntry +sun/font/TrueTypeFont$TTDisposerRecord +sun/font/Type1Font +sun/java2d/DefaultDisposerRecord +sun/java2d/DestSurfaceProvider +sun/java2d/Disposer +sun/java2d/Disposer$1 +sun/java2d/Disposer$2 +sun/java2d/Disposer$PollDisposable +sun/java2d/DisposerRecord +sun/java2d/DisposerTarget +sun/java2d/FontSupport +sun/java2d/InvalidPipeException +sun/java2d/MacosxSurfaceManagerFactory +sun/java2d/NullSurfaceData +sun/java2d/StateTrackable +sun/java2d/StateTrackable$State +sun/java2d/StateTrackableDelegate +sun/java2d/StateTrackableDelegate$1 +sun/java2d/StateTrackableDelegate$2 +sun/java2d/StateTracker +sun/java2d/StateTracker$1 +sun/java2d/StateTracker$2 +sun/java2d/SunGraphics2D +sun/java2d/SunGraphicsEnvironment +sun/java2d/SunGraphicsEnvironment$1 +sun/java2d/Surface +sun/java2d/SurfaceData +sun/java2d/SurfaceData$PixelToPgramLoopConverter +sun/java2d/SurfaceData$PixelToShapeLoopConverter +sun/java2d/SurfaceDataProxy +sun/java2d/SurfaceDataProxy$1 +sun/java2d/SurfaceManagerFactory +sun/java2d/cmm/CMSManager +sun/java2d/cmm/ProfileActivator +sun/java2d/cmm/ProfileDeferralInfo +sun/java2d/cmm/ProfileDeferralMgr +sun/java2d/loops/Blit +sun/java2d/loops/BlitBg +sun/java2d/loops/CompositeType +sun/java2d/loops/CustomComponent +sun/java2d/loops/DrawGlyphList +sun/java2d/loops/DrawGlyphListAA +sun/java2d/loops/DrawGlyphListLCD +sun/java2d/loops/DrawLine +sun/java2d/loops/DrawParallelogram +sun/java2d/loops/DrawPath +sun/java2d/loops/DrawPolygons +sun/java2d/loops/DrawRect +sun/java2d/loops/FillParallelogram +sun/java2d/loops/FillPath +sun/java2d/loops/FillRect +sun/java2d/loops/FillSpans +sun/java2d/loops/FontInfo +sun/java2d/loops/GeneralRenderer +sun/java2d/loops/GraphicsPrimitive +sun/java2d/loops/GraphicsPrimitiveMgr +sun/java2d/loops/GraphicsPrimitiveMgr$1 +sun/java2d/loops/GraphicsPrimitiveMgr$2 +sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec +sun/java2d/loops/GraphicsPrimitiveProxy +sun/java2d/loops/MaskBlit +sun/java2d/loops/MaskFill +sun/java2d/loops/ProcessPath$DrawHandler +sun/java2d/loops/RenderCache +sun/java2d/loops/RenderCache$Entry +sun/java2d/loops/RenderLoops +sun/java2d/loops/ScaledBlit +sun/java2d/loops/SurfaceType +sun/java2d/loops/TransformBlit +sun/java2d/loops/TransformHelper +sun/java2d/loops/XORComposite +sun/java2d/opengl/CGLGraphicsConfig +sun/java2d/opengl/CGLGraphicsConfig$1 +sun/java2d/opengl/CGLGraphicsConfig$CGLGCDisposerRecord +sun/java2d/opengl/CGLGraphicsConfig$CGLImageCaps +sun/java2d/opengl/CGLLayer +sun/java2d/opengl/CGLSurfaceData +sun/java2d/opengl/CGLSurfaceData$CGLLayerSurfaceData +sun/java2d/opengl/CGLSurfaceData$CGLOffScreenSurfaceData +sun/java2d/opengl/CGLVolatileSurfaceManager +sun/java2d/opengl/OGLAnyCompositeBlit +sun/java2d/opengl/OGLBlitLoops +sun/java2d/opengl/OGLContext +sun/java2d/opengl/OGLContext$OGLContextCaps +sun/java2d/opengl/OGLDrawImage +sun/java2d/opengl/OGLGeneralBlit +sun/java2d/opengl/OGLGraphicsConfig +sun/java2d/opengl/OGLMaskBlit +sun/java2d/opengl/OGLMaskFill +sun/java2d/opengl/OGLRTTSurfaceToSurfaceBlit +sun/java2d/opengl/OGLRTTSurfaceToSurfaceScale +sun/java2d/opengl/OGLRTTSurfaceToSurfaceTransform +sun/java2d/opengl/OGLRenderQueue +sun/java2d/opengl/OGLRenderQueue$1 +sun/java2d/opengl/OGLRenderQueue$QueueFlusher +sun/java2d/opengl/OGLRenderer +sun/java2d/opengl/OGLSurfaceData +sun/java2d/opengl/OGLSurfaceData$1 +sun/java2d/opengl/OGLSurfaceDataProxy +sun/java2d/opengl/OGLSurfaceToSurfaceBlit +sun/java2d/opengl/OGLSurfaceToSurfaceScale +sun/java2d/opengl/OGLSurfaceToSurfaceTransform +sun/java2d/opengl/OGLSurfaceToSwBlit +sun/java2d/opengl/OGLSwToSurfaceBlit +sun/java2d/opengl/OGLSwToSurfaceScale +sun/java2d/opengl/OGLSwToSurfaceTransform +sun/java2d/opengl/OGLSwToTextureBlit +sun/java2d/opengl/OGLTextRenderer +sun/java2d/opengl/OGLTextureToSurfaceBlit +sun/java2d/opengl/OGLTextureToSurfaceScale +sun/java2d/opengl/OGLTextureToSurfaceTransform +sun/java2d/pipe/AAShapePipe +sun/java2d/pipe/AATextRenderer +sun/java2d/pipe/AlphaColorPipe +sun/java2d/pipe/AlphaPaintPipe +sun/java2d/pipe/BufferedContext +sun/java2d/pipe/BufferedMaskBlit +sun/java2d/pipe/BufferedMaskFill +sun/java2d/pipe/BufferedPaints +sun/java2d/pipe/BufferedRenderPipe +sun/java2d/pipe/BufferedRenderPipe$AAParallelogramPipe +sun/java2d/pipe/BufferedRenderPipe$BufferedDrawHandler +sun/java2d/pipe/BufferedTextPipe +sun/java2d/pipe/CompositePipe +sun/java2d/pipe/DrawImage +sun/java2d/pipe/DrawImagePipe +sun/java2d/pipe/GeneralCompositePipe +sun/java2d/pipe/GlyphListLoopPipe +sun/java2d/pipe/GlyphListPipe +sun/java2d/pipe/LCDTextRenderer +sun/java2d/pipe/LoopBasedPipe +sun/java2d/pipe/LoopPipe +sun/java2d/pipe/NullPipe +sun/java2d/pipe/OutlineTextRenderer +sun/java2d/pipe/ParallelogramPipe +sun/java2d/pipe/PixelDrawPipe +sun/java2d/pipe/PixelFillPipe +sun/java2d/pipe/PixelToParallelogramConverter +sun/java2d/pipe/PixelToShapeConverter +sun/java2d/pipe/Region +sun/java2d/pipe/Region$ImmutableRegion +sun/java2d/pipe/RegionIterator +sun/java2d/pipe/RenderBuffer +sun/java2d/pipe/RenderQueue +sun/java2d/pipe/RenderingEngine +sun/java2d/pipe/RenderingEngine$1 +sun/java2d/pipe/ShapeDrawPipe +sun/java2d/pipe/SolidTextRenderer +sun/java2d/pipe/SpanClipRenderer +sun/java2d/pipe/SpanShapeRenderer +sun/java2d/pipe/SpanShapeRenderer$Composite +sun/java2d/pipe/TextPipe +sun/java2d/pipe/TextRenderer +sun/java2d/pipe/ValidatePipe +sun/java2d/pipe/hw/AccelGraphicsConfig +sun/java2d/pipe/hw/AccelSurface +sun/java2d/pipe/hw/BufferedContextProvider +sun/java2d/pipe/hw/ContextCapabilities +sun/launcher/LauncherHelper +sun/launcher/LauncherHelper$FXHelper +sun/lwawt/LWCanvasPeer +sun/lwawt/LWComponentPeer +sun/lwawt/LWComponentPeer$1 +sun/lwawt/LWComponentPeer$2 +sun/lwawt/LWComponentPeer$3 +sun/lwawt/LWComponentPeer$DelegateContainer +sun/lwawt/LWContainerPeer +sun/lwawt/LWCursorManager +sun/lwawt/LWCursorManager$1 +sun/lwawt/LWGraphicsConfig +sun/lwawt/LWKeyboardFocusManagerPeer +sun/lwawt/LWLabelPeer +sun/lwawt/LWRepaintArea +sun/lwawt/LWToolkit +sun/lwawt/LWWindowPeer +sun/lwawt/LWWindowPeer$PeerType +sun/lwawt/PlatformComponent +sun/lwawt/PlatformEventNotifier +sun/lwawt/PlatformWindow +sun/lwawt/macosx/CClipboard +sun/lwawt/macosx/CCursorManager +sun/lwawt/macosx/CCustomCursor +sun/lwawt/macosx/CDataTransferer +sun/lwawt/macosx/CDropTarget +sun/lwawt/macosx/CFRetainedResource +sun/lwawt/macosx/CImage +sun/lwawt/macosx/CImage$Creator +sun/lwawt/macosx/CInputMethod +sun/lwawt/macosx/CInputMethodDescriptor +sun/lwawt/macosx/CPlatformComponent +sun/lwawt/macosx/CPlatformResponder +sun/lwawt/macosx/CPlatformView +sun/lwawt/macosx/CPlatformWindow +sun/lwawt/macosx/CPlatformWindow$1 +sun/lwawt/macosx/CPlatformWindow$10 +sun/lwawt/macosx/CPlatformWindow$11 +sun/lwawt/macosx/CPlatformWindow$12 +sun/lwawt/macosx/CPlatformWindow$14 +sun/lwawt/macosx/CPlatformWindow$2 +sun/lwawt/macosx/CPlatformWindow$3 +sun/lwawt/macosx/CPlatformWindow$4 +sun/lwawt/macosx/CPlatformWindow$5 +sun/lwawt/macosx/CPlatformWindow$6 +sun/lwawt/macosx/CPlatformWindow$7 +sun/lwawt/macosx/CPlatformWindow$8 +sun/lwawt/macosx/CPlatformWindow$9 +sun/lwawt/macosx/CPrinterDialog +sun/lwawt/macosx/CThreading +sun/lwawt/macosx/CToolkitThreadBlockedHandler +sun/lwawt/macosx/CWrapper$NSWindow +sun/lwawt/macosx/LWCToolkit +sun/lwawt/macosx/LWCToolkit$1 +sun/lwawt/macosx/LWCToolkit$2 +sun/lwawt/macosx/LWCToolkit$5 +sun/lwawt/macosx/LWCToolkit$AppleSpecificColor +sun/lwawt/macosx/NamedCursor +sun/lwawt/macosx/event/NSEvent +sun/misc/ASCIICaseInsensitiveComparator +sun/misc/Cleaner +sun/misc/CompoundEnumeration +sun/misc/ExtensionDependency +sun/misc/FileURLMapper +sun/misc/FloatingDecimal +sun/misc/FloatingDecimal$1 +sun/misc/FloatingDecimal$ASCIIToBinaryConverter +sun/misc/FloatingDecimal$BinaryToASCIIBuffer +sun/misc/FloatingDecimal$BinaryToASCIIConverter +sun/misc/FloatingDecimal$ExceptionalBinaryToASCIIBuffer +sun/misc/FloatingDecimal$PreparedASCIIToBinaryBuffer +sun/misc/IOUtils +sun/misc/JarIndex +sun/misc/JavaAWTAccess +sun/misc/JavaIOFileDescriptorAccess +sun/misc/JavaLangAccess +sun/misc/JavaNetAccess +sun/misc/JavaNioAccess +sun/misc/JavaSecurityAccess +sun/misc/JavaSecurityProtectionDomainAccess +sun/misc/JavaUtilJarAccess +sun/misc/JavaUtilZipFileAccess +sun/misc/Launcher +sun/misc/Launcher$AppClassLoader +sun/misc/Launcher$AppClassLoader$1 +sun/misc/Launcher$BootClassPathHolder +sun/misc/Launcher$BootClassPathHolder$1 +sun/misc/Launcher$ExtClassLoader +sun/misc/Launcher$ExtClassLoader$1 +sun/misc/Launcher$Factory +sun/misc/MetaIndex +sun/misc/NativeSignalHandler +sun/misc/OSEnvironment +sun/misc/Perf +sun/misc/Perf$GetPerfAction +sun/misc/PerfCounter +sun/misc/PerfCounter$CoreCounters +sun/misc/PerformanceLogger +sun/misc/PerformanceLogger$TimeData +sun/misc/PostVMInitHook +sun/misc/Resource +sun/misc/SharedSecrets +sun/misc/Signal +sun/misc/SignalHandler +sun/misc/SoftCache +sun/misc/SoftCache$ValueCell +sun/misc/URLClassPath +sun/misc/URLClassPath$1 +sun/misc/URLClassPath$2 +sun/misc/URLClassPath$3 +sun/misc/URLClassPath$FileLoader +sun/misc/URLClassPath$JarLoader +sun/misc/URLClassPath$JarLoader$1 +sun/misc/URLClassPath$JarLoader$2 +sun/misc/URLClassPath$Loader +sun/misc/Unsafe +sun/misc/VM +sun/misc/Version +sun/net/DefaultProgressMeteringPolicy +sun/net/NetHooks +sun/net/NetHooks$Provider +sun/net/NetProperties +sun/net/NetProperties$1 +sun/net/ProgressMeteringPolicy +sun/net/ProgressMonitor +sun/net/sdp/SdpProvider +sun/net/spi/DefaultProxySelector +sun/net/spi/DefaultProxySelector$1 +sun/net/spi/DefaultProxySelector$3 +sun/net/spi/DefaultProxySelector$NonProxyInfo +sun/net/spi/nameservice/NameService +sun/net/util/IPAddressUtil +sun/net/util/URLUtil +sun/net/www/MessageHeader +sun/net/www/ParseUtil +sun/net/www/URLConnection +sun/net/www/protocol/file/FileURLConnection +sun/net/www/protocol/file/Handler +sun/net/www/protocol/jar/Handler +sun/net/www/protocol/jar/JarFileFactory +sun/net/www/protocol/jar/JarURLConnection +sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream +sun/net/www/protocol/jar/URLJarFile +sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController +sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry +sun/nio/ByteBuffered +sun/nio/ch/DirectBuffer +sun/nio/ch/FileChannelImpl +sun/nio/ch/FileDispatcher +sun/nio/ch/FileDispatcherImpl +sun/nio/ch/IOStatus +sun/nio/ch/IOUtil +sun/nio/ch/IOUtil$1 +sun/nio/ch/Interruptible +sun/nio/ch/NativeDispatcher +sun/nio/ch/NativeThread +sun/nio/ch/NativeThreadSet +sun/nio/ch/Util +sun/nio/ch/Util$1 +sun/nio/ch/Util$BufferCache +sun/nio/cs/ArrayDecoder +sun/nio/cs/ArrayEncoder +sun/nio/cs/FastCharsetProvider +sun/nio/cs/HistoricallyNamedCharset +sun/nio/cs/ISO_8859_1 +sun/nio/cs/ISO_8859_1$Decoder +sun/nio/cs/StandardCharsets +sun/nio/cs/StandardCharsets$Aliases +sun/nio/cs/StandardCharsets$Cache +sun/nio/cs/StandardCharsets$Classes +sun/nio/cs/StreamDecoder +sun/nio/cs/StreamEncoder +sun/nio/cs/US_ASCII +sun/nio/cs/UTF_16 +sun/nio/cs/UTF_16$Decoder +sun/nio/cs/UTF_16BE +sun/nio/cs/UTF_16LE +sun/nio/cs/UTF_8 +sun/nio/cs/UTF_8$Decoder +sun/nio/cs/UTF_8$Encoder +sun/nio/cs/Unicode +sun/nio/cs/UnicodeDecoder +sun/print/PrinterGraphicsConfig +sun/reflect/AccessorGenerator +sun/reflect/BootstrapConstructorAccessorImpl +sun/reflect/ByteVector +sun/reflect/ByteVectorFactory +sun/reflect/ByteVectorImpl +sun/reflect/CallerSensitive +sun/reflect/ClassDefiner +sun/reflect/ClassDefiner$1 +sun/reflect/ClassFileAssembler +sun/reflect/ClassFileConstants +sun/reflect/ConstantPool +sun/reflect/ConstructorAccessor +sun/reflect/ConstructorAccessorImpl +sun/reflect/DelegatingClassLoader +sun/reflect/DelegatingConstructorAccessorImpl +sun/reflect/DelegatingMethodAccessorImpl +sun/reflect/FieldAccessor +sun/reflect/FieldAccessorImpl +sun/reflect/Label +sun/reflect/Label$PatchInfo +sun/reflect/LangReflectAccess +sun/reflect/MagicAccessorImpl +sun/reflect/MethodAccessor +sun/reflect/MethodAccessorGenerator +sun/reflect/MethodAccessorGenerator$1 +sun/reflect/MethodAccessorImpl +sun/reflect/NativeConstructorAccessorImpl +sun/reflect/NativeMethodAccessorImpl +sun/reflect/Reflection +sun/reflect/ReflectionFactory +sun/reflect/ReflectionFactory$1 +sun/reflect/ReflectionFactory$GetReflectionFactoryAction +sun/reflect/SerializationConstructorAccessorImpl +sun/reflect/UTF8 +sun/reflect/UnsafeBooleanFieldAccessorImpl +sun/reflect/UnsafeFieldAccessorFactory +sun/reflect/UnsafeFieldAccessorImpl +sun/reflect/UnsafeObjectFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticLongFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl +sun/reflect/UnsafeStaticFieldAccessorImpl +sun/reflect/annotation/AnnotationType +sun/reflect/generics/repository/AbstractRepository +sun/reflect/generics/repository/ClassRepository +sun/reflect/generics/repository/GenericDeclRepository +sun/reflect/misc/MethodUtil +sun/reflect/misc/MethodUtil$1 +sun/reflect/misc/ReflectUtil +sun/security/action/GetBooleanAction +sun/security/action/GetPropertyAction +sun/security/util/Debug +sun/security/util/ManifestEntryVerifier +sun/swing/DefaultLookup +sun/swing/JLightweightFrame +sun/swing/MenuItemLayoutHelper +sun/swing/StringUIClientPropertyKey +sun/swing/SwingAccessor +sun/swing/SwingAccessor$JTextComponentAccessor +sun/swing/SwingLazyValue +sun/swing/SwingLazyValue$1 +sun/swing/SwingUtilities2 +sun/swing/SwingUtilities2$2 +sun/swing/SwingUtilities2$AATextInfo +sun/swing/SwingUtilities2$LSBCacheEntry +sun/swing/UIAction +sun/swing/UIClientPropertyKey +sun/util/CoreResourceBundleControl +sun/util/PreHashedMap +sun/util/ResourceBundleEnumeration +sun/util/calendar/AbstractCalendar +sun/util/calendar/BaseCalendar +sun/util/calendar/BaseCalendar$Date +sun/util/calendar/CalendarDate +sun/util/calendar/CalendarSystem +sun/util/calendar/CalendarUtils +sun/util/calendar/Gregorian +sun/util/calendar/Gregorian$Date +sun/util/calendar/ZoneInfo +sun/util/calendar/ZoneInfoFile +sun/util/calendar/ZoneInfoFile$1 +sun/util/calendar/ZoneInfoFile$Checksum +sun/util/calendar/ZoneInfoFile$ZoneOffsetTransitionRule +sun/util/locale/BaseLocale +sun/util/locale/BaseLocale$Cache +sun/util/locale/BaseLocale$Key +sun/util/locale/LocaleObjectCache +sun/util/locale/LocaleObjectCache$CacheEntry +sun/util/locale/LocaleUtils +sun/util/locale/provider/AuxLocaleProviderAdapter +sun/util/locale/provider/AuxLocaleProviderAdapter$NullProvider +sun/util/locale/provider/JRELocaleProviderAdapter +sun/util/locale/provider/JRELocaleProviderAdapter$1 +sun/util/locale/provider/LocaleDataMetaInfo +sun/util/locale/provider/LocaleProviderAdapter +sun/util/locale/provider/LocaleProviderAdapter$1 +sun/util/locale/provider/LocaleProviderAdapter$Type +sun/util/locale/provider/LocaleResources +sun/util/locale/provider/LocaleResources$ResourceReference +sun/util/locale/provider/LocaleServiceProviderPool +sun/util/locale/provider/LocaleServiceProviderPool$LocalizedObjectGetter +sun/util/locale/provider/ResourceBundleBasedAdapter +sun/util/locale/provider/SPILocaleProviderAdapter +sun/util/locale/provider/SPILocaleProviderAdapter$1 +sun/util/locale/provider/TimeZoneNameProviderImpl +sun/util/locale/provider/TimeZoneNameUtility$TimeZoneNameGetter +sun/util/logging/LoggingProxy +sun/util/logging/LoggingSupport +sun/util/logging/LoggingSupport$1 +sun/util/logging/LoggingSupport$2 +sun/util/logging/PlatformLogger +sun/util/logging/PlatformLogger$1 +sun/util/logging/PlatformLogger$DefaultLoggerProxy +sun/util/logging/PlatformLogger$JavaLoggerProxy +sun/util/logging/PlatformLogger$Level +sun/util/logging/PlatformLogger$LoggerProxy +sun/util/logging/resources/logging +sun/util/resources/LocaleData +sun/util/resources/LocaleData$1 +sun/util/resources/LocaleData$LocaleDataResourceBundleControl +sun/util/resources/OpenListResourceBundle +sun/util/resources/TimeZoneNames +sun/util/resources/TimeZoneNamesBundle +sun/util/resources/en/TimeZoneNames_en +# 32aa76348b93579f diff --git a/jdk/make/tools/sharing/classlist.solaris b/jdk/make/tools/sharing/classlist.solaris index 8955d32898f..e5175dccb95 100644 --- a/jdk/make/tools/sharing/classlist.solaris +++ b/jdk/make/tools/sharing/classlist.solaris @@ -1,2419 +1,2644 @@ -java/lang/Object -java/lang/String -java/io/Serializable -java/lang/Comparable -java/lang/CharSequence -java/lang/Class -java/lang/reflect/GenericDeclaration -java/lang/reflect/Type -java/lang/reflect/AnnotatedElement -java/lang/Cloneable -java/lang/ClassLoader -java/lang/System -java/lang/Throwable -java/lang/Error -java/lang/ThreadDeath -java/lang/Exception -java/lang/RuntimeException -java/security/ProtectionDomain -java/security/AccessControlContext -java/lang/ClassNotFoundException -java/lang/NoClassDefFoundError -java/lang/LinkageError -java/lang/ClassCastException -java/lang/ArrayStoreException -java/lang/VirtualMachineError -java/lang/OutOfMemoryError -java/lang/StackOverflowError -java/lang/IllegalMonitorStateException -java/lang/ref/Reference -java/lang/ref/SoftReference -java/lang/ref/WeakReference -java/lang/ref/FinalReference -java/lang/ref/PhantomReference -java/lang/ref/Finalizer -java/lang/Thread -java/lang/Runnable -java/lang/ThreadGroup -java/lang/Thread$UncaughtExceptionHandler -java/util/Properties -java/util/Hashtable -java/util/Map -java/util/Dictionary -java/lang/reflect/AccessibleObject -java/lang/reflect/Field -java/lang/reflect/Member -java/lang/reflect/Method -java/lang/reflect/Constructor -sun/reflect/MagicAccessorImpl -sun/reflect/MethodAccessorImpl -sun/reflect/MethodAccessor -sun/reflect/ConstructorAccessorImpl -sun/reflect/ConstructorAccessor -sun/reflect/DelegatingClassLoader -sun/reflect/ConstantPool -sun/reflect/UnsafeStaticFieldAccessorImpl -sun/reflect/UnsafeFieldAccessorImpl -sun/reflect/FieldAccessorImpl -sun/reflect/FieldAccessor -java/util/Vector -java/util/List -java/util/Collection -java/lang/Iterable -java/util/RandomAccess -java/util/AbstractList -java/util/AbstractCollection -java/lang/StringBuffer -java/lang/AbstractStringBuilder -java/lang/Appendable -java/lang/StackTraceElement -java/nio/Buffer -java/lang/Boolean -java/lang/Character -java/lang/Float -java/lang/Number -java/lang/Double -java/lang/Byte -java/lang/Short -java/lang/Integer -java/lang/Long -java/lang/NullPointerException -java/lang/ArithmeticException -java/io/ObjectStreamField -java/lang/String$CaseInsensitiveComparator -java/util/Comparator -java/lang/RuntimePermission -java/security/BasicPermission -java/security/Permission -java/security/Guard -sun/misc/SoftCache -java/util/AbstractMap -java/lang/ref/ReferenceQueue -java/lang/ref/ReferenceQueue$Null -java/lang/ref/ReferenceQueue$Lock -java/util/HashMap -java/lang/annotation/Annotation -java/util/HashMap$Entry -java/util/Map$Entry -java/security/AccessController -java/lang/reflect/ReflectPermission -sun/reflect/ReflectionFactory$GetReflectionFactoryAction -java/security/PrivilegedAction -java/util/Stack -sun/reflect/ReflectionFactory -java/lang/ref/Reference$Lock -java/lang/ref/Reference$ReferenceHandler -java/lang/ref/Finalizer$FinalizerThread -java/util/Enumeration -java/util/Iterator -java/util/Hashtable$Entry -java/nio/charset/Charset -sun/nio/cs/StandardCharsets -sun/nio/cs/FastCharsetProvider -java/nio/charset/spi/CharsetProvider -sun/nio/cs/StandardCharsets$Aliases -sun/util/PreHashedMap -sun/nio/cs/StandardCharsets$Classes -sun/nio/cs/StandardCharsets$Cache -java/lang/ThreadLocal -java/util/concurrent/atomic/AtomicInteger -sun/misc/Unsafe -java/lang/NoSuchMethodError -java/lang/IncompatibleClassChangeError -sun/reflect/Reflection -java/util/Collections -java/util/Collections$EmptySet -java/util/AbstractSet -java/util/Set -java/util/Collections$EmptyList -java/util/Collections$EmptyMap -java/util/Collections$ReverseComparator -java/util/Collections$SynchronizedMap -java/lang/Class$3 -java/lang/reflect/Modifier -java/lang/reflect/ReflectAccess -sun/reflect/LangReflectAccess -java/util/Arrays -java/lang/Math -java/lang/StringBuilder -sun/nio/cs/UTF_8 -sun/nio/cs/Unicode -sun/nio/cs/HistoricallyNamedCharset -java/lang/Class$1 -sun/reflect/ReflectionFactory$1 -sun/reflect/NativeConstructorAccessorImpl -sun/reflect/DelegatingConstructorAccessorImpl -sun/misc/VM -java/lang/StringCoding -java/lang/ThreadLocal$ThreadLocalMap -java/lang/ThreadLocal$ThreadLocalMap$Entry -java/lang/StringCoding$StringDecoder -sun/nio/cs/UTF_8$Decoder -java/nio/charset/CharsetDecoder -java/nio/charset/CodingErrorAction -sun/nio/cs/Surrogate$Generator -sun/nio/cs/Surrogate -java/nio/charset/CoderResult -java/nio/charset/CoderResult$1 -java/nio/charset/CoderResult$Cache -java/nio/charset/CoderResult$2 -java/nio/ByteBuffer -java/nio/HeapByteBuffer -java/nio/Bits -java/nio/ByteOrder -java/nio/CharBuffer -java/lang/Readable -java/nio/HeapCharBuffer -sun/misc/Version -java/io/FileInputStream -java/io/InputStream -java/io/Closeable -java/io/FileDescriptor -java/io/FileOutputStream -java/io/OutputStream -java/io/Flushable -java/io/BufferedInputStream -java/io/FilterInputStream -java/util/concurrent/atomic/AtomicReferenceFieldUpdater -java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl -sun/reflect/misc/ReflectUtil -java/io/PrintStream -java/io/FilterOutputStream -java/io/BufferedOutputStream -java/io/OutputStreamWriter -java/io/Writer -sun/nio/cs/StreamEncoder -sun/security/action/GetPropertyAction -sun/nio/cs/UTF_8$Encoder -java/nio/charset/CharsetEncoder -sun/nio/cs/Surrogate$Parser -java/io/BufferedWriter -java/lang/Runtime -java/io/File -java/io/FileSystem -java/io/UnixFileSystem -java/io/ExpiringCache -java/io/ExpiringCache$1 -java/util/LinkedHashMap -java/util/LinkedHashMap$Entry -sun/misc/SharedSecrets -java/lang/ClassLoader$3 -java/lang/StringCoding$StringEncoder -java/io/ExpiringCache$Entry -java/lang/ClassLoader$NativeLibrary -java/lang/Terminator -java/lang/Terminator$1 -sun/misc/SignalHandler -sun/misc/Signal -sun/misc/NativeSignalHandler -java/io/Console -java/io/Console$1 -sun/misc/JavaIOAccess -java/lang/Shutdown -java/util/ArrayList -java/lang/Shutdown$Lock -java/lang/ApplicationShutdownHooks -java/util/IdentityHashMap -sun/misc/OSEnvironment -java/lang/System$2 -sun/misc/JavaLangAccess -java/lang/Compiler -java/lang/Compiler$1 -sun/misc/Launcher -sun/misc/Launcher$Factory -java/net/URLStreamHandlerFactory -sun/misc/Launcher$ExtClassLoader -java/net/URLClassLoader -java/security/SecureClassLoader -sun/security/util/Debug -java/net/URLClassLoader$7 -sun/misc/JavaNetAccess -java/util/StringTokenizer -sun/misc/Launcher$ExtClassLoader$1 -java/security/PrivilegedExceptionAction -sun/misc/MetaIndex -java/io/BufferedReader -java/io/Reader -java/io/FileReader -java/io/InputStreamReader -sun/nio/cs/StreamDecoder -java/lang/reflect/Array -sun/net/www/ParseUtil -java/util/BitSet -java/io/ObjectStreamClass -java/net/URL -java/util/Locale -java/util/concurrent/ConcurrentHashMap -java/util/concurrent/ConcurrentMap -java/util/concurrent/ConcurrentHashMap$Segment -java/util/concurrent/locks/ReentrantLock -java/util/concurrent/locks/Lock -java/util/concurrent/locks/ReentrantLock$NonfairSync -java/util/concurrent/locks/ReentrantLock$Sync -java/util/concurrent/locks/AbstractQueuedSynchronizer -java/util/concurrent/locks/AbstractOwnableSynchronizer -java/util/concurrent/locks/AbstractQueuedSynchronizer$Node -java/util/concurrent/ConcurrentHashMap$HashEntry -java/lang/CharacterDataLatin1 -java/net/Parts -sun/net/www/protocol/file/Handler -java/net/URLStreamHandler -java/util/HashSet -sun/misc/URLClassPath -sun/net/www/protocol/jar/Handler -sun/misc/Launcher$AppClassLoader -sun/misc/Launcher$AppClassLoader$1 -java/lang/SystemClassLoaderAction -java/net/URLClassLoader$1 -sun/misc/URLClassPath$3 -sun/misc/URLClassPath$JarLoader -sun/misc/URLClassPath$Loader -java/security/PrivilegedActionException -sun/misc/URLClassPath$FileLoader -sun/misc/URLClassPath$FileLoader$1 -sun/misc/Resource -sun/nio/ByteBuffered -java/security/CodeSource -java/security/Permissions -java/security/PermissionCollection -sun/net/www/protocol/file/FileURLConnection -sun/net/www/URLConnection -java/net/URLConnection -java/net/UnknownContentHandler -java/net/ContentHandler -sun/net/www/MessageHeader -java/io/FilePermission -java/io/FilePermission$1 -sun/security/provider/PolicyFile -java/security/Policy -java/security/Policy$UnsupportedEmptyCollection -java/io/FilePermissionCollection -java/security/AllPermission -java/security/UnresolvedPermission -java/security/BasicPermissionCollection -java/security/Principal -java/security/cert/Certificate -java/util/AbstractList$Itr -java/util/IdentityHashMap$KeySet -java/util/IdentityHashMap$KeyIterator -java/util/IdentityHashMap$IdentityHashMapIterator -java/io/DeleteOnExitHook -java/util/LinkedHashSet -java/util/HashMap$KeySet -java/util/LinkedHashMap$KeyIterator -java/util/LinkedHashMap$LinkedHashIterator -java/awt/Frame -java/awt/MenuContainer -java/awt/Window -javax/accessibility/Accessible -java/awt/Container -java/awt/Component -java/awt/image/ImageObserver -java/lang/InterruptedException -java/awt/Label -java/util/logging/Logger -java/util/logging/Handler -java/util/logging/Level -java/util/logging/LogManager -java/util/logging/LogManager$1 -java/beans/PropertyChangeSupport -java/util/logging/LogManager$LogNode -java/util/logging/LoggingPermission -java/util/logging/LogManager$Cleaner -java/util/logging/LogManager$RootLogger -java/util/logging/LogManager$2 -java/util/Properties$LineReader -java/util/Hashtable$Enumerator -java/beans/PropertyChangeEvent -java/util/EventObject -java/awt/Component$AWTTreeLock -sun/awt/NativeLibLoader -sun/security/action/LoadLibraryAction -java/awt/GraphicsEnvironment -java/awt/GraphicsEnvironment$1 -java/lang/ProcessEnvironment -java/lang/ProcessEnvironment$Variable -java/lang/ProcessEnvironment$ExternalData -java/lang/ProcessEnvironment$Value -java/lang/ProcessEnvironment$StringEnvironment -java/util/Collections$UnmodifiableMap -java/awt/Toolkit -java/awt/Toolkit$3 -sun/util/CoreResourceBundleControl -java/util/ResourceBundle$Control -java/util/Arrays$ArrayList -java/util/Collections$UnmodifiableRandomAccessList -java/util/Collections$UnmodifiableList -java/util/Collections$UnmodifiableCollection -java/util/ResourceBundle -java/util/ResourceBundle$1 -java/util/ResourceBundle$RBClassLoader -java/util/ResourceBundle$RBClassLoader$1 -java/util/ResourceBundle$CacheKey -java/util/ResourceBundle$LoaderReference -java/util/ResourceBundle$CacheKeyReference -java/util/ResourceBundle$SingleFormatControl -sun/awt/resources/awt -java/util/ListResourceBundle -java/awt/Toolkit$1 -java/io/FileNotFoundException -java/io/IOException -java/awt/event/KeyEvent -java/awt/event/InputEvent -java/awt/event/ComponentEvent +com/sun/java/swing/SwingUtilities3 +com/sun/java/swing/plaf/windows/WindowsTabbedPaneUI +com/sun/swing/internal/plaf/basic/resources/basic +com/sun/swing/internal/plaf/metal/resources/metal +java/applet/Applet java/awt/AWTEvent -java/awt/event/NativeLibLoader -java/util/WeakHashMap -java/util/WeakHashMap$Entry -java/awt/Component$DummyRequestFocusController -sun/awt/RequestFocusController -java/awt/LayoutManager -java/awt/LightweightDispatcher -java/awt/event/AWTEventListener -java/util/EventListener -java/awt/Dimension -java/awt/geom/Dimension2D -java/util/concurrent/atomic/AtomicBoolean -java/awt/ComponentOrientation -java/awt/Component$2 -java/lang/NoSuchMethodException -sun/awt/AppContext -sun/awt/AppContext$1 -sun/awt/AppContext$2 -sun/awt/MostRecentKeyValue -java/awt/Cursor -sun/awt/X11GraphicsEnvironment -sun/java2d/SunGraphicsEnvironment -sun/java2d/FontSupport -sun/awt/DisplayChangedListener -java/io/FilenameFilter -sun/awt/X11GraphicsEnvironment$1 -sun/awt/SunToolkit -sun/awt/WindowClosingSupport -sun/awt/WindowClosingListener -sun/awt/ComponentFactory -sun/awt/InputMethodSupport -java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject -java/util/concurrent/locks/Condition -sun/awt/AWTAutoShutdown -sun/awt/SunToolkit$6 -java/awt/Dialog$ModalExclusionType -java/lang/Enum -java/awt/Dialog -java/awt/Dialog$ModalityType -java/awt/ModalEventFilter -java/awt/EventFilter -sun/reflect/UnsafeFieldAccessorFactory -sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl -sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl -sun/awt/SunDisplayChanger -sun/java2d/SunGraphicsEnvironment$1 -sun/font/FontManager -sun/font/FileFont -sun/font/PhysicalFont -sun/font/Font2D -sun/font/CompositeFont -java/util/HashMap$Values -java/util/HashMap$ValueIterator -java/util/HashMap$HashIterator -java/awt/Font -java/awt/geom/AffineTransform -sun/font/AttributeValues -sun/font/EAttribute -java/text/AttributedCharacterIterator$Attribute -java/lang/Class$4 -sun/reflect/NativeMethodAccessorImpl -sun/reflect/DelegatingMethodAccessorImpl -java/awt/font/TextAttribute -java/lang/Integer$IntegerCache -sun/font/TrueTypeFont -java/awt/font/FontRenderContext -java/awt/RenderingHints -sun/awt/SunHints -sun/awt/SunHints$Key -java/awt/RenderingHints$Key -sun/awt/SunHints$Value -sun/awt/SunHints$LCDContrastKey -sun/font/Type1Font -java/awt/geom/Point2D$Float -java/awt/geom/Point2D -sun/font/StrikeMetrics -java/awt/geom/Rectangle2D$Float -java/awt/geom/Rectangle2D -java/awt/geom/RectangularShape -java/awt/Shape -java/awt/geom/GeneralPath -java/awt/geom/Path2D$Float -java/awt/geom/Path2D -sun/font/CharToGlyphMapper -sun/font/PhysicalStrike -sun/font/FontStrike -sun/font/GlyphList -sun/font/StrikeCache -sun/java2d/Disposer -sun/java2d/Disposer$1 -sun/font/StrikeCache$1 -sun/awt/motif/MFontConfiguration -sun/awt/FontConfiguration -sun/awt/FontDescriptor -java/io/DataInputStream -java/io/DataInput -java/lang/Short$ShortCache -java/util/HashMap$KeyIterator -sun/font/CompositeFontDescriptor -sun/font/Font2DHandle -sun/font/FontFamily -java/awt/GraphicsDevice -sun/awt/X11GraphicsDevice -sun/awt/X11GraphicsConfig -java/awt/GraphicsConfiguration -java/awt/ImageCapabilities -sun/java2d/x11/X11SurfaceData -sun/java2d/SurfaceData -java/awt/Transparency -sun/java2d/DisposerTarget -sun/java2d/InvalidPipeException -java/lang/IllegalStateException -sun/java2d/NullSurfaceData -sun/java2d/loops/SurfaceType -sun/awt/image/PixelConverter -sun/awt/image/PixelConverter$Xrgb -sun/awt/image/PixelConverter$Argb -sun/awt/image/PixelConverter$ArgbPre -sun/awt/image/PixelConverter$Xbgr -sun/awt/image/PixelConverter$Rgba -sun/awt/image/PixelConverter$RgbaPre -sun/awt/image/PixelConverter$Ushort565Rgb -sun/awt/image/PixelConverter$Ushort555Rgb -sun/awt/image/PixelConverter$Ushort555Rgbx -sun/awt/image/PixelConverter$Ushort4444Argb -sun/awt/image/PixelConverter$ByteGray -sun/awt/image/PixelConverter$UshortGray -sun/awt/image/PixelConverter$Rgbx -sun/awt/image/PixelConverter$Bgrx -sun/awt/image/PixelConverter$ArgbBm -java/awt/image/ColorModel -java/awt/image/DirectColorModel -java/awt/image/PackedColorModel -java/awt/color/ColorSpace -java/awt/color/ICC_Profile -java/awt/color/ICC_ProfileRGB -java/awt/color/ICC_Profile$1 -java/awt/color/ICC_ColorSpace -sun/java2d/pipe/NullPipe -sun/java2d/pipe/PixelDrawPipe -sun/java2d/pipe/PixelFillPipe -sun/java2d/pipe/ShapeDrawPipe -sun/java2d/pipe/TextPipe -sun/java2d/pipe/DrawImagePipe -java/awt/image/IndexColorModel -sun/java2d/pipe/LoopPipe -sun/java2d/pipe/OutlineTextRenderer -sun/java2d/pipe/SolidTextRenderer -sun/java2d/pipe/GlyphListLoopPipe -sun/java2d/pipe/GlyphListPipe -sun/java2d/pipe/AATextRenderer -sun/java2d/pipe/LCDTextRenderer -sun/java2d/pipe/AlphaColorPipe -sun/java2d/pipe/CompositePipe -sun/java2d/pipe/PixelToShapeConverter -sun/java2d/pipe/TextRenderer -sun/java2d/pipe/SpanClipRenderer -sun/java2d/pipe/Region -sun/java2d/pipe/RegionIterator -sun/java2d/pipe/AlphaPaintPipe -sun/java2d/pipe/SpanShapeRenderer$Composite -sun/java2d/pipe/SpanShapeRenderer -sun/java2d/pipe/GeneralCompositePipe -sun/java2d/pipe/DrawImage -sun/java2d/loops/RenderCache -sun/java2d/loops/RenderCache$Entry -sun/java2d/loops/XORComposite -java/awt/Composite -sun/font/X11TextRenderer -sun/java2d/loops/GraphicsPrimitive -sun/java2d/x11/X11PMBlitLoops -sun/java2d/loops/Blit -sun/java2d/loops/GraphicsPrimitiveMgr -sun/java2d/loops/CompositeType -sun/java2d/SunGraphics2D -sun/awt/ConstrainableGraphics -java/awt/Graphics2D -java/awt/Graphics -java/awt/Color -java/awt/Paint -java/awt/AlphaComposite -sun/java2d/loops/BlitBg -sun/java2d/loops/ScaledBlit -sun/java2d/loops/FillRect -sun/java2d/loops/FillSpans -sun/java2d/loops/DrawLine -sun/java2d/loops/DrawRect -sun/java2d/loops/DrawPolygons -sun/java2d/loops/DrawPath -sun/java2d/loops/FillPath -sun/java2d/loops/MaskBlit -sun/java2d/loops/MaskFill -sun/java2d/loops/DrawGlyphList -sun/java2d/loops/DrawGlyphListAA -sun/java2d/loops/DrawGlyphListLCD -sun/java2d/loops/TransformHelper -java/awt/BasicStroke -java/awt/Stroke -sun/misc/PerformanceLogger -sun/misc/PerformanceLogger$TimeData -sun/java2d/pipe/ValidatePipe -sun/java2d/loops/CustomComponent -sun/java2d/loops/GraphicsPrimitiveProxy -sun/java2d/loops/GeneralRenderer -sun/java2d/loops/GraphicsPrimitiveMgr$1 -sun/java2d/loops/GraphicsPrimitiveMgr$2 -sun/java2d/x11/X11PMBlitLoops$DelegateBlitLoop -sun/java2d/x11/X11PMBlitBgLoops -sun/java2d/x11/X11SurfaceData$LazyPipe -sun/awt/X11GraphicsConfig$X11GCDisposerRecord -sun/java2d/DisposerRecord -java/awt/BorderLayout -java/awt/LayoutManager2 -java/awt/Rectangle -java/awt/Toolkit$2 -sun/awt/X11/XToolkit -sun/awt/X11/XConstants -sun/awt/UNIXToolkit -java/util/TreeMap -java/util/NavigableMap -java/util/SortedMap -sun/awt/X11/XlibWrapper -sun/awt/X11/XUtilConstants -sun/awt/X11/XProtocolConstants -sun/awt/X11/XCursorFontConstants -sun/awt/X11/XlibWrapper$1 -sun/awt/X11/XToolkit$4 -sun/awt/X11/XModifierKeymap -sun/awt/X11/XWrapperBase -sun/awt/X11/Native -sun/awt/X11/Native$1 -java/awt/EventQueue -java/util/EmptyStackException -java/lang/reflect/InvocationTargetException -java/awt/EventDispatchThread -java/awt/event/PaintEvent -java/awt/event/MouseEvent -sun/awt/PeerEvent -java/awt/event/InvocationEvent -java/awt/ActiveEvent -sun/awt/X11/XToolkit$1 -sun/awt/X11/XEventDispatcher -sun/awt/SunToolkit$ModalityListenerList -sun/awt/ModalityListener -sun/awt/SunToolkit$1 -java/util/MissingResourceException -java/awt/Queue -sun/awt/PostEventQueue -java/util/LinkedList -java/util/Deque -java/util/Queue -java/util/AbstractSequentialList -sun/awt/X11/AwtScreenData -sun/awt/X11/XWM -sun/awt/X11/MWMConstants -sun/awt/X11/XAtom -java/awt/Insets -sun/awt/X11/XWM$1 -sun/awt/X11/XSetWindowAttributes -sun/awt/X11/XErrorEvent -sun/awt/X11/XNETProtocol -sun/awt/X11/XStateProtocol -sun/awt/X11/XLayerProtocol -sun/awt/X11/XProtocol -java/lang/Long$LongCache -sun/awt/X11/WindowPropertyGetter -sun/awt/X11/UnsafeXDisposerRecord -sun/awt/X11/XPropertyCache -sun/awt/X11/XWINProtocol -sun/awt/X11/XAtomList -sun/awt/X11/XToolkit$3 -java/awt/Window$WindowDisposerRecord -sun/awt/X11/XAnyEvent -java/awt/KeyboardFocusManager -java/awt/KeyEventDispatcher -java/awt/KeyEventPostProcessor +java/awt/AWTEvent$1 +java/awt/AWTEventMulticaster java/awt/AWTKeyStroke java/awt/AWTKeyStroke$1 -java/awt/DefaultKeyboardFocusManager -java/awt/DefaultFocusTraversalPolicy +java/awt/ActiveEvent +java/awt/Adjustable +java/awt/AlphaComposite +java/awt/BasicStroke +java/awt/BorderLayout +java/awt/BufferCapabilities +java/awt/Canvas +java/awt/CardLayout +java/awt/CardLayout$Card +java/awt/Color +java/awt/Component +java/awt/Component$1 +java/awt/Component$3 +java/awt/Component$AWTTreeLock +java/awt/Component$AccessibleAWTComponent +java/awt/Component$BaselineResizeBehavior +java/awt/Component$BltBufferStrategy +java/awt/Component$BltSubRegionBufferStrategy +java/awt/Component$DummyRequestFocusController +java/awt/Component$FlipBufferStrategy +java/awt/ComponentOrientation +java/awt/Composite +java/awt/Conditional +java/awt/Container +java/awt/Container$1 +java/awt/Container$AccessibleAWTContainer java/awt/ContainerOrderFocusTraversalPolicy +java/awt/Cursor +java/awt/Cursor$1 +java/awt/DefaultFocusTraversalPolicy +java/awt/DefaultKeyboardFocusManager +java/awt/DefaultKeyboardFocusManager$1 +java/awt/DefaultKeyboardFocusManager$DefaultKeyboardFocusManagerSentEvent +java/awt/DefaultKeyboardFocusManager$TypeAheadMarker +java/awt/Dialog +java/awt/Dialog$ModalExclusionType +java/awt/Dialog$ModalityType +java/awt/Dimension +java/awt/Event +java/awt/EventDispatchThread +java/awt/EventDispatchThread$1 +java/awt/EventDispatchThread$HierarchyEventFilter +java/awt/EventFilter +java/awt/EventFilter$FilterAction +java/awt/EventQueue +java/awt/EventQueue$1 +java/awt/EventQueue$1AWTInvocationLock +java/awt/EventQueue$2 +java/awt/EventQueue$3 +java/awt/EventQueue$4 +java/awt/EventQueue$5 +java/awt/FlowLayout java/awt/FocusTraversalPolicy -java/util/Collections$UnmodifiableSet -sun/awt/HeadlessToolkit -sun/awt/X11/XKeyboardFocusManagerPeer -java/awt/peer/KeyboardFocusManagerPeer -sun/awt/X11/XKeyboardFocusManagerPeer$1 -sun/awt/X11/XFramePeer -java/awt/peer/FramePeer -java/awt/peer/WindowPeer -java/awt/peer/ContainerPeer -java/awt/peer/ComponentPeer -sun/awt/X11/XDecoratedPeer -sun/awt/X11/XWindowPeer -sun/awt/X11/XPanelPeer -java/awt/peer/PanelPeer -sun/awt/X11/XCanvasPeer -java/awt/peer/CanvasPeer -sun/awt/X11/XComponentPeer -java/awt/dnd/peer/DropTargetPeer -sun/awt/X11/XWindow -sun/awt/X11ComponentPeer -sun/awt/X11/XBaseWindow -sun/awt/X11/XCreateWindowParams -sun/awt/X11/XBaseWindow$InitialiseState -sun/awt/X11/XBaseWindow$StateLock -sun/awt/X11/AwtGraphicsConfigData -sun/awt/X11/XVisualInfo -java/awt/SystemColor -sun/awt/X11/MotifColorUtilities -java/util/concurrent/locks/LockSupport -sun/nio/ch/Interruptible -java/lang/StringIndexOutOfBoundsException -java/lang/IndexOutOfBoundsException -java/lang/StrictMath -sun/awt/X11/XRepaintArea -sun/awt/RepaintArea -sun/awt/X11/XWindowAttributesData -sun/awt/X11/WindowDimensions +java/awt/Font +java/awt/Font$FontAccessImpl +java/awt/FontFormatException +java/awt/FontMetrics +java/awt/Frame +java/awt/Frame$1 +java/awt/Graphics +java/awt/Graphics2D +java/awt/GraphicsCallback +java/awt/GraphicsCallback$PaintCallback +java/awt/GraphicsConfiguration +java/awt/GraphicsDevice +java/awt/GraphicsEnvironment +java/awt/GraphicsEnvironment$1 +java/awt/GridLayout +java/awt/Image +java/awt/Image$1 +java/awt/ImageCapabilities +java/awt/ImageMediaEntry +java/awt/Insets +java/awt/ItemSelectable +java/awt/KeyEventDispatcher +java/awt/KeyEventPostProcessor +java/awt/KeyboardFocusManager +java/awt/KeyboardFocusManager$1 +java/awt/KeyboardFocusManager$3 +java/awt/KeyboardFocusManager$HeavyweightFocusRequest +java/awt/KeyboardFocusManager$LightweightFocusRequest +java/awt/Label +java/awt/LayoutManager +java/awt/LayoutManager2 +java/awt/LightweightDispatcher +java/awt/LightweightDispatcher$2 +java/awt/MediaEntry +java/awt/MediaTracker +java/awt/MenuBar +java/awt/MenuComponent +java/awt/MenuContainer +java/awt/ModalEventFilter +java/awt/Paint +java/awt/Panel java/awt/Point -java/util/TreeMap$Entry -sun/awt/X11/XRootWindow -sun/nio/cs/ISO_8859_1 -sun/nio/cs/ISO_8859_1$Encoder -sun/nio/cs/ISO_8859_1$Decoder -sun/awt/X11/XPropertyEvent -sun/awt/X11/XDropTargetEventProcessor -sun/awt/X11/XDragSourceContextPeer -sun/awt/X11/XDragSourceProtocolListener -sun/awt/dnd/SunDragSourceContextPeer -java/awt/dnd/peer/DragSourceContextPeer -sun/awt/X11/XAwtState -sun/awt/X11/XBaseWindow$1 -sun/java2d/x11/X11SurfaceData$X11WindowSurfaceData -sun/java2d/loops/RenderLoops -sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec -sun/java2d/DefaultDisposerRecord -sun/java2d/x11/X11Renderer -sun/awt/X11/XGlobalCursorManager -sun/awt/GlobalCursorManager -java/awt/Cursor$CursorDisposer -java/awt/AWTException -java/awt/HeadlessException -java/lang/UnsupportedOperationException -sun/reflect/UnsafeLongFieldAccessorImpl -sun/reflect/UnsafeIntegerFieldAccessorImpl -sun/awt/X11/XClientMessageEvent -sun/awt/X11/XIconInfo -sun/awt/X11/XAWTIcon32_java_icon16_png -sun/awt/X11/XAWTIcon32_java_icon24_png -sun/awt/X11/XAWTIcon32_java_icon32_png -sun/awt/X11/XAWTIcon32_java_icon48_png -sun/awt/X11/XSizeHints -sun/awt/X11/XContentWindow -sun/awt/X11/XFocusProxyWindow -sun/awt/X11/XWMHints -java/util/LinkedList$ListItr -java/util/ListIterator -sun/awt/SunToolkit$2 -java/awt/image/BufferStrategy +java/awt/PrintGraphics +java/awt/Queue +java/awt/Rectangle +java/awt/RenderingHints +java/awt/RenderingHints$Key +java/awt/SentEvent +java/awt/SequencedEvent +java/awt/SequencedEvent$1 +java/awt/Shape +java/awt/SplashScreen +java/awt/Stroke +java/awt/SystemColor +java/awt/Toolkit +java/awt/Toolkit$1 +java/awt/Toolkit$2 +java/awt/Toolkit$3 +java/awt/Toolkit$4 +java/awt/Toolkit$5 +java/awt/Toolkit$DesktopPropertyChangeSupport +java/awt/Toolkit$DesktopPropertyChangeSupport$1 +java/awt/Toolkit$SelectiveAWTEventListener +java/awt/Toolkit$ToolkitEventMulticaster +java/awt/Transparency +java/awt/TrayIcon +java/awt/VKCollection +java/awt/Window +java/awt/Window$1 +java/awt/Window$1DisposeAction +java/awt/Window$Type +java/awt/Window$WindowDisposerRecord +java/awt/color/ColorSpace +java/awt/color/ICC_ColorSpace +java/awt/color/ICC_Profile +java/awt/color/ICC_Profile$1 +java/awt/color/ICC_ProfileRGB +java/awt/datatransfer/Clipboard +java/awt/datatransfer/ClipboardOwner +java/awt/datatransfer/FlavorMap +java/awt/datatransfer/FlavorTable +java/awt/datatransfer/SystemFlavorMap +java/awt/datatransfer/Transferable java/awt/dnd/DropTarget +java/awt/dnd/DropTargetContext java/awt/dnd/DropTargetListener +java/awt/dnd/peer/DragSourceContextPeer +java/awt/dnd/peer/DropTargetContextPeer +java/awt/dnd/peer/DropTargetPeer +java/awt/event/AWTEventListener +java/awt/event/AWTEventListenerProxy +java/awt/event/ActionEvent +java/awt/event/ActionListener +java/awt/event/AdjustmentEvent +java/awt/event/AdjustmentListener +java/awt/event/ComponentAdapter +java/awt/event/ComponentEvent java/awt/event/ComponentListener +java/awt/event/ContainerEvent +java/awt/event/ContainerListener +java/awt/event/FocusAdapter +java/awt/event/FocusEvent java/awt/event/FocusListener -java/awt/event/HierarchyListener java/awt/event/HierarchyBoundsListener +java/awt/event/HierarchyListener +java/awt/event/InputEvent +java/awt/event/InputEvent$1 +java/awt/event/InputMethodEvent +java/awt/event/InputMethodListener +java/awt/event/InvocationEvent +java/awt/event/InvocationEvent$1 +java/awt/event/ItemEvent +java/awt/event/ItemListener +java/awt/event/KeyAdapter +java/awt/event/KeyEvent +java/awt/event/KeyEvent$1 java/awt/event/KeyListener +java/awt/event/MouseAdapter +java/awt/event/MouseEvent java/awt/event/MouseListener +java/awt/event/MouseMotionAdapter java/awt/event/MouseMotionListener java/awt/event/MouseWheelListener -java/awt/event/InputMethodListener -java/awt/event/ContainerListener -javax/accessibility/AccessibleContext -sun/reflect/UnsafeObjectFieldAccessorImpl -java/awt/peer/LightweightPeer -sun/awt/X11/XLabelPeer +java/awt/event/NativeLibLoader +java/awt/event/NativeLibLoader$1 +java/awt/event/PaintEvent +java/awt/event/TextListener +java/awt/event/WindowAdapter +java/awt/event/WindowEvent +java/awt/event/WindowFocusListener +java/awt/event/WindowListener +java/awt/event/WindowStateListener +java/awt/font/FontRenderContext +java/awt/font/GlyphVector +java/awt/font/LineMetrics +java/awt/font/TextAttribute +java/awt/geom/AffineTransform +java/awt/geom/Dimension2D +java/awt/geom/GeneralPath +java/awt/geom/Path2D +java/awt/geom/Path2D$Float +java/awt/geom/Path2D$Float$CopyIterator +java/awt/geom/Path2D$Iterator +java/awt/geom/PathIterator +java/awt/geom/Point2D +java/awt/geom/Point2D$Float +java/awt/geom/RectIterator +java/awt/geom/Rectangle2D +java/awt/geom/Rectangle2D$Float +java/awt/geom/RectangularShape +java/awt/im/InputContext +java/awt/im/InputMethodRequests +java/awt/im/spi/InputMethod +java/awt/im/spi/InputMethodContext +java/awt/im/spi/InputMethodDescriptor +java/awt/image/BufferStrategy +java/awt/image/BufferedImage +java/awt/image/BufferedImage$1 +java/awt/image/ColorModel +java/awt/image/ColorModel$1 +java/awt/image/ComponentSampleModel +java/awt/image/DataBuffer +java/awt/image/DataBuffer$1 +java/awt/image/DataBufferByte +java/awt/image/DataBufferInt +java/awt/image/DirectColorModel +java/awt/image/FilteredImageSource +java/awt/image/ImageConsumer +java/awt/image/ImageFilter +java/awt/image/ImageObserver +java/awt/image/ImageProducer +java/awt/image/IndexColorModel +java/awt/image/PackedColorModel +java/awt/image/PixelInterleavedSampleModel +java/awt/image/RGBImageFilter +java/awt/image/Raster +java/awt/image/RenderedImage +java/awt/image/SampleModel +java/awt/image/SinglePixelPackedSampleModel +java/awt/image/VolatileImage +java/awt/image/WritableRaster +java/awt/image/WritableRenderedImage +java/awt/peer/CanvasPeer +java/awt/peer/ComponentPeer +java/awt/peer/ContainerPeer +java/awt/peer/FramePeer +java/awt/peer/KeyboardFocusManagerPeer java/awt/peer/LabelPeer -sun/awt/X11/XQueryTree -sun/awt/X11/XMapEvent -sun/awt/X11/XConfigureEvent -sun/awt/X11/PropMwmHints -sun/awt/GlobalCursorManager$NativeUpdater -javax/swing/JFrame -javax/swing/WindowConstants -javax/swing/RootPaneContainer -javax/swing/TransferHandler$HasGetTransferHandler -javax/swing/JLabel -javax/swing/SwingConstants -javax/swing/JComponent -javax/swing/JComponent$1 -javax/swing/SwingUtilities -javax/swing/JRootPane -sun/security/action/GetBooleanAction -javax/swing/event/EventListenerList -javax/swing/JPanel -java/awt/FlowLayout -javax/swing/UIManager -javax/swing/UIManager$LookAndFeelInfo -sun/swing/SwingUtilities2 -sun/swing/SwingUtilities2$LSBCacheEntry -javax/swing/UIManager$LAFState -javax/swing/UIDefaults -javax/swing/MultiUIDefaults -javax/swing/UIManager$1 -javax/swing/plaf/metal/MetalLookAndFeel -javax/swing/plaf/basic/BasicLookAndFeel -javax/swing/LookAndFeel -sun/swing/DefaultLookup -javax/swing/plaf/metal/OceanTheme -javax/swing/plaf/metal/DefaultMetalTheme -javax/swing/plaf/metal/MetalTheme -javax/swing/plaf/ColorUIResource -javax/swing/plaf/UIResource -sun/swing/PrintColorUIResource -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate -javax/swing/plaf/FontUIResource -sun/swing/SwingLazyValue -javax/swing/UIDefaults$LazyValue -javax/swing/UIDefaults$ActiveValue -javax/swing/plaf/InsetsUIResource -sun/swing/SwingUtilities2$2 -javax/swing/plaf/basic/BasicLookAndFeel$2 -javax/swing/plaf/DimensionUIResource -javax/swing/UIDefaults$LazyInputMap -java/lang/Character$CharacterCache -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue -javax/swing/plaf/metal/MetalLookAndFeel$FontActiveValue -java/awt/print/PrinterJob -sun/swing/SwingUtilities2$AATextInfo -sun/awt/X11/XAWTXSettings -sun/awt/X11/XMSelectionListener -sun/awt/XSettings -sun/awt/X11/XMSelection -sun/awt/X11/XMSelection$1 -sun/awt/X11/XMSelection$3 -sun/awt/XSettings$Update -java/util/HashMap$EntrySet -java/util/HashMap$EntryIterator -javax/swing/plaf/metal/MetalLookAndFeel$AATextListener +java/awt/peer/LightweightPeer +java/awt/peer/PanelPeer +java/awt/peer/SystemTrayPeer +java/awt/peer/WindowPeer +java/awt/print/PrinterGraphics +java/beans/ChangeListenerMap +java/beans/PropertyChangeEvent java/beans/PropertyChangeListener java/beans/PropertyChangeListenerProxy +java/beans/PropertyChangeSupport +java/beans/PropertyChangeSupport$PropertyChangeListenerMap +java/beans/VetoableChangeListener +java/io/Bits +java/io/BufferedInputStream +java/io/BufferedOutputStream +java/io/BufferedReader +java/io/BufferedWriter +java/io/ByteArrayInputStream +java/io/ByteArrayOutputStream +java/io/Closeable +java/io/DataInput +java/io/DataInputStream +java/io/DataOutput +java/io/DataOutputStream +java/io/DefaultFileSystem +java/io/EOFException +java/io/ExpiringCache +java/io/ExpiringCache$1 +java/io/ExpiringCache$Entry +java/io/Externalizable +java/io/File +java/io/File$PathStatus +java/io/FileDescriptor +java/io/FileDescriptor$1 +java/io/FileInputStream +java/io/FileInputStream$1 +java/io/FileNotFoundException +java/io/FileOutputStream +java/io/FileOutputStream$1 +java/io/FilePermission +java/io/FilePermission$1 +java/io/FilePermissionCollection +java/io/FileReader +java/io/FileSystem +java/io/FileWriter +java/io/FilenameFilter +java/io/FilterInputStream +java/io/FilterOutputStream +java/io/FilterReader +java/io/Flushable +java/io/IOException +java/io/InputStream +java/io/InputStreamReader +java/io/InterruptedIOException +java/io/NotSerializableException +java/io/ObjectInput +java/io/ObjectInputStream +java/io/ObjectInputStream$BlockDataInputStream +java/io/ObjectInputStream$GetField +java/io/ObjectInputStream$GetFieldImpl +java/io/ObjectInputStream$HandleTable +java/io/ObjectInputStream$HandleTable$HandleList +java/io/ObjectInputStream$PeekInputStream +java/io/ObjectInputStream$ValidationList +java/io/ObjectOutput +java/io/ObjectOutputStream +java/io/ObjectOutputStream$BlockDataOutputStream +java/io/ObjectOutputStream$HandleTable +java/io/ObjectOutputStream$ReplaceTable +java/io/ObjectStreamClass +java/io/ObjectStreamClass$1 +java/io/ObjectStreamClass$2 +java/io/ObjectStreamClass$3 +java/io/ObjectStreamClass$4 +java/io/ObjectStreamClass$5 +java/io/ObjectStreamClass$Caches +java/io/ObjectStreamClass$ClassDataSlot +java/io/ObjectStreamClass$EntryFuture +java/io/ObjectStreamClass$ExceptionInfo +java/io/ObjectStreamClass$FieldReflector +java/io/ObjectStreamClass$FieldReflectorKey +java/io/ObjectStreamClass$MemberSignature +java/io/ObjectStreamClass$WeakClassKey +java/io/ObjectStreamConstants +java/io/ObjectStreamException +java/io/ObjectStreamField +java/io/OutputStream +java/io/OutputStreamWriter +java/io/PrintStream +java/io/PushbackInputStream +java/io/RandomAccessFile +java/io/RandomAccessFile$1 +java/io/Reader +java/io/SerialCallbackContext +java/io/Serializable +java/io/StreamTokenizer +java/io/StringReader +java/io/StringWriter +java/io/UnixFileSystem +java/io/UnsupportedEncodingException +java/io/Writer +java/lang/AbstractStringBuilder +java/lang/Appendable +java/lang/ApplicationShutdownHooks +java/lang/ApplicationShutdownHooks$1 +java/lang/ArithmeticException +java/lang/ArrayIndexOutOfBoundsException +java/lang/ArrayStoreException +java/lang/AssertionError +java/lang/AutoCloseable +java/lang/Boolean +java/lang/BootstrapMethodError +java/lang/Byte +java/lang/CharSequence +java/lang/Character +java/lang/Character$CharacterCache +java/lang/CharacterData +java/lang/CharacterData00 +java/lang/CharacterDataLatin1 +java/lang/Class +java/lang/Class$1 +java/lang/Class$3 +java/lang/Class$4 +java/lang/Class$AnnotationData +java/lang/Class$Atomic +java/lang/Class$ReflectionData +java/lang/ClassCastException +java/lang/ClassFormatError +java/lang/ClassLoader +java/lang/ClassLoader$2 +java/lang/ClassLoader$3 +java/lang/ClassLoader$NativeLibrary +java/lang/ClassLoader$ParallelLoaders +java/lang/ClassLoaderHelper +java/lang/ClassNotFoundException +java/lang/ClassValue$ClassValueMap +java/lang/CloneNotSupportedException +java/lang/Cloneable +java/lang/Comparable +java/lang/Compiler +java/lang/Compiler$1 +java/lang/Double +java/lang/Enum +java/lang/Error +java/lang/Exception +java/lang/ExceptionInInitializerError +java/lang/Float +java/lang/IllegalAccessError +java/lang/IllegalAccessException +java/lang/IllegalArgumentException +java/lang/IllegalMonitorStateException +java/lang/IllegalStateException +java/lang/IncompatibleClassChangeError +java/lang/IndexOutOfBoundsException +java/lang/InheritableThreadLocal +java/lang/InstantiationException +java/lang/Integer +java/lang/Integer$IntegerCache +java/lang/InternalError +java/lang/InterruptedException +java/lang/Iterable +java/lang/LinkageError +java/lang/Long +java/lang/Long$LongCache +java/lang/Math +java/lang/NoClassDefFoundError +java/lang/NoSuchFieldException +java/lang/NoSuchMethodError +java/lang/NoSuchMethodException +java/lang/NullPointerException +java/lang/Number +java/lang/NumberFormatException +java/lang/Object +java/lang/OutOfMemoryError +java/lang/Package +java/lang/Process +java/lang/ProcessBuilder +java/lang/ProcessEnvironment +java/lang/ProcessEnvironment$ExternalData +java/lang/ProcessEnvironment$StringEnvironment +java/lang/ProcessEnvironment$Value +java/lang/ProcessEnvironment$Variable +java/lang/ProcessImpl +java/lang/Readable +java/lang/ReflectiveOperationException +java/lang/Runnable +java/lang/Runtime +java/lang/RuntimeException +java/lang/RuntimePermission +java/lang/SecurityException +java/lang/SecurityManager +java/lang/Short +java/lang/Short$ShortCache +java/lang/Shutdown +java/lang/Shutdown$Lock +java/lang/StackOverflowError +java/lang/StackTraceElement +java/lang/StrictMath +java/lang/String +java/lang/String$CaseInsensitiveComparator +java/lang/StringBuffer +java/lang/StringBuilder +java/lang/StringCoding +java/lang/StringCoding$StringDecoder +java/lang/StringCoding$StringEncoder +java/lang/StringIndexOutOfBoundsException +java/lang/System +java/lang/System$2 +java/lang/SystemClassLoaderAction +java/lang/Terminator +java/lang/Terminator$1 +java/lang/Thread +java/lang/Thread$State +java/lang/Thread$UncaughtExceptionHandler +java/lang/ThreadDeath +java/lang/ThreadGroup +java/lang/ThreadLocal +java/lang/ThreadLocal$ThreadLocalMap +java/lang/ThreadLocal$ThreadLocalMap$Entry +java/lang/Throwable +java/lang/Throwable$PrintStreamOrWriter +java/lang/Throwable$WrappedPrintStream +java/lang/UNIXProcess +java/lang/UNIXProcess$1 +java/lang/UNIXProcess$2 +java/lang/UNIXProcess$3 +java/lang/UNIXProcess$3$1 +java/lang/UNIXProcess$DeferredCloseInputStream +java/lang/UNIXProcess$LaunchMechanism +java/lang/UnsatisfiedLinkError +java/lang/UnsupportedOperationException +java/lang/VirtualMachineError +java/lang/Void +java/lang/annotation/Annotation +java/lang/invoke/CallSite +java/lang/invoke/ConstantCallSite +java/lang/invoke/DirectMethodHandle +java/lang/invoke/Invokers +java/lang/invoke/LambdaForm +java/lang/invoke/LambdaForm$NamedFunction +java/lang/invoke/MemberName +java/lang/invoke/MemberName$Factory +java/lang/invoke/MethodHandle +java/lang/invoke/MethodHandleImpl +java/lang/invoke/MethodHandleNatives +java/lang/invoke/MethodHandleStatics +java/lang/invoke/MethodHandleStatics$1 +java/lang/invoke/MethodType +java/lang/invoke/MethodType$ConcurrentWeakInternSet +java/lang/invoke/MethodType$ConcurrentWeakInternSet$WeakEntry +java/lang/invoke/MethodTypeForm +java/lang/invoke/MutableCallSite +java/lang/invoke/VolatileCallSite +java/lang/ref/FinalReference +java/lang/ref/Finalizer +java/lang/ref/Finalizer$FinalizerThread +java/lang/ref/PhantomReference +java/lang/ref/Reference +java/lang/ref/Reference$Lock +java/lang/ref/Reference$ReferenceHandler +java/lang/ref/ReferenceQueue +java/lang/ref/ReferenceQueue$Lock +java/lang/ref/ReferenceQueue$Null +java/lang/ref/SoftReference +java/lang/ref/WeakReference +java/lang/reflect/AccessibleObject +java/lang/reflect/AnnotatedElement +java/lang/reflect/Array +java/lang/reflect/Constructor +java/lang/reflect/Executable +java/lang/reflect/Field +java/lang/reflect/GenericDeclaration +java/lang/reflect/InvocationHandler +java/lang/reflect/InvocationTargetException +java/lang/reflect/Member +java/lang/reflect/Method +java/lang/reflect/Modifier +java/lang/reflect/Parameter +java/lang/reflect/Proxy +java/lang/reflect/Proxy$KeyFactory +java/lang/reflect/Proxy$ProxyClassFactory +java/lang/reflect/ReflectAccess +java/lang/reflect/ReflectPermission +java/lang/reflect/Type +java/lang/reflect/WeakCache +java/math/BigInteger +java/math/BigInteger$UnsafeHolder +java/math/MutableBigInteger +java/math/RoundingMode +java/net/AbstractPlainDatagramSocketImpl +java/net/AbstractPlainDatagramSocketImpl$1 +java/net/AbstractPlainSocketImpl +java/net/AbstractPlainSocketImpl$1 +java/net/Authenticator +java/net/BindException +java/net/ConnectException +java/net/DatagramPacket +java/net/DatagramPacket$1 +java/net/DatagramSocket +java/net/DatagramSocket$1 +java/net/DatagramSocketImpl +java/net/DefaultDatagramSocketImplFactory +java/net/DefaultInterface +java/net/FileNameMap +java/net/HttpURLConnection +java/net/Inet4Address +java/net/Inet4AddressImpl +java/net/Inet6Address +java/net/Inet6Address$Inet6AddressHolder +java/net/Inet6AddressImpl +java/net/InetAddress +java/net/InetAddress$1 +java/net/InetAddress$2 +java/net/InetAddress$Cache +java/net/InetAddress$Cache$Type +java/net/InetAddress$CacheEntry +java/net/InetAddress$InetAddressHolder +java/net/InetAddressImpl +java/net/InetAddressImplFactory +java/net/InetSocketAddress +java/net/InetSocketAddress$InetSocketAddressHolder +java/net/InterfaceAddress +java/net/JarURLConnection +java/net/MalformedURLException +java/net/MulticastSocket +java/net/NetworkInterface +java/net/NetworkInterface$1 +java/net/NetworkInterface$2 +java/net/NoRouteToHostException +java/net/Parts +java/net/PlainDatagramSocketImpl +java/net/PlainSocketImpl +java/net/Proxy +java/net/Proxy$Type +java/net/ProxySelector +java/net/ServerSocket +java/net/Socket +java/net/SocketAddress +java/net/SocketException +java/net/SocketImpl +java/net/SocketImplFactory +java/net/SocketOptions +java/net/SocksConsts +java/net/SocksSocketImpl +java/net/SocksSocketImpl$3 +java/net/URI +java/net/URI$Parser +java/net/URL +java/net/URLClassLoader +java/net/URLClassLoader$1 +java/net/URLClassLoader$2 +java/net/URLClassLoader$3 +java/net/URLClassLoader$3$1 +java/net/URLClassLoader$7 +java/net/URLConnection +java/net/URLConnection$1 +java/net/URLStreamHandler +java/net/URLStreamHandlerFactory +java/net/UnknownHostException +java/nio/Bits +java/nio/Bits$1 +java/nio/Buffer +java/nio/BufferUnderflowException +java/nio/ByteBuffer +java/nio/ByteBufferAsIntBufferB +java/nio/ByteBufferAsShortBufferB +java/nio/ByteOrder +java/nio/CharBuffer +java/nio/DirectByteBuffer +java/nio/DirectByteBuffer$Deallocator +java/nio/DirectByteBufferR +java/nio/DirectLongBufferU +java/nio/HeapByteBuffer +java/nio/HeapCharBuffer +java/nio/IntBuffer +java/nio/LongBuffer +java/nio/MappedByteBuffer +java/nio/ShortBuffer +java/nio/channels/ByteChannel +java/nio/channels/Channel +java/nio/channels/FileChannel +java/nio/channels/FileChannel$MapMode +java/nio/channels/GatheringByteChannel +java/nio/channels/InterruptibleChannel +java/nio/channels/NetworkChannel +java/nio/channels/ReadableByteChannel +java/nio/channels/ScatteringByteChannel +java/nio/channels/SeekableByteChannel +java/nio/channels/SelectableChannel +java/nio/channels/SocketChannel +java/nio/channels/WritableByteChannel +java/nio/channels/spi/AbstractInterruptibleChannel +java/nio/channels/spi/AbstractInterruptibleChannel$1 +java/nio/channels/spi/AbstractSelectableChannel +java/nio/charset/Charset +java/nio/charset/Charset$ExtendedProviderHolder +java/nio/charset/Charset$ExtendedProviderHolder$1 +java/nio/charset/CharsetDecoder +java/nio/charset/CharsetEncoder +java/nio/charset/CoderResult +java/nio/charset/CoderResult$1 +java/nio/charset/CoderResult$2 +java/nio/charset/CoderResult$Cache +java/nio/charset/CodingErrorAction +java/nio/charset/StandardCharsets +java/nio/charset/spi/CharsetProvider +java/nio/file/Path +java/nio/file/Watchable +java/nio/file/attribute/FileAttribute +java/security/AccessControlContext +java/security/AccessControlException +java/security/AccessController +java/security/AlgorithmParameters +java/security/AlgorithmParametersSpi +java/security/AllPermission +java/security/AllPermissionCollection +java/security/AuthProvider +java/security/BasicPermission +java/security/BasicPermissionCollection +java/security/CodeSigner +java/security/CodeSource +java/security/DigestException +java/security/GeneralSecurityException +java/security/Guard +java/security/InvalidAlgorithmParameterException +java/security/InvalidKeyException +java/security/InvalidParameterException +java/security/Key +java/security/KeyException +java/security/KeyFactory +java/security/KeyFactorySpi +java/security/MessageDigest +java/security/MessageDigest$Delegate +java/security/MessageDigestSpi +java/security/NoSuchAlgorithmException +java/security/Permission +java/security/PermissionCollection +java/security/Permissions +java/security/Principal +java/security/PrivateKey +java/security/PrivilegedAction +java/security/PrivilegedActionException +java/security/PrivilegedExceptionAction +java/security/ProtectionDomain +java/security/ProtectionDomain$1 +java/security/ProtectionDomain$3 +java/security/ProtectionDomain$Key +java/security/Provider +java/security/Provider$EngineDescription +java/security/Provider$Service +java/security/Provider$ServiceKey +java/security/Provider$UString +java/security/ProviderException +java/security/PublicKey +java/security/SecureClassLoader +java/security/SecureRandomSpi +java/security/Security +java/security/Security$1 +java/security/SecurityPermission +java/security/Signature +java/security/Signature$Delegate +java/security/SignatureException +java/security/SignatureSpi +java/security/UnresolvedPermission +java/security/cert/CertPath +java/security/cert/Certificate +java/security/cert/CertificateFactory +java/security/cert/CertificateFactorySpi +java/security/cert/Extension +java/security/cert/X509Certificate +java/security/cert/X509Extension +java/security/interfaces/DSAKey +java/security/interfaces/DSAParams +java/security/interfaces/DSAPrivateKey +java/security/interfaces/DSAPublicKey +java/security/interfaces/RSAKey +java/security/interfaces/RSAPrivateCrtKey +java/security/interfaces/RSAPrivateKey +java/security/interfaces/RSAPublicKey +java/security/spec/AlgorithmParameterSpec +java/security/spec/DSAParameterSpec +java/security/spec/DSAPublicKeySpec +java/security/spec/EncodedKeySpec +java/security/spec/InvalidKeySpecException +java/security/spec/KeySpec +java/security/spec/PKCS8EncodedKeySpec +java/security/spec/RSAPrivateCrtKeySpec +java/security/spec/RSAPrivateKeySpec +java/security/spec/RSAPublicKeySpec +java/security/spec/X509EncodedKeySpec +java/text/AttributedCharacterIterator$Attribute +java/text/CharacterIterator +java/text/Collator +java/text/DateFormat +java/text/DateFormat$Field +java/text/DateFormatSymbols +java/text/DecimalFormat +java/text/DecimalFormatSymbols +java/text/DigitList +java/text/DontCareFieldPosition +java/text/DontCareFieldPosition$1 +java/text/EntryPair +java/text/FieldPosition +java/text/Format +java/text/Format$Field +java/text/Format$FieldDelegate +java/text/MergeCollation +java/text/MessageFormat +java/text/MessageFormat$Field +java/text/Normalizer +java/text/Normalizer$Form +java/text/NumberFormat +java/text/NumberFormat$Field +java/text/ParseException +java/text/PatternEntry +java/text/PatternEntry$Parser +java/text/RBCollationTables +java/text/RBCollationTables$BuildAPI +java/text/RBTableBuilder +java/text/RuleBasedCollator +java/text/SimpleDateFormat +java/text/spi/BreakIteratorProvider +java/text/spi/CollatorProvider +java/text/spi/DateFormatProvider +java/text/spi/DateFormatSymbolsProvider +java/text/spi/DecimalFormatSymbolsProvider +java/text/spi/NumberFormatProvider +java/util/AbstractCollection +java/util/AbstractList +java/util/AbstractList$Itr +java/util/AbstractList$ListItr +java/util/AbstractMap +java/util/AbstractQueue +java/util/AbstractSequentialList +java/util/AbstractSet +java/util/ArrayDeque +java/util/ArrayList +java/util/ArrayList$1 +java/util/ArrayList$Itr +java/util/ArrayList$ListItr +java/util/ArrayList$SubList +java/util/ArrayList$SubList$1 +java/util/Arrays +java/util/Arrays$ArrayList +java/util/Arrays$LegacyMergeSort +java/util/Base64 +java/util/Base64$Decoder +java/util/Base64$Encoder +java/util/BitSet +java/util/Calendar +java/util/Calendar$Builder +java/util/Collection +java/util/Collections +java/util/Collections$3 +java/util/Collections$EmptyEnumeration +java/util/Collections$EmptyIterator +java/util/Collections$EmptyList +java/util/Collections$EmptyMap +java/util/Collections$EmptySet +java/util/Collections$SetFromMap +java/util/Collections$SynchronizedCollection +java/util/Collections$SynchronizedMap +java/util/Collections$SynchronizedSet +java/util/Collections$SynchronizedSortedSet +java/util/Collections$UnmodifiableCollection +java/util/Collections$UnmodifiableCollection$1 +java/util/Collections$UnmodifiableList +java/util/Collections$UnmodifiableList$1 +java/util/Collections$UnmodifiableMap +java/util/Collections$UnmodifiableRandomAccessList +java/util/Collections$UnmodifiableSet +java/util/ComparableTimSort +java/util/Comparator +java/util/Currency +java/util/Currency$1 +java/util/Currency$CurrencyNameGetter +java/util/Date +java/util/Deque +java/util/Dictionary +java/util/Enumeration +java/util/EventListener java/util/EventListenerProxy -sun/awt/EventListenerAggregate -javax/swing/UIDefaults$ProxyLazyValue +java/util/EventObject +java/util/GregorianCalendar +java/util/HashMap +java/util/HashMap$EntryIterator +java/util/HashMap$EntrySet +java/util/HashMap$HashIterator +java/util/HashMap$KeyIterator +java/util/HashMap$KeySet +java/util/HashMap$Node +java/util/HashMap$TreeNode +java/util/HashMap$ValueIterator +java/util/HashMap$Values +java/util/HashSet +java/util/Hashtable +java/util/Hashtable$Entry +java/util/Hashtable$EntrySet +java/util/Hashtable$Enumerator +java/util/Hashtable$ValueCollection +java/util/IdentityHashMap +java/util/IdentityHashMap$IdentityHashMapIterator +java/util/IdentityHashMap$KeyIterator +java/util/IdentityHashMap$KeySet +java/util/IdentityHashMap$ValueIterator +java/util/IdentityHashMap$Values +java/util/Iterator +java/util/LinkedHashMap +java/util/LinkedHashMap$Entry +java/util/LinkedHashMap$LinkedEntryIterator +java/util/LinkedHashMap$LinkedEntrySet +java/util/LinkedHashMap$LinkedHashIterator +java/util/LinkedHashMap$LinkedKeyIterator +java/util/LinkedHashMap$LinkedKeySet +java/util/LinkedList +java/util/LinkedList$ListItr +java/util/LinkedList$Node +java/util/List +java/util/ListIterator +java/util/ListResourceBundle +java/util/Locale +java/util/Locale$1 +java/util/Locale$Cache +java/util/Locale$Category +java/util/Locale$LocaleKey +java/util/Map +java/util/Map$Entry +java/util/MissingResourceException +java/util/NavigableMap +java/util/NavigableSet +java/util/Objects +java/util/PriorityQueue +java/util/Properties +java/util/Properties$LineReader +java/util/PropertyResourceBundle +java/util/Queue +java/util/Random +java/util/RandomAccess +java/util/ResourceBundle +java/util/ResourceBundle$1 +java/util/ResourceBundle$BundleReference +java/util/ResourceBundle$CacheKey +java/util/ResourceBundle$CacheKeyReference +java/util/ResourceBundle$Control +java/util/ResourceBundle$Control$1 +java/util/ResourceBundle$Control$CandidateListCache +java/util/ResourceBundle$LoaderReference +java/util/ResourceBundle$RBClassLoader +java/util/ResourceBundle$RBClassLoader$1 +java/util/ResourceBundle$SingleFormatControl +java/util/ServiceLoader +java/util/ServiceLoader$1 +java/util/ServiceLoader$LazyIterator +java/util/Set +java/util/SortedMap +java/util/SortedSet +java/util/Stack +java/util/StringTokenizer +java/util/TimSort +java/util/TimeZone +java/util/TimeZone$1 +java/util/TreeMap +java/util/TreeMap$Entry +java/util/TreeSet +java/util/Vector +java/util/Vector$1 +java/util/Vector$Itr +java/util/Vector$ListItr +java/util/WeakHashMap +java/util/WeakHashMap$Entry +java/util/WeakHashMap$KeySet +java/util/concurrent/BlockingQueue +java/util/concurrent/ConcurrentHashMap +java/util/concurrent/ConcurrentHashMap$BaseIterator +java/util/concurrent/ConcurrentHashMap$CollectionView +java/util/concurrent/ConcurrentHashMap$CounterCell +java/util/concurrent/ConcurrentHashMap$EntrySetView +java/util/concurrent/ConcurrentHashMap$ForwardingNode +java/util/concurrent/ConcurrentHashMap$KeyIterator +java/util/concurrent/ConcurrentHashMap$KeySetView +java/util/concurrent/ConcurrentHashMap$Node +java/util/concurrent/ConcurrentHashMap$Segment +java/util/concurrent/ConcurrentHashMap$Traverser +java/util/concurrent/ConcurrentHashMap$ValueIterator +java/util/concurrent/ConcurrentHashMap$ValuesView +java/util/concurrent/ConcurrentMap +java/util/concurrent/ConcurrentNavigableMap +java/util/concurrent/ConcurrentSkipListMap +java/util/concurrent/ConcurrentSkipListMap$EntrySet +java/util/concurrent/ConcurrentSkipListMap$HeadIndex +java/util/concurrent/ConcurrentSkipListMap$Index +java/util/concurrent/ConcurrentSkipListMap$KeySet +java/util/concurrent/ConcurrentSkipListMap$Node +java/util/concurrent/ConcurrentSkipListMap$Values +java/util/concurrent/ConcurrentSkipListSet +java/util/concurrent/CopyOnWriteArrayList +java/util/concurrent/DelayQueue +java/util/concurrent/Delayed +java/util/concurrent/ThreadLocalRandom +java/util/concurrent/TimeUnit +java/util/concurrent/TimeUnit$1 +java/util/concurrent/TimeUnit$2 +java/util/concurrent/TimeUnit$3 +java/util/concurrent/TimeUnit$4 +java/util/concurrent/TimeUnit$5 +java/util/concurrent/TimeUnit$6 +java/util/concurrent/TimeUnit$7 +java/util/concurrent/atomic/AtomicBoolean +java/util/concurrent/atomic/AtomicInteger +java/util/concurrent/atomic/AtomicLong +java/util/concurrent/atomic/AtomicMarkableReference +java/util/concurrent/atomic/AtomicMarkableReference$Pair +java/util/concurrent/atomic/AtomicReferenceFieldUpdater +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl$1 +java/util/concurrent/locks/AbstractOwnableSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject +java/util/concurrent/locks/AbstractQueuedSynchronizer$Node +java/util/concurrent/locks/Condition +java/util/concurrent/locks/Lock +java/util/concurrent/locks/LockSupport +java/util/concurrent/locks/ReentrantLock +java/util/concurrent/locks/ReentrantLock$NonfairSync +java/util/concurrent/locks/ReentrantLock$Sync +java/util/function/BiFunction +java/util/jar/Attributes +java/util/jar/Attributes$Name +java/util/jar/JarEntry +java/util/jar/JarFile +java/util/jar/JarFile$JarEntryIterator +java/util/jar/JarFile$JarFileEntry +java/util/jar/JarVerifier +java/util/jar/JarVerifier$3 +java/util/jar/JarVerifier$VerifierStream +java/util/jar/JavaUtilJarAccessImpl +java/util/jar/Manifest +java/util/jar/Manifest$FastInputStream +java/util/logging/Handler +java/util/logging/Level +java/util/logging/Level$KnownLevel +java/util/logging/LogManager +java/util/logging/LogManager$1 +java/util/logging/LogManager$2 +java/util/logging/LogManager$3 +java/util/logging/LogManager$5 +java/util/logging/LogManager$Cleaner +java/util/logging/LogManager$LogNode +java/util/logging/LogManager$LoggerContext +java/util/logging/LogManager$LoggerContext$1 +java/util/logging/LogManager$LoggerWeakRef +java/util/logging/LogManager$RootLogger +java/util/logging/LogManager$SystemLoggerContext +java/util/logging/Logger +java/util/logging/Logger$1 +java/util/logging/LoggingPermission +java/util/logging/LoggingProxyImpl +java/util/regex/MatchResult +java/util/regex/Matcher +java/util/regex/Pattern +java/util/regex/Pattern$4 +java/util/regex/Pattern$BnM +java/util/regex/Pattern$GroupHead +java/util/regex/Pattern$LastNode +java/util/regex/Pattern$Node +java/util/regex/Pattern$Slice +java/util/regex/Pattern$SliceNode +java/util/regex/Pattern$Start +java/util/regex/Pattern$TreeInfo +java/util/spi/CalendarDataProvider +java/util/spi/CurrencyNameProvider +java/util/spi/LocaleNameProvider +java/util/spi/LocaleServiceProvider +java/util/spi/ResourceBundleControlProvider +java/util/spi/TimeZoneNameProvider +java/util/zip/CRC32 +java/util/zip/Checksum +java/util/zip/DeflaterOutputStream +java/util/zip/GZIPInputStream +java/util/zip/Inflater +java/util/zip/InflaterInputStream +java/util/zip/ZStreamRef +java/util/zip/ZipCoder +java/util/zip/ZipConstants +java/util/zip/ZipEntry +java/util/zip/ZipFile +java/util/zip/ZipFile$1 +java/util/zip/ZipFile$ZipEntryIterator +java/util/zip/ZipFile$ZipFileInflaterInputStream +java/util/zip/ZipFile$ZipFileInputStream +java/util/zip/ZipInputStream +java/util/zip/ZipUtils +javax/accessibility/Accessible +javax/accessibility/AccessibleAction +javax/accessibility/AccessibleBundle +javax/accessibility/AccessibleComponent +javax/accessibility/AccessibleContext +javax/accessibility/AccessibleExtendedComponent +javax/accessibility/AccessibleRelationSet +javax/accessibility/AccessibleState +javax/accessibility/AccessibleText +javax/accessibility/AccessibleValue +javax/crypto/SecretKey +javax/security/auth/Destroyable +javax/security/auth/login/FailedLoginException +javax/security/auth/login/LoginException +javax/security/auth/x500/X500Principal +javax/sound/sampled/Control$Type +javax/sound/sampled/DataLine +javax/sound/sampled/DataLine$Info +javax/sound/sampled/FloatControl$Type +javax/sound/sampled/Line +javax/sound/sampled/Line$Info +javax/sound/sampled/LineUnavailableException +javax/sound/sampled/UnsupportedAudioFileException +javax/swing/AbstractAction +javax/swing/AbstractButton +javax/swing/AbstractButton$AccessibleAbstractButton +javax/swing/AbstractButton$Handler +javax/swing/AbstractCellEditor +javax/swing/AbstractListModel +javax/swing/Action +javax/swing/ActionMap +javax/swing/AncestorNotifier +javax/swing/ArrayTable +javax/swing/BorderFactory +javax/swing/BoundedRangeModel +javax/swing/Box +javax/swing/Box$Filler +javax/swing/BoxLayout +javax/swing/BufferStrategyPaintManager +javax/swing/BufferStrategyPaintManager$BufferInfo +javax/swing/ButtonGroup +javax/swing/ButtonModel +javax/swing/CellEditor +javax/swing/CellRendererPane +javax/swing/ClientPropertyKey +javax/swing/ClientPropertyKey$1 +javax/swing/ComboBoxEditor +javax/swing/ComboBoxModel +javax/swing/ComponentInputMap +javax/swing/DefaultBoundedRangeModel +javax/swing/DefaultButtonModel +javax/swing/DefaultCellEditor +javax/swing/DefaultCellEditor$1 +javax/swing/DefaultCellEditor$EditorDelegate +javax/swing/DefaultComboBoxModel +javax/swing/DefaultListCellRenderer +javax/swing/DefaultListCellRenderer$UIResource +javax/swing/DefaultListModel +javax/swing/DefaultListSelectionModel +javax/swing/DefaultSingleSelectionModel +javax/swing/DropMode +javax/swing/FocusManager +javax/swing/GrayFilter +javax/swing/Icon +javax/swing/ImageIcon +javax/swing/ImageIcon$1 +javax/swing/ImageIcon$2 +javax/swing/ImageIcon$2$1 +javax/swing/ImageIcon$3 +javax/swing/InputMap +javax/swing/InternalFrameFocusTraversalPolicy +javax/swing/JButton +javax/swing/JCheckBox +javax/swing/JCheckBoxMenuItem +javax/swing/JCheckBoxMenuItem$AccessibleJCheckBoxMenuItem +javax/swing/JComboBox +javax/swing/JComboBox$1 +javax/swing/JComboBox$KeySelectionManager +javax/swing/JComponent +javax/swing/JComponent$1 +javax/swing/JComponent$2 +javax/swing/JComponent$AccessibleJComponent +javax/swing/JDialog +javax/swing/JEditorPane +javax/swing/JFrame +javax/swing/JInternalFrame +javax/swing/JLabel +javax/swing/JLayer +javax/swing/JLayeredPane +javax/swing/JList +javax/swing/JList$3 +javax/swing/JList$ListSelectionHandler +javax/swing/JMenu +javax/swing/JMenu$MenuChangeListener +javax/swing/JMenu$WinListener +javax/swing/JMenuBar +javax/swing/JMenuItem +javax/swing/JMenuItem$AccessibleJMenuItem +javax/swing/JMenuItem$MenuItemFocusListener +javax/swing/JPanel +javax/swing/JPopupMenu +javax/swing/JPopupMenu$Separator +javax/swing/JProgressBar +javax/swing/JProgressBar$ModelListener +javax/swing/JRadioButton +javax/swing/JRadioButtonMenuItem +javax/swing/JRootPane +javax/swing/JRootPane$1 +javax/swing/JRootPane$RootLayout +javax/swing/JScrollBar +javax/swing/JScrollBar$ModelListener +javax/swing/JScrollPane +javax/swing/JScrollPane$ScrollBar +javax/swing/JSeparator +javax/swing/JSlider +javax/swing/JSlider$ModelListener +javax/swing/JSplitPane +javax/swing/JTabbedPane +javax/swing/JTabbedPane$ModelListener +javax/swing/JTabbedPane$Page +javax/swing/JTable +javax/swing/JTable$2 +javax/swing/JTable$5 +javax/swing/JTable$Resizable2 +javax/swing/JTable$Resizable3 +javax/swing/JTextArea +javax/swing/JTextField +javax/swing/JTextField$NotifyAction +javax/swing/JTextField$ScrollRepainter +javax/swing/JToggleButton +javax/swing/JToggleButton$ToggleButtonModel +javax/swing/JToolBar +javax/swing/JToolBar$DefaultToolBarLayout +javax/swing/JToolBar$Separator +javax/swing/JToolTip +javax/swing/JTree +javax/swing/JTree$TreeModelHandler +javax/swing/JTree$TreeSelectionRedirector +javax/swing/JViewport +javax/swing/JViewport$ViewListener +javax/swing/JWindow +javax/swing/KeyStroke +javax/swing/KeyboardManager +javax/swing/KeyboardManager$ComponentKeyStrokePair +javax/swing/LayoutComparator +javax/swing/LayoutFocusTraversalPolicy +javax/swing/ListCellRenderer +javax/swing/ListModel +javax/swing/ListSelectionModel +javax/swing/LookAndFeel +javax/swing/MenuElement +javax/swing/MenuSelectionManager +javax/swing/MultiUIDefaults +javax/swing/MutableComboBoxModel +javax/swing/RepaintManager +javax/swing/RepaintManager$2 +javax/swing/RepaintManager$3 +javax/swing/RepaintManager$DisplayChangedHandler +javax/swing/RepaintManager$PaintManager +javax/swing/RepaintManager$ProcessingRunnable +javax/swing/RootPaneContainer +javax/swing/ScrollPaneConstants +javax/swing/ScrollPaneLayout +javax/swing/ScrollPaneLayout$UIResource +javax/swing/Scrollable +javax/swing/SingleSelectionModel +javax/swing/SizeRequirements +javax/swing/SortingFocusTraversalPolicy +javax/swing/SwingConstants +javax/swing/SwingContainerOrderFocusTraversalPolicy +javax/swing/SwingDefaultFocusTraversalPolicy +javax/swing/SwingPaintEventDispatcher +javax/swing/SwingUtilities +javax/swing/SwingUtilities$SharedOwnerFrame +javax/swing/Timer +javax/swing/Timer$DoPostEvent +javax/swing/TimerQueue +javax/swing/TimerQueue$1 +javax/swing/TimerQueue$DelayedTimer +javax/swing/ToolTipManager +javax/swing/ToolTipManager$AccessibilityKeyListener +javax/swing/ToolTipManager$MoveBeforeEnterListener +javax/swing/ToolTipManager$insideTimerAction +javax/swing/ToolTipManager$outsideTimerAction +javax/swing/ToolTipManager$stillInsideTimerAction +javax/swing/TransferHandler +javax/swing/TransferHandler$DropHandler +javax/swing/TransferHandler$HasGetTransferHandler +javax/swing/TransferHandler$SwingDropTarget +javax/swing/TransferHandler$TransferAction +javax/swing/TransferHandler$TransferSupport +javax/swing/UIDefaults +javax/swing/UIDefaults$ActiveValue +javax/swing/UIDefaults$LazyInputMap +javax/swing/UIDefaults$LazyValue +javax/swing/UIDefaults$TextAndMnemonicHashMap +javax/swing/UIManager +javax/swing/UIManager$1 +javax/swing/UIManager$2 +javax/swing/UIManager$LAFState +javax/swing/UIManager$LookAndFeelInfo +javax/swing/UnsupportedLookAndFeelException +javax/swing/ViewportLayout +javax/swing/WindowConstants +javax/swing/border/AbstractBorder +javax/swing/border/BevelBorder +javax/swing/border/Border +javax/swing/border/CompoundBorder +javax/swing/border/EmptyBorder +javax/swing/border/EtchedBorder +javax/swing/border/LineBorder +javax/swing/border/MatteBorder +javax/swing/border/TitledBorder +javax/swing/event/AncestorEvent +javax/swing/event/AncestorListener +javax/swing/event/CaretEvent +javax/swing/event/CaretListener +javax/swing/event/CellEditorListener +javax/swing/event/ChangeEvent +javax/swing/event/ChangeListener +javax/swing/event/DocumentEvent +javax/swing/event/DocumentEvent$ElementChange +javax/swing/event/DocumentEvent$EventType +javax/swing/event/DocumentListener +javax/swing/event/EventListenerList +javax/swing/event/ListDataEvent +javax/swing/event/ListDataListener +javax/swing/event/ListSelectionEvent +javax/swing/event/ListSelectionListener +javax/swing/event/MenuDragMouseListener +javax/swing/event/MenuEvent +javax/swing/event/MenuKeyListener +javax/swing/event/MenuListener +javax/swing/event/MouseInputAdapter +javax/swing/event/MouseInputListener +javax/swing/event/PopupMenuListener +javax/swing/event/RowSorterListener +javax/swing/event/SwingPropertyChangeSupport +javax/swing/event/TableColumnModelEvent +javax/swing/event/TableColumnModelListener +javax/swing/event/TableModelEvent +javax/swing/event/TableModelListener +javax/swing/event/TreeExpansionListener +javax/swing/event/TreeModelEvent +javax/swing/event/TreeModelListener +javax/swing/event/TreeSelectionEvent +javax/swing/event/TreeSelectionListener +javax/swing/event/UndoableEditEvent +javax/swing/event/UndoableEditListener +javax/swing/filechooser/FileFilter +javax/swing/plaf/ActionMapUIResource +javax/swing/plaf/BorderUIResource +javax/swing/plaf/BorderUIResource$CompoundBorderUIResource +javax/swing/plaf/BorderUIResource$EmptyBorderUIResource +javax/swing/plaf/BorderUIResource$LineBorderUIResource +javax/swing/plaf/ButtonUI +javax/swing/plaf/ColorUIResource +javax/swing/plaf/ComboBoxUI +javax/swing/plaf/ComponentInputMapUIResource +javax/swing/plaf/ComponentUI +javax/swing/plaf/DimensionUIResource +javax/swing/plaf/FontUIResource +javax/swing/plaf/InputMapUIResource +javax/swing/plaf/InsetsUIResource +javax/swing/plaf/LabelUI +javax/swing/plaf/ListUI +javax/swing/plaf/MenuBarUI +javax/swing/plaf/MenuItemUI +javax/swing/plaf/PanelUI +javax/swing/plaf/PopupMenuUI +javax/swing/plaf/ProgressBarUI +javax/swing/plaf/RootPaneUI +javax/swing/plaf/ScrollBarUI +javax/swing/plaf/ScrollPaneUI +javax/swing/plaf/SeparatorUI +javax/swing/plaf/SliderUI +javax/swing/plaf/SplitPaneUI +javax/swing/plaf/TabbedPaneUI +javax/swing/plaf/TableHeaderUI +javax/swing/plaf/TableUI +javax/swing/plaf/TextUI +javax/swing/plaf/ToolBarUI +javax/swing/plaf/TreeUI +javax/swing/plaf/UIResource +javax/swing/plaf/ViewportUI +javax/swing/plaf/basic/BasicArrowButton +javax/swing/plaf/basic/BasicBorders +javax/swing/plaf/basic/BasicBorders$ButtonBorder +javax/swing/plaf/basic/BasicBorders$MarginBorder +javax/swing/plaf/basic/BasicBorders$RadioButtonBorder +javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder +javax/swing/plaf/basic/BasicBorders$SplitPaneBorder +javax/swing/plaf/basic/BasicBorders$SplitPaneDividerBorder +javax/swing/plaf/basic/BasicButtonListener +javax/swing/plaf/basic/BasicButtonUI +javax/swing/plaf/basic/BasicCheckBoxMenuItemUI +javax/swing/plaf/basic/BasicComboBoxEditor +javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField +javax/swing/plaf/basic/BasicComboBoxEditor$UIResource +javax/swing/plaf/basic/BasicComboBoxRenderer +javax/swing/plaf/basic/BasicComboBoxRenderer$UIResource +javax/swing/plaf/basic/BasicComboBoxUI +javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager +javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager +javax/swing/plaf/basic/BasicComboBoxUI$Handler +javax/swing/plaf/basic/BasicComboBoxUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicComboPopup +javax/swing/plaf/basic/BasicComboPopup$1 +javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass +javax/swing/plaf/basic/BasicComboPopup$Handler +javax/swing/plaf/basic/BasicGraphicsUtils +javax/swing/plaf/basic/BasicHTML +javax/swing/plaf/basic/BasicLabelUI +javax/swing/plaf/basic/BasicListUI +javax/swing/plaf/basic/BasicListUI$Handler +javax/swing/plaf/basic/BasicListUI$ListTransferHandler +javax/swing/plaf/basic/BasicLookAndFeel +javax/swing/plaf/basic/BasicLookAndFeel$1 +javax/swing/plaf/basic/BasicLookAndFeel$2 +javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper +javax/swing/plaf/basic/BasicMenuBarUI +javax/swing/plaf/basic/BasicMenuBarUI$Handler +javax/swing/plaf/basic/BasicMenuItemUI +javax/swing/plaf/basic/BasicMenuItemUI$Handler +javax/swing/plaf/basic/BasicMenuUI +javax/swing/plaf/basic/BasicMenuUI$Handler +javax/swing/plaf/basic/BasicPanelUI +javax/swing/plaf/basic/BasicPopupMenuUI +javax/swing/plaf/basic/BasicPopupMenuUI$BasicMenuKeyListener +javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener +javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper +javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper$1 +javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber +javax/swing/plaf/basic/BasicProgressBarUI +javax/swing/plaf/basic/BasicProgressBarUI$Handler +javax/swing/plaf/basic/BasicRadioButtonMenuItemUI +javax/swing/plaf/basic/BasicRadioButtonUI +javax/swing/plaf/basic/BasicRootPaneUI +javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap +javax/swing/plaf/basic/BasicScrollBarUI +javax/swing/plaf/basic/BasicScrollBarUI$ArrowButtonListener +javax/swing/plaf/basic/BasicScrollBarUI$Handler +javax/swing/plaf/basic/BasicScrollBarUI$ModelListener +javax/swing/plaf/basic/BasicScrollBarUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicScrollBarUI$ScrollListener +javax/swing/plaf/basic/BasicScrollBarUI$TrackListener +javax/swing/plaf/basic/BasicScrollPaneUI +javax/swing/plaf/basic/BasicScrollPaneUI$Handler +javax/swing/plaf/basic/BasicSeparatorUI +javax/swing/plaf/basic/BasicSliderUI +javax/swing/plaf/basic/BasicSliderUI$Actions +javax/swing/plaf/basic/BasicSliderUI$Handler +javax/swing/plaf/basic/BasicSliderUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicSliderUI$ScrollListener +javax/swing/plaf/basic/BasicSliderUI$TrackListener +javax/swing/plaf/basic/BasicSplitPaneDivider +javax/swing/plaf/basic/BasicSplitPaneDivider$DividerLayout +javax/swing/plaf/basic/BasicSplitPaneDivider$MouseHandler +javax/swing/plaf/basic/BasicSplitPaneDivider$OneTouchActionHandler +javax/swing/plaf/basic/BasicSplitPaneUI +javax/swing/plaf/basic/BasicSplitPaneUI$1 +javax/swing/plaf/basic/BasicSplitPaneUI$BasicHorizontalLayoutManager +javax/swing/plaf/basic/BasicSplitPaneUI$Handler +javax/swing/plaf/basic/BasicTabbedPaneUI +javax/swing/plaf/basic/BasicTabbedPaneUI$Handler +javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneLayout +javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneScrollLayout +javax/swing/plaf/basic/BasicTableHeaderUI +javax/swing/plaf/basic/BasicTableHeaderUI$1 +javax/swing/plaf/basic/BasicTableHeaderUI$MouseInputHandler +javax/swing/plaf/basic/BasicTableUI +javax/swing/plaf/basic/BasicTableUI$Handler +javax/swing/plaf/basic/BasicTableUI$TableTransferHandler +javax/swing/plaf/basic/BasicTextAreaUI +javax/swing/plaf/basic/BasicTextFieldUI +javax/swing/plaf/basic/BasicTextUI +javax/swing/plaf/basic/BasicTextUI$BasicCaret +javax/swing/plaf/basic/BasicTextUI$BasicCursor +javax/swing/plaf/basic/BasicTextUI$BasicHighlighter +javax/swing/plaf/basic/BasicTextUI$DragListener +javax/swing/plaf/basic/BasicTextUI$FocusAction +javax/swing/plaf/basic/BasicTextUI$RootView +javax/swing/plaf/basic/BasicTextUI$TextActionWrapper +javax/swing/plaf/basic/BasicTextUI$TextTransferHandler +javax/swing/plaf/basic/BasicTextUI$UpdateHandler +javax/swing/plaf/basic/BasicToggleButtonUI +javax/swing/plaf/basic/BasicToolBarSeparatorUI +javax/swing/plaf/basic/BasicToolBarUI +javax/swing/plaf/basic/BasicToolBarUI$DockingListener +javax/swing/plaf/basic/BasicToolBarUI$Handler +javax/swing/plaf/basic/BasicTreeUI +javax/swing/plaf/basic/BasicTreeUI$Actions +javax/swing/plaf/basic/BasicTreeUI$Handler +javax/swing/plaf/basic/BasicTreeUI$NodeDimensionsHandler +javax/swing/plaf/basic/BasicTreeUI$TreeTransferHandler +javax/swing/plaf/basic/BasicViewportUI +javax/swing/plaf/basic/ComboPopup +javax/swing/plaf/basic/DefaultMenuLayout +javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag +javax/swing/plaf/basic/LazyActionMap +javax/swing/plaf/metal/DefaultMetalTheme +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 +javax/swing/plaf/metal/MetalBorders +javax/swing/plaf/metal/MetalBorders$ButtonBorder +javax/swing/plaf/metal/MetalBorders$Flush3DBorder +javax/swing/plaf/metal/MetalBorders$MenuBarBorder +javax/swing/plaf/metal/MetalBorders$MenuItemBorder +javax/swing/plaf/metal/MetalBorders$PopupMenuBorder +javax/swing/plaf/metal/MetalBorders$RolloverButtonBorder +javax/swing/plaf/metal/MetalBorders$RolloverMarginBorder +javax/swing/plaf/metal/MetalBorders$ScrollPaneBorder +javax/swing/plaf/metal/MetalBorders$TextFieldBorder +javax/swing/plaf/metal/MetalBorders$ToggleButtonBorder +javax/swing/plaf/metal/MetalBorders$ToolBarBorder +javax/swing/plaf/metal/MetalBumps +javax/swing/plaf/metal/MetalButtonUI +javax/swing/plaf/metal/MetalCheckBoxUI +javax/swing/plaf/metal/MetalComboBoxButton +javax/swing/plaf/metal/MetalComboBoxButton$1 +javax/swing/plaf/metal/MetalComboBoxEditor +javax/swing/plaf/metal/MetalComboBoxEditor$1 +javax/swing/plaf/metal/MetalComboBoxEditor$EditorBorder +javax/swing/plaf/metal/MetalComboBoxEditor$UIResource +javax/swing/plaf/metal/MetalComboBoxIcon +javax/swing/plaf/metal/MetalComboBoxUI +javax/swing/plaf/metal/MetalComboBoxUI$MetalComboBoxLayoutManager +javax/swing/plaf/metal/MetalComboBoxUI$MetalPropertyChangeListener +javax/swing/plaf/metal/MetalIconFactory +javax/swing/plaf/metal/MetalIconFactory$CheckBoxIcon +javax/swing/plaf/metal/MetalIconFactory$CheckBoxMenuItemIcon +javax/swing/plaf/metal/MetalIconFactory$FolderIcon16 +javax/swing/plaf/metal/MetalIconFactory$HorizontalSliderThumbIcon +javax/swing/plaf/metal/MetalIconFactory$MenuArrowIcon +javax/swing/plaf/metal/MetalIconFactory$MenuItemArrowIcon +javax/swing/plaf/metal/MetalIconFactory$RadioButtonIcon +javax/swing/plaf/metal/MetalIconFactory$RadioButtonMenuItemIcon +javax/swing/plaf/metal/MetalIconFactory$TreeFolderIcon +javax/swing/plaf/metal/MetalIconFactory$VerticalSliderThumbIcon +javax/swing/plaf/metal/MetalLabelUI +javax/swing/plaf/metal/MetalLookAndFeel +javax/swing/plaf/metal/MetalLookAndFeel$AATextListener +javax/swing/plaf/metal/MetalLookAndFeel$FontActiveValue +javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue +javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue$1 +javax/swing/plaf/metal/MetalPopupMenuSeparatorUI +javax/swing/plaf/metal/MetalProgressBarUI +javax/swing/plaf/metal/MetalRadioButtonUI +javax/swing/plaf/metal/MetalRootPaneUI +javax/swing/plaf/metal/MetalScrollBarUI +javax/swing/plaf/metal/MetalScrollBarUI$ScrollBarListener +javax/swing/plaf/metal/MetalScrollButton +javax/swing/plaf/metal/MetalScrollPaneUI +javax/swing/plaf/metal/MetalScrollPaneUI$1 +javax/swing/plaf/metal/MetalSeparatorUI +javax/swing/plaf/metal/MetalSliderUI +javax/swing/plaf/metal/MetalSliderUI$MetalPropertyListener +javax/swing/plaf/metal/MetalSplitPaneDivider +javax/swing/plaf/metal/MetalSplitPaneDivider$1 +javax/swing/plaf/metal/MetalSplitPaneDivider$2 +javax/swing/plaf/metal/MetalSplitPaneUI +javax/swing/plaf/metal/MetalTabbedPaneUI +javax/swing/plaf/metal/MetalTabbedPaneUI$TabbedPaneLayout +javax/swing/plaf/metal/MetalTextFieldUI +javax/swing/plaf/metal/MetalTheme +javax/swing/plaf/metal/MetalToggleButtonUI +javax/swing/plaf/metal/MetalToolBarUI +javax/swing/plaf/metal/MetalToolBarUI$MetalDockingListener +javax/swing/plaf/metal/MetalTreeUI +javax/swing/plaf/metal/MetalTreeUI$LineListener +javax/swing/plaf/metal/OceanTheme javax/swing/plaf/metal/OceanTheme$1 javax/swing/plaf/metal/OceanTheme$2 javax/swing/plaf/metal/OceanTheme$3 javax/swing/plaf/metal/OceanTheme$4 javax/swing/plaf/metal/OceanTheme$5 javax/swing/plaf/metal/OceanTheme$6 -javax/swing/RepaintManager -javax/swing/RepaintManager$DisplayChangedHandler -javax/swing/SwingPaintEventDispatcher -sun/awt/PaintEventDispatcher -javax/swing/UIManager$2 -java/awt/PopupMenu -java/awt/Menu -java/awt/MenuItem -java/awt/MenuComponent -java/io/ObjectOutputStream -java/io/ObjectOutput -java/io/DataOutput -java/io/ObjectStreamConstants -java/io/PrintWriter -java/io/ObjectInputStream -java/io/ObjectInput -java/awt/Event -java/awt/im/InputContext -java/awt/event/MouseWheelEvent -java/awt/BufferCapabilities -sun/awt/CausedFocusEvent$Cause -java/awt/PointerInfo -java/awt/Component$BaselineResizeBehavior -java/awt/FontMetrics -java/awt/Image -java/awt/image/ImageProducer -java/awt/image/VolatileImage -java/awt/im/InputMethodRequests -java/awt/event/FocusEvent -java/awt/event/InputMethodEvent -java/awt/event/HierarchyEvent -javax/accessibility/AccessibleStateSet -com/sun/swing/internal/plaf/metal/resources/metal -sun/util/ResourceBundleEnumeration -com/sun/swing/internal/plaf/basic/resources/basic -javax/swing/plaf/basic/BasicPanelUI -javax/swing/plaf/PanelUI -javax/swing/plaf/ComponentUI -sun/reflect/misc/MethodUtil -sun/reflect/misc/MethodUtil$1 -sun/misc/Launcher$1 -sun/misc/URLClassPath$JarLoader$1 -sun/misc/FileURLMapper -java/util/jar/JarFile -java/util/zip/ZipFile -java/util/zip/ZipConstants -java/util/jar/JavaUtilJarAccessImpl -sun/misc/JavaUtilJarAccess -sun/misc/JarIndex -java/util/zip/ZipEntry -java/util/jar/JarFile$JarFileEntry -java/util/jar/JarEntry -sun/misc/URLClassPath$JarLoader$2 -sun/net/www/protocol/jar/JarURLConnection -java/net/JarURLConnection -sun/net/www/protocol/jar/JarFileFactory -sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController -java/net/HttpURLConnection -sun/net/www/protocol/jar/URLJarFile -sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry -sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream -java/util/zip/ZipFile$ZipFileInputStream -java/security/AllPermissionCollection -java/lang/IllegalAccessException -javax/swing/JPasswordField -javax/swing/JTextField -javax/swing/text/JTextComponent -javax/swing/Scrollable -javax/swing/JLayeredPane -javax/swing/JRootPane$1 -javax/swing/ArrayTable -javax/swing/JInternalFrame -javax/swing/JRootPane$RootLayout -javax/swing/BufferStrategyPaintManager -javax/swing/RepaintManager$PaintManager -javax/swing/plaf/metal/MetalRootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI -javax/swing/plaf/RootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap -javax/swing/plaf/ComponentInputMapUIResource -javax/swing/ComponentInputMap -javax/swing/InputMap -javax/swing/plaf/InputMapUIResource -javax/swing/KeyStroke -java/awt/VKCollection -sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl -javax/swing/plaf/basic/LazyActionMap -javax/swing/plaf/ActionMapUIResource -javax/swing/ActionMap -javax/swing/LayoutFocusTraversalPolicy -javax/swing/SortingFocusTraversalPolicy -javax/swing/InternalFrameFocusTraversalPolicy -javax/swing/SwingContainerOrderFocusTraversalPolicy -javax/swing/SwingDefaultFocusTraversalPolicy -javax/swing/LayoutComparator -javax/swing/plaf/metal/MetalLabelUI -javax/swing/plaf/basic/BasicLabelUI -javax/swing/plaf/LabelUI -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 -javax/swing/plaf/basic/BasicHTML -sun/awt/NullComponentPeer -java/awt/event/WindowEvent -java/awt/EventQueue$1 -java/awt/EventDispatchThread$1 -java/awt/Conditional -java/awt/EventDispatchThread$HierarchyEventFilter -java/awt/EventFilter$FilterAction -sun/awt/dnd/SunDropTargetEvent -java/awt/event/ActionEvent -sun/awt/X11/XReparentEvent -sun/awt/X11/XWindowAttributes -sun/awt/EventQueueItem -sun/awt/SunToolkit$3 -java/applet/Applet -java/awt/Panel -com/sun/awt/AWTUtilities -sun/awt/X11/XExposeEvent -java/util/jar/Manifest -java/io/ByteArrayInputStream -java/util/jar/Attributes -java/util/jar/Manifest$FastInputStream -java/util/jar/Attributes$Name -sun/misc/ASCIICaseInsensitiveComparator -java/util/jar/JarVerifier -java/io/ByteArrayOutputStream -sun/misc/ExtensionDependency -java/lang/Package -sun/security/util/ManifestEntryVerifier -java/security/Provider -java/security/Provider$ServiceKey -java/security/Provider$EngineDescription -java/security/Security -java/security/Security$1 -sun/misc/FloatingDecimal -sun/misc/FloatingDecimal$1 -java/util/regex/Pattern -java/util/regex/Pattern$Node -java/util/regex/Pattern$LastNode -java/util/regex/Pattern$GroupHead -java/util/regex/Pattern$GroupTail -java/util/regex/Pattern$BitClass -java/util/regex/Pattern$BmpCharProperty -java/util/regex/Pattern$CharProperty -java/util/regex/Pattern$Ques -java/util/regex/Pattern$BranchConn -java/util/regex/Pattern$Branch -java/util/regex/Pattern$5 -java/util/regex/Pattern$CharPropertyNames -java/util/regex/Pattern$CharPropertyNames$1 -java/util/regex/Pattern$CharPropertyNames$CharPropertyFactory -java/util/regex/Pattern$CharPropertyNames$2 -java/util/regex/Pattern$CharPropertyNames$5 -java/util/regex/Pattern$CharPropertyNames$3 -java/util/regex/Pattern$CharPropertyNames$6 -java/util/regex/Pattern$CharPropertyNames$CloneableProperty -java/util/regex/Pattern$CharPropertyNames$4 -java/util/regex/Pattern$CharPropertyNames$7 -java/util/regex/Pattern$CharPropertyNames$8 -java/util/regex/Pattern$CharPropertyNames$9 -java/util/regex/Pattern$CharPropertyNames$10 -java/util/regex/Pattern$CharPropertyNames$11 -java/util/regex/Pattern$CharPropertyNames$12 -java/util/regex/Pattern$CharPropertyNames$13 -java/util/regex/Pattern$CharPropertyNames$14 -java/util/regex/Pattern$CharPropertyNames$15 -java/util/regex/Pattern$CharPropertyNames$16 -java/util/regex/Pattern$CharPropertyNames$17 -java/util/regex/Pattern$CharPropertyNames$18 -java/util/regex/Pattern$CharPropertyNames$19 -java/util/regex/Pattern$CharPropertyNames$20 -java/util/regex/Pattern$CharPropertyNames$21 -java/util/regex/Pattern$Ctype -java/util/regex/Pattern$Curly -java/util/regex/Pattern$6 -java/util/regex/Pattern$Slice -java/util/regex/Pattern$Begin -java/util/regex/Pattern$First -java/util/regex/Pattern$Start -java/util/regex/Pattern$TreeInfo -sun/security/provider/NativePRNG -java/security/SecureRandomSpi -sun/security/provider/NativePRNG$1 -sun/security/provider/NativePRNG$RandomIO -sun/misc/BASE64Decoder -sun/misc/CharacterDecoder -sun/security/util/SignatureFileVerifier -java/awt/event/KeyAdapter -java/lang/NumberFormatException -java/lang/IllegalArgumentException -java/io/FileWriter -java/net/Authenticator -java/net/MalformedURLException -javax/swing/text/Element -javax/swing/text/Document -javax/swing/text/PlainDocument +javax/swing/plaf/synth/SynthConstants +javax/swing/plaf/synth/SynthUI +javax/swing/table/AbstractTableModel +javax/swing/table/DefaultTableCellRenderer +javax/swing/table/DefaultTableColumnModel +javax/swing/table/DefaultTableModel +javax/swing/table/JTableHeader +javax/swing/table/TableCellEditor +javax/swing/table/TableCellRenderer +javax/swing/table/TableColumn +javax/swing/table/TableColumnModel +javax/swing/table/TableModel javax/swing/text/AbstractDocument -javax/swing/text/GapContent -javax/swing/text/AbstractDocument$Content -javax/swing/text/GapVector -javax/swing/text/GapContent$MarkVector -javax/swing/text/GapContent$MarkData -javax/swing/text/StyleContext +javax/swing/text/AbstractDocument$1 +javax/swing/text/AbstractDocument$AbstractElement javax/swing/text/AbstractDocument$AttributeContext -javax/swing/text/StyleConstants -javax/swing/text/StyleConstants$CharacterConstants -javax/swing/text/AttributeSet$CharacterAttribute -javax/swing/text/StyleConstants$FontConstants -javax/swing/text/AttributeSet$FontAttribute -javax/swing/text/StyleConstants$ColorConstants -javax/swing/text/AttributeSet$ColorAttribute -javax/swing/text/StyleConstants$ParagraphConstants -javax/swing/text/AttributeSet$ParagraphAttribute -javax/swing/text/StyleContext$FontKey -javax/swing/text/SimpleAttributeSet -javax/swing/text/MutableAttributeSet -javax/swing/text/AttributeSet -javax/swing/text/SimpleAttributeSet$EmptyAttributeSet -javax/swing/text/StyleContext$NamedStyle -javax/swing/text/Style -javax/swing/text/StyleContext$SmallAttributeSet +javax/swing/text/AbstractDocument$BidiElement javax/swing/text/AbstractDocument$BidiRootElement javax/swing/text/AbstractDocument$BranchElement -javax/swing/text/AbstractDocument$AbstractElement -javax/swing/tree/TreeNode -javax/swing/text/AbstractDocument$1 -javax/swing/text/AbstractDocument$BidiElement -javax/swing/text/AbstractDocument$LeafElement -javax/swing/text/GapContent$StickyPosition -javax/swing/text/Position -javax/swing/text/StyleContext$KeyEnumeration -javax/swing/text/GapContent$InsertUndo -javax/swing/undo/AbstractUndoableEdit -javax/swing/undo/UndoableEdit +javax/swing/text/AbstractDocument$Content javax/swing/text/AbstractDocument$DefaultDocumentEvent -javax/swing/event/DocumentEvent -javax/swing/undo/CompoundEdit -javax/swing/event/DocumentEvent$EventType -javax/swing/text/Segment -java/text/CharacterIterator -javax/swing/text/Utilities -javax/swing/text/SegmentCache -javax/swing/text/SegmentCache$CachedSegment -javax/swing/event/UndoableEditEvent javax/swing/text/AbstractDocument$ElementEdit -javax/swing/event/DocumentEvent$ElementChange -java/net/Socket -java/net/InetAddress -java/net/InetAddress$Cache -java/net/InetAddress$Cache$Type -java/net/InetAddressImplFactory -java/net/Inet6AddressImpl -java/net/InetAddressImpl -java/net/InetAddress$1 -sun/net/spi/nameservice/NameService -sun/net/util/IPAddressUtil -java/util/regex/Matcher -java/util/regex/MatchResult -java/util/RandomAccessSubList -java/util/SubList -java/util/SubList$1 -java/util/AbstractList$ListItr -java/net/Inet4Address -java/net/InetSocketAddress -java/net/SocketAddress -java/net/Inet4AddressImpl -java/net/SocksSocketImpl -java/net/SocksConsts -java/net/PlainSocketImpl -java/net/SocketImpl -java/net/SocketOptions -java/net/SocketException -java/net/SocksSocketImpl$5 -java/net/ProxySelector -sun/net/spi/DefaultProxySelector -sun/net/spi/DefaultProxySelector$1 -sun/net/NetProperties -sun/net/NetProperties$1 -sun/net/spi/DefaultProxySelector$NonProxyInfo -java/util/regex/ASCII -java/util/regex/Pattern$GroupCurly -java/net/Inet6Address -java/net/URI -java/net/URI$Parser -java/net/Proxy -java/net/Proxy$Type -java/net/ConnectException -javax/swing/JMenu -javax/swing/MenuElement -javax/swing/JMenuItem -javax/swing/AbstractButton -java/awt/ItemSelectable -javax/swing/event/MenuListener -javax/swing/JCheckBoxMenuItem -javax/swing/Icon -javax/swing/JButton -java/awt/event/WindowListener -java/net/URLClassLoader$2 -javax/swing/ImageIcon -javax/swing/ImageIcon$1 -java/awt/MediaTracker -sun/misc/SoftCache$ValueCell -sun/awt/image/URLImageSource -sun/awt/image/InputStreamImageSource -sun/awt/image/ImageFetchable -sun/awt/image/ToolkitImage -java/awt/Image$1 -sun/awt/image/SurfaceManager$ImageAccessor -sun/awt/image/SurfaceManager -sun/awt/image/NativeLibLoader -java/awt/ImageMediaEntry -java/awt/MediaEntry -sun/awt/image/ImageRepresentation -java/awt/image/ImageConsumer -sun/awt/image/ImageWatched -sun/awt/image/ImageWatched$Link -sun/awt/image/ImageWatched$WeakLink -sun/awt/image/ImageConsumerQueue -sun/awt/image/ImageFetcher -sun/awt/image/FetcherInfo -sun/awt/image/ImageFetcher$1 -sun/awt/image/GifImageDecoder -sun/awt/image/ImageDecoder -sun/awt/image/GifFrame -java/awt/image/Raster -java/awt/image/DataBufferByte -java/awt/image/DataBuffer -java/awt/image/PixelInterleavedSampleModel -java/awt/image/ComponentSampleModel -java/awt/image/SampleModel -sun/awt/image/ByteInterleavedRaster -sun/awt/image/ByteComponentRaster -sun/awt/image/SunWritableRaster -java/awt/image/WritableRaster -java/awt/image/BufferedImage -java/awt/image/WritableRenderedImage -java/awt/image/RenderedImage -sun/awt/image/IntegerComponentRaster -sun/awt/image/BytePackedRaster -java/awt/Canvas -sun/font/FontDesignMetrics -sun/font/FontStrikeDesc -sun/font/CompositeStrike -sun/font/FontStrikeDisposer -sun/font/StrikeCache$SoftDisposerRef -sun/font/StrikeCache$DisposableStrike -sun/font/TrueTypeFont$TTDisposerRecord -sun/font/TrueTypeFont$1 -java/io/RandomAccessFile -sun/nio/ch/FileChannelImpl -java/nio/channels/FileChannel -java/nio/channels/ByteChannel -java/nio/channels/ReadableByteChannel -java/nio/channels/Channel -java/nio/channels/WritableByteChannel -java/nio/channels/GatheringByteChannel -java/nio/channels/ScatteringByteChannel -java/nio/channels/spi/AbstractInterruptibleChannel -java/nio/channels/InterruptibleChannel -sun/nio/ch/Util -sun/nio/ch/IOUtil -sun/nio/ch/FileDispatcher -sun/nio/ch/NativeDispatcher -sun/nio/ch/Reflect -java/nio/MappedByteBuffer -sun/nio/ch/Reflect$1 -sun/nio/ch/NativeThreadSet -java/nio/channels/spi/AbstractInterruptibleChannel$1 -sun/nio/ch/NativeThread -sun/nio/ch/IOStatus -sun/nio/ch/DirectBuffer -java/nio/DirectByteBuffer -java/nio/DirectByteBuffer$Deallocator -sun/misc/Cleaner -java/nio/ByteBufferAsIntBufferB -java/nio/IntBuffer -sun/font/TrueTypeFont$DirectoryEntry -java/nio/ByteBufferAsShortBufferB -java/nio/ShortBuffer -sun/nio/cs/UTF_16 -sun/nio/cs/UTF_16$Decoder -sun/nio/cs/UnicodeDecoder -sun/font/FileFontStrike -sun/font/TrueTypeGlyphMapper -sun/font/CMap -sun/font/CMap$NullCMapClass -sun/font/CMap$CMapFormat4 -java/nio/ByteBufferAsCharBufferB -sun/font/CMap$CMapFormat12 -java/awt/FontFormatException -sun/java2d/HeadlessGraphicsEnvironment -java/nio/charset/Charset$3 -sun/nio/cs/AbstractCharsetProvider -sun/font/NativeFont -java/lang/CharacterData00 -sun/font/CMap$CMapFormat2 -sun/font/FontDesignMetrics$KeyReference -sun/awt/image/PNGImageDecoder -sun/awt/image/PNGFilterInputStream -java/util/zip/InflaterInputStream -java/util/zip/Inflater -sun/reflect/UnsafeBooleanFieldAccessorImpl -sun/awt/event/IgnorePaintEvent -java/awt/image/DataBufferInt -java/awt/image/SinglePixelPackedSampleModel -sun/awt/image/IntegerInterleavedRaster -sun/awt/image/OffScreenImage -sun/awt/image/BufImgSurfaceData -sun/java2d/opengl/GLXGraphicsConfig -sun/java2d/opengl/OGLGraphicsConfig -sun/java2d/x11/X11SurfaceData$X11PixmapSurfaceData -sun/awt/image/WritableRasterNative -sun/awt/image/DataBufferNative -sun/java2d/SurfaceManagerFactory -sun/java2d/opengl/GLXSurfaceData -sun/java2d/opengl/OGLSurfaceData -sun/font/CompositeGlyphMapper -sun/java2d/loops/FontInfo -java/util/Date -sun/util/calendar/CalendarSystem -sun/util/calendar/Gregorian -sun/util/calendar/BaseCalendar -sun/util/calendar/AbstractCalendar -java/util/TimeZone -java/lang/InheritableThreadLocal -sun/util/calendar/ZoneInfo -sun/util/calendar/ZoneInfoFile -sun/util/calendar/ZoneInfoFile$1 -java/util/TimeZone$1 -sun/util/calendar/Gregorian$Date -sun/util/calendar/BaseCalendar$Date -sun/util/calendar/CalendarDate -sun/util/calendar/CalendarUtils -java/util/TimeZone$DisplayNames -sun/util/TimeZoneNameUtility -sun/util/resources/LocaleData -sun/util/resources/LocaleData$1 -sun/util/resources/LocaleData$LocaleDataResourceBundleControl -sun/util/LocaleDataMetaInfo -sun/util/resources/TimeZoneNames -sun/util/resources/TimeZoneNamesBundle -sun/util/resources/OpenListResourceBundle -java/util/ResourceBundle$BundleReference -sun/util/resources/TimeZoneNames_en -java/util/spi/TimeZoneNameProvider -java/util/spi/LocaleServiceProvider -sun/util/LocaleServiceProviderPool -sun/util/LocaleServiceProviderPool$1 -java/util/ServiceLoader -java/util/ServiceLoader$LazyIterator -java/util/ServiceLoader$1 -java/util/LinkedHashMap$EntryIterator -sun/misc/URLClassPath$2 -java/lang/ClassLoader$2 -sun/misc/URLClassPath$1 -java/net/URLClassLoader$3 -sun/misc/CompoundEnumeration -java/net/URLClassLoader$3$1 -java/lang/ProcessBuilder -java/lang/ProcessImpl -java/lang/UNIXProcess -java/lang/Process -java/lang/UNIXProcess$1 -java/lang/UNIXProcess$DeferredCloseInputStream -java/lang/UNIXProcess$2 -java/lang/UNIXProcess$2$1 -java/net/ServerSocket -java/util/Random -java/util/concurrent/atomic/AtomicLong -java/lang/InternalError -java/io/StringReader -java/lang/SecurityException -java/io/FilterReader -java/lang/reflect/Proxy -java/lang/reflect/InvocationHandler -java/lang/NoSuchFieldException -java/lang/InstantiationException -java/lang/ArrayIndexOutOfBoundsException -javax/swing/JDialog -sun/awt/X11/XClipboard -sun/awt/datatransfer/SunClipboard -java/awt/datatransfer/Clipboard -java/awt/datatransfer/SystemFlavorMap -java/awt/datatransfer/FlavorMap -java/awt/datatransfer/FlavorTable -java/awt/datatransfer/SystemFlavorMap$1 -sun/net/ProgressMonitor -sun/net/DefaultProgressMeteringPolicy -sun/net/ProgressMeteringPolicy -java/awt/datatransfer/SystemFlavorMap$2 -java/awt/datatransfer/MimeType -java/io/Externalizable -java/awt/datatransfer/MimeTypeParameterList -sun/awt/datatransfer/DataTransferer -java/util/Collections$SynchronizedSet -java/util/Collections$SynchronizedCollection -java/awt/datatransfer/DataFlavor -java/awt/datatransfer/DataFlavor$1 -sun/awt/datatransfer/DataTransferer$CharsetComparator -sun/awt/datatransfer/DataTransferer$IndexedComparator -sun/nio/cs/UTF_16LE -sun/nio/cs/UTF_16BE -sun/nio/cs/US_ASCII -sun/awt/datatransfer/DataTransferer$DataFlavorComparator -java/rmi/Remote -sun/awt/datatransfer/DataTransferer$1 -sun/awt/X11/XDataTransferer -sun/awt/datatransfer/ToolkitThreadBlockedHandler -javax/imageio/ImageTypeSpecifier -sun/awt/X11/XSelection -sun/security/action/GetIntegerAction -sun/awt/X11/XSelection$IncrementalTransferHandler -sun/awt/X11/XSelection$SelectionEventHandler -java/awt/datatransfer/Transferable -java/io/EOFException -java/util/Vector$1 -java/util/zip/ZipFile$1 -java/util/zip/ZipFile$2 -java/util/jar/JarFile$1 -java/util/PropertyResourceBundle -java/util/ResourceBundle$Control$1 -java/util/Hashtable$EntrySet -java/lang/IllegalAccessError -java/text/MessageFormat -java/text/Format -java/text/FieldPosition -java/text/MessageFormat$Field -java/text/Format$Field -java/lang/CloneNotSupportedException -sun/reflect/MethodAccessorGenerator -sun/reflect/AccessorGenerator -sun/reflect/ClassFileConstants -java/lang/Void -sun/reflect/ByteVectorFactory -sun/reflect/ByteVectorImpl -sun/reflect/ByteVector -sun/reflect/ClassFileAssembler -sun/reflect/UTF8 -sun/reflect/Label -sun/reflect/Label$PatchInfo -sun/reflect/MethodAccessorGenerator$1 -sun/reflect/ClassDefiner -sun/reflect/ClassDefiner$1 -sun/reflect/BootstrapConstructorAccessorImpl -java/awt/event/ActionListener -javax/swing/Timer -javax/swing/Timer$DoPostEvent -javax/swing/TimerQueue -javax/swing/TimerQueue$1 -javax/swing/ToolTipManager -java/awt/event/MouseAdapter -javax/swing/ToolTipManager$insideTimerAction -javax/swing/ToolTipManager$outsideTimerAction -javax/swing/ToolTipManager$stillInsideTimerAction -sun/swing/UIAction -javax/swing/Action -javax/swing/ToolTipManager$MoveBeforeEnterListener -java/awt/event/MouseMotionAdapter -java/util/Hashtable$ValueCollection -javax/swing/event/CaretListener -javax/swing/JToolBar -javax/swing/JSplitPane -javax/swing/border/Border -javax/swing/JToggleButton -javax/swing/border/EmptyBorder -javax/swing/border/AbstractBorder -javax/swing/DefaultButtonModel -javax/swing/ButtonModel -javax/swing/AbstractButton$Handler -javax/swing/event/ChangeListener -java/awt/event/ItemListener -javax/swing/plaf/metal/MetalButtonUI -javax/swing/plaf/basic/BasicButtonUI -javax/swing/plaf/ButtonUI -javax/swing/plaf/metal/MetalBorders -javax/swing/plaf/BorderUIResource$CompoundBorderUIResource -javax/swing/border/CompoundBorder -javax/swing/plaf/metal/MetalBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$MarginBorder -javax/swing/plaf/basic/BasicButtonListener -java/awt/AWTEventMulticaster -java/awt/event/WindowFocusListener -java/awt/event/WindowStateListener -java/awt/event/AdjustmentListener -java/awt/event/TextListener -javax/swing/event/AncestorListener -java/beans/VetoableChangeListener -javax/swing/ButtonGroup -javax/swing/JToggleButton$ToggleButtonModel -javax/swing/plaf/metal/MetalToggleButtonUI -javax/swing/plaf/basic/BasicToggleButtonUI -javax/swing/plaf/metal/MetalBorders$ToggleButtonBorder -java/awt/CardLayout -javax/swing/Box -javax/swing/plaf/metal/MetalBorders$TextFieldBorder -javax/swing/plaf/metal/MetalBorders$Flush3DBorder -javax/swing/BoxLayout -javax/swing/JMenuBar -javax/swing/DefaultSingleSelectionModel -javax/swing/SingleSelectionModel -javax/swing/plaf/basic/BasicMenuBarUI -javax/swing/plaf/MenuBarUI -javax/swing/plaf/basic/DefaultMenuLayout -javax/swing/plaf/metal/MetalBorders$MenuBarBorder -javax/swing/plaf/basic/BasicMenuBarUI$Handler -javax/swing/KeyboardManager -javax/swing/event/MenuEvent -javax/swing/JMenu$MenuChangeListener -javax/swing/JMenuItem$MenuItemFocusListener -javax/swing/plaf/basic/BasicMenuUI -javax/swing/plaf/basic/BasicMenuItemUI -javax/swing/plaf/MenuItemUI -javax/swing/plaf/metal/MetalBorders$MenuItemBorder -javax/swing/plaf/metal/MetalIconFactory -javax/swing/plaf/metal/MetalIconFactory$MenuArrowIcon -javax/swing/plaf/basic/BasicMenuUI$Handler -javax/swing/event/MenuKeyListener -javax/swing/plaf/basic/BasicMenuItemUI$Handler -javax/swing/event/MenuDragMouseListener -javax/swing/event/MouseInputListener -javax/swing/event/ChangeEvent -java/awt/event/ContainerEvent -javax/swing/plaf/metal/MetalIconFactory$MenuItemArrowIcon -javax/swing/JPopupMenu -javax/swing/plaf/basic/BasicPopupMenuUI -javax/swing/plaf/PopupMenuUI -javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper -java/awt/event/AWTEventListenerProxy -java/awt/Toolkit$SelectiveAWTEventListener -java/awt/Toolkit$ToolkitEventMulticaster -javax/swing/plaf/basic/BasicLookAndFeel$1 -javax/swing/plaf/metal/MetalBorders$PopupMenuBorder -javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener -javax/swing/event/PopupMenuListener -javax/swing/plaf/basic/BasicPopupMenuUI$BasicMenuKeyListener -javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber -javax/swing/MenuSelectionManager -javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper -javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper$1 -java/awt/event/FocusAdapter -javax/swing/JMenu$WinListener -java/awt/event/WindowAdapter -javax/swing/JPopupMenu$Separator -javax/swing/JSeparator -javax/swing/plaf/metal/MetalPopupMenuSeparatorUI -javax/swing/plaf/metal/MetalSeparatorUI -javax/swing/plaf/basic/BasicSeparatorUI -javax/swing/plaf/SeparatorUI -javax/swing/JComboBox -javax/swing/event/ListDataListener -javax/swing/event/CaretEvent -javax/swing/text/TabExpander -javax/swing/JScrollBar -java/awt/Adjustable -javax/swing/event/MouseInputAdapter -javax/swing/JScrollBar$ModelListener -javax/swing/DefaultBoundedRangeModel -javax/swing/BoundedRangeModel -javax/swing/plaf/metal/MetalScrollBarUI -javax/swing/plaf/basic/BasicScrollBarUI -javax/swing/plaf/ScrollBarUI -javax/swing/plaf/metal/MetalBumps -javax/swing/plaf/metal/MetalScrollButton -javax/swing/plaf/basic/BasicArrowButton -javax/swing/plaf/basic/BasicScrollBarUI$TrackListener -javax/swing/plaf/basic/BasicScrollBarUI$ArrowButtonListener -javax/swing/plaf/basic/BasicScrollBarUI$ModelListener -javax/swing/plaf/metal/MetalScrollBarUI$ScrollBarListener -javax/swing/plaf/basic/BasicScrollBarUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicScrollBarUI$Handler -javax/swing/plaf/basic/BasicScrollBarUI$ScrollListener -javax/swing/CellRendererPane -javax/swing/border/MatteBorder -sun/font/StandardGlyphVector -java/awt/font/GlyphVector -sun/font/StandardGlyphVector$GlyphStrike -sun/font/CoreMetrics -sun/font/FontLineMetrics -java/awt/font/LineMetrics -javax/swing/ComboBoxModel -javax/swing/ListModel -javax/swing/ListCellRenderer -javax/swing/DefaultComboBoxModel -javax/swing/MutableComboBoxModel -javax/swing/AbstractListModel -javax/swing/JComboBox$1 -javax/swing/AncestorNotifier -javax/swing/plaf/metal/MetalComboBoxUI -javax/swing/plaf/basic/BasicComboBoxUI -javax/swing/plaf/ComboBoxUI -javax/swing/plaf/metal/MetalComboBoxUI$MetalComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboPopup -javax/swing/plaf/basic/ComboPopup -javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass -javax/swing/border/LineBorder -javax/swing/plaf/basic/BasicComboPopup$1 -javax/swing/JList -javax/swing/DropMode -javax/swing/DefaultListSelectionModel -javax/swing/ListSelectionModel -javax/swing/plaf/basic/BasicListUI -javax/swing/plaf/ListUI -javax/swing/plaf/basic/BasicListUI$ListTransferHandler -javax/swing/TransferHandler -javax/swing/TransferHandler$TransferAction -javax/swing/DefaultListCellRenderer$UIResource -javax/swing/DefaultListCellRenderer -javax/swing/TransferHandler$SwingDropTarget -java/awt/dnd/DropTargetContext -javax/swing/TransferHandler$DropHandler -javax/swing/TransferHandler$TransferSupport -javax/swing/plaf/basic/BasicListUI$Handler -javax/swing/event/ListSelectionListener -javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag -javax/swing/plaf/basic/BasicComboPopup$Handler -javax/swing/JScrollPane -javax/swing/ScrollPaneConstants -javax/swing/ScrollPaneLayout$UIResource -javax/swing/ScrollPaneLayout -javax/swing/JViewport -javax/swing/ViewportLayout -javax/swing/plaf/basic/BasicViewportUI -javax/swing/plaf/ViewportUI -javax/swing/JScrollPane$ScrollBar -javax/swing/JViewport$ViewListener -java/awt/event/ComponentAdapter -javax/swing/plaf/metal/MetalScrollPaneUI -javax/swing/plaf/basic/BasicScrollPaneUI -javax/swing/plaf/ScrollPaneUI -javax/swing/plaf/metal/MetalBorders$ScrollPaneBorder -javax/swing/plaf/basic/BasicScrollPaneUI$Handler -javax/swing/plaf/metal/MetalScrollPaneUI$1 -javax/swing/plaf/basic/BasicComboBoxRenderer$UIResource -javax/swing/plaf/basic/BasicComboBoxRenderer -javax/swing/plaf/metal/MetalComboBoxEditor$UIResource -javax/swing/plaf/metal/MetalComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor -javax/swing/ComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField -javax/swing/JTextField$NotifyAction -javax/swing/text/TextAction -javax/swing/AbstractAction -javax/swing/text/JTextComponent$MutableCaretEvent -javax/swing/plaf/metal/MetalTextFieldUI -javax/swing/plaf/basic/BasicTextFieldUI -javax/swing/plaf/basic/BasicTextUI -javax/swing/text/ViewFactory -javax/swing/plaf/TextUI -javax/swing/plaf/basic/BasicTextUI$BasicCursor +javax/swing/text/AbstractDocument$InsertStringResult +javax/swing/text/AbstractDocument$LeafElement +javax/swing/text/AttributeSet +javax/swing/text/AttributeSet$CharacterAttribute +javax/swing/text/AttributeSet$ColorAttribute +javax/swing/text/AttributeSet$FontAttribute +javax/swing/text/AttributeSet$ParagraphAttribute +javax/swing/text/Caret +javax/swing/text/DefaultCaret +javax/swing/text/DefaultCaret$Handler javax/swing/text/DefaultEditorKit -javax/swing/text/EditorKit -javax/swing/text/DefaultEditorKit$InsertContentAction -javax/swing/text/DefaultEditorKit$DeletePrevCharAction -javax/swing/text/DefaultEditorKit$DeleteNextCharAction -javax/swing/text/DefaultEditorKit$ReadOnlyAction -javax/swing/text/DefaultEditorKit$DeleteWordAction -javax/swing/text/DefaultEditorKit$WritableAction -javax/swing/text/DefaultEditorKit$CutAction -javax/swing/text/DefaultEditorKit$CopyAction -javax/swing/text/DefaultEditorKit$PasteAction -javax/swing/text/DefaultEditorKit$VerticalPageAction -javax/swing/text/DefaultEditorKit$PageAction -javax/swing/text/DefaultEditorKit$InsertBreakAction javax/swing/text/DefaultEditorKit$BeepAction -javax/swing/text/DefaultEditorKit$NextVisualPositionAction -javax/swing/text/DefaultEditorKit$BeginWordAction -javax/swing/text/DefaultEditorKit$EndWordAction -javax/swing/text/DefaultEditorKit$PreviousWordAction -javax/swing/text/DefaultEditorKit$NextWordAction -javax/swing/text/DefaultEditorKit$BeginLineAction -javax/swing/text/DefaultEditorKit$EndLineAction -javax/swing/text/DefaultEditorKit$BeginParagraphAction -javax/swing/text/DefaultEditorKit$EndParagraphAction javax/swing/text/DefaultEditorKit$BeginAction -javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$BeginLineAction +javax/swing/text/DefaultEditorKit$BeginParagraphAction +javax/swing/text/DefaultEditorKit$BeginWordAction +javax/swing/text/DefaultEditorKit$CopyAction +javax/swing/text/DefaultEditorKit$CutAction javax/swing/text/DefaultEditorKit$DefaultKeyTypedAction +javax/swing/text/DefaultEditorKit$DeleteNextCharAction +javax/swing/text/DefaultEditorKit$DeletePrevCharAction +javax/swing/text/DefaultEditorKit$DeleteWordAction +javax/swing/text/DefaultEditorKit$DumpModelAction +javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$EndLineAction +javax/swing/text/DefaultEditorKit$EndParagraphAction +javax/swing/text/DefaultEditorKit$EndWordAction +javax/swing/text/DefaultEditorKit$InsertBreakAction +javax/swing/text/DefaultEditorKit$InsertContentAction javax/swing/text/DefaultEditorKit$InsertTabAction -javax/swing/text/DefaultEditorKit$SelectWordAction +javax/swing/text/DefaultEditorKit$NextVisualPositionAction +javax/swing/text/DefaultEditorKit$NextWordAction +javax/swing/text/DefaultEditorKit$PageAction +javax/swing/text/DefaultEditorKit$PasteAction +javax/swing/text/DefaultEditorKit$PreviousWordAction +javax/swing/text/DefaultEditorKit$ReadOnlyAction +javax/swing/text/DefaultEditorKit$SelectAllAction javax/swing/text/DefaultEditorKit$SelectLineAction javax/swing/text/DefaultEditorKit$SelectParagraphAction -javax/swing/text/DefaultEditorKit$SelectAllAction -javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$SelectWordAction javax/swing/text/DefaultEditorKit$ToggleComponentOrientationAction -javax/swing/text/DefaultEditorKit$DumpModelAction -javax/swing/plaf/basic/BasicTextUI$TextTransferHandler -javax/swing/text/Position$Bias -javax/swing/plaf/basic/BasicTextUI$RootView -javax/swing/text/View -javax/swing/plaf/basic/BasicTextUI$UpdateHandler -javax/swing/event/DocumentListener -javax/swing/plaf/basic/BasicTextUI$DragListener -javax/swing/plaf/basic/BasicComboBoxEditor$UIResource -javax/swing/plaf/basic/BasicTextUI$BasicCaret -javax/swing/text/DefaultCaret -javax/swing/text/Caret -javax/swing/text/DefaultCaret$Handler -java/awt/datatransfer/ClipboardOwner -javax/swing/plaf/basic/BasicTextUI$BasicHighlighter +javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$VerticalPageAction +javax/swing/text/DefaultEditorKit$WritableAction javax/swing/text/DefaultHighlighter -javax/swing/text/LayeredHighlighter +javax/swing/text/DefaultHighlighter$DefaultHighlightPainter +javax/swing/text/DefaultHighlighter$SafeDamager +javax/swing/text/Document +javax/swing/text/EditorKit +javax/swing/text/Element +javax/swing/text/FieldView +javax/swing/text/GapContent +javax/swing/text/GapContent$InsertUndo +javax/swing/text/GapContent$MarkData +javax/swing/text/GapContent$MarkVector +javax/swing/text/GapContent$StickyPosition +javax/swing/text/GapVector javax/swing/text/Highlighter javax/swing/text/Highlighter$Highlight -javax/swing/text/DefaultHighlighter$DefaultHighlightPainter -javax/swing/text/LayeredHighlighter$LayerPainter javax/swing/text/Highlighter$HighlightPainter -javax/swing/text/DefaultHighlighter$SafeDamager -javax/swing/text/FieldView -javax/swing/text/PlainView +javax/swing/text/JTextComponent +javax/swing/text/JTextComponent$1 javax/swing/text/JTextComponent$DefaultKeymap -javax/swing/text/Keymap -javax/swing/text/JTextComponent$KeymapWrapper javax/swing/text/JTextComponent$KeymapActionMap -javax/swing/plaf/basic/BasicTextUI$FocusAction -javax/swing/plaf/basic/BasicTextUI$TextActionWrapper -javax/swing/JTextArea -javax/swing/JEditorPane -javax/swing/JTextField$ScrollRepainter -javax/swing/plaf/metal/MetalComboBoxEditor$1 -javax/swing/plaf/metal/MetalComboBoxEditor$EditorBorder -javax/swing/plaf/metal/MetalComboBoxUI$MetalPropertyChangeListener -javax/swing/plaf/basic/BasicComboBoxUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicComboBoxUI$Handler -javax/swing/plaf/metal/MetalComboBoxButton -javax/swing/plaf/metal/MetalComboBoxIcon -javax/swing/plaf/metal/MetalComboBoxButton$1 -javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager -javax/swing/JComboBox$KeySelectionManager -javax/swing/JToolBar$DefaultToolBarLayout -javax/swing/plaf/metal/MetalToolBarUI -javax/swing/plaf/basic/BasicToolBarUI -javax/swing/plaf/ToolBarUI -javax/swing/plaf/metal/MetalBorders$ToolBarBorder -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue$1 -javax/swing/plaf/metal/MetalBorders$RolloverButtonBorder -javax/swing/plaf/metal/MetalBorders$RolloverMarginBorder -javax/swing/plaf/basic/BasicBorders$RadioButtonBorder -javax/swing/plaf/basic/BasicBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder -javax/swing/plaf/metal/MetalToolBarUI$MetalDockingListener -javax/swing/plaf/basic/BasicToolBarUI$DockingListener -javax/swing/plaf/basic/BasicToolBarUI$Handler -javax/swing/border/EtchedBorder -javax/swing/JToolBar$Separator -javax/swing/plaf/basic/BasicToolBarSeparatorUI -sun/font/FontDesignMetrics$MetricsKey -javax/swing/KeyboardManager$ComponentKeyStrokePair -sun/awt/EmbeddedFrame -sun/awt/im/InputMethodContext -java/awt/im/spi/InputMethodContext -sun/awt/im/InputContext -sun/awt/im/InputMethodManager -sun/awt/im/ExecutableInputMethodManager -sun/awt/X11/XInputMethodDescriptor -sun/awt/X11InputMethodDescriptor -java/awt/im/spi/InputMethodDescriptor -sun/awt/im/InputMethodLocator -sun/awt/im/ExecutableInputMethodManager$2 -sun/misc/Service -sun/misc/Service$LazyIterator -java/util/TreeSet -java/util/NavigableSet -java/util/SortedSet -javax/swing/SizeRequirements -javax/swing/plaf/basic/BasicGraphicsUtils -java/awt/event/AdjustmentEvent -java/awt/MenuBar -sun/awt/X11/XComponentPeer$2 -java/awt/SequencedEvent -java/beans/PropertyVetoException -java/awt/DefaultKeyboardFocusManager$TypeAheadMarker -java/awt/KeyboardFocusManager$HeavyweightFocusRequest -java/awt/KeyboardFocusManager$LightweightFocusRequest -sun/awt/X11/XFocusChangeEvent -sun/awt/X11/XComponentPeer$1 -sun/awt/X11/XTranslateCoordinates -sun/awt/KeyboardFocusManagerPeerImpl -sun/awt/SunToolkit$7 -java/awt/Window$1DisposeAction -java/awt/LightweightDispatcher$2 -sun/awt/X11/XUnmapEvent -java/io/StringWriter -javax/swing/JWindow -java/io/UnsupportedEncodingException -java/net/UnknownHostException -java/nio/channels/SocketChannel -java/nio/channels/spi/AbstractSelectableChannel -java/nio/channels/SelectableChannel -java/net/SocketImplFactory -javax/swing/UnsupportedLookAndFeelException -java/lang/UnsatisfiedLinkError -javax/swing/Box$Filler -javax/swing/JComponent$2 -sun/net/www/MimeTable -java/net/FileNameMap -sun/net/www/MimeTable$1 -sun/net/www/MimeEntry -java/net/URLConnection$1 -java/text/SimpleDateFormat -java/text/DateFormat -java/text/DateFormat$Field -java/util/Calendar -java/util/GregorianCalendar -sun/util/resources/CalendarData -sun/util/resources/LocaleNamesBundle -sun/util/resources/CalendarData_en -java/text/DateFormatSymbols -java/text/spi/DateFormatSymbolsProvider -sun/text/resources/FormatData -sun/text/resources/FormatData_en -sun/text/resources/FormatData_en_US -java/text/NumberFormat -java/text/spi/NumberFormatProvider -java/text/DecimalFormatSymbols -java/text/spi/DecimalFormatSymbolsProvider -java/util/Currency -java/util/Currency$1 -java/util/spi/CurrencyNameProvider -sun/util/resources/CurrencyNames -sun/util/resources/CurrencyNames_en_US -java/text/DecimalFormat -java/text/DigitList -java/math/RoundingMode -java/text/DontCareFieldPosition -java/text/DontCareFieldPosition$1 -java/text/Format$FieldDelegate -javax/swing/plaf/BorderUIResource -javax/swing/BorderFactory -javax/swing/border/BevelBorder -javax/swing/plaf/metal/MetalIconFactory$TreeFolderIcon -javax/swing/plaf/metal/MetalIconFactory$FolderIcon16 -java/util/zip/ZipInputStream -java/io/PushbackInputStream -java/util/zip/CRC32 -java/util/zip/Checksum -java/lang/Thread$State -javax/swing/SwingUtilities$SharedOwnerFrame -javax/swing/JTable -javax/swing/event/TableModelListener -javax/swing/event/TableColumnModelListener -javax/swing/event/CellEditorListener -javax/swing/event/RowSorterListener -java/awt/GraphicsCallback$PaintCallback -java/awt/GraphicsCallback -sun/awt/SunGraphicsCallback -javax/swing/BufferStrategyPaintManager$BufferInfo -java/awt/Component$BltSubRegionBufferStrategy -sun/awt/SubRegionShowable -java/awt/Component$BltBufferStrategy -sun/awt/image/SunVolatileImage -sun/awt/image/BufferedImageGraphicsConfig -sun/print/PrinterGraphicsConfig -sun/awt/image/VolatileSurfaceManager -javax/swing/JRadioButton -java/lang/ClassFormatError -java/awt/print/PrinterGraphics -java/awt/PrintGraphics -javax/swing/JTabbedPane -javax/swing/JTabbedPane$ModelListener -javax/swing/plaf/metal/MetalTabbedPaneUI -javax/swing/plaf/basic/BasicTabbedPaneUI -javax/swing/plaf/TabbedPaneUI -javax/swing/plaf/metal/MetalTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneScrollLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$Handler -sun/swing/ImageIconUIResource -javax/swing/GrayFilter -java/awt/image/RGBImageFilter -java/awt/image/ImageFilter -java/awt/image/FilteredImageSource -org/w3c/dom/Node -org/xml/sax/SAXException -javax/xml/parsers/ParserConfigurationException -org/xml/sax/EntityResolver -java/security/NoSuchAlgorithmException -java/security/GeneralSecurityException -java/util/zip/GZIPInputStream -java/util/zip/DeflaterOutputStream -org/xml/sax/InputSource -javax/xml/parsers/DocumentBuilderFactory -javax/xml/parsers/FactoryFinder -javax/xml/parsers/SecuritySupport -javax/xml/parsers/SecuritySupport$2 -javax/xml/parsers/SecuritySupport$5 -javax/xml/parsers/SecuritySupport$1 -javax/xml/parsers/SecuritySupport$4 -javax/xml/parsers/DocumentBuilder -org/w3c/dom/Document -org/xml/sax/helpers/DefaultHandler -org/xml/sax/DTDHandler -org/xml/sax/ContentHandler -org/xml/sax/ErrorHandler -org/xml/sax/SAXNotSupportedException -org/xml/sax/Locator -org/xml/sax/SAXNotRecognizedException -org/xml/sax/SAXParseException -org/w3c/dom/NodeList -org/w3c/dom/events/EventTarget -org/w3c/dom/traversal/DocumentTraversal -org/w3c/dom/events/DocumentEvent -org/w3c/dom/ranges/DocumentRange -org/w3c/dom/Entity -org/w3c/dom/Element -org/w3c/dom/CharacterData -org/w3c/dom/CDATASection -org/w3c/dom/Text -org/xml/sax/AttributeList -org/w3c/dom/DOMException -org/w3c/dom/Notation -org/w3c/dom/DocumentType -org/w3c/dom/Attr -org/w3c/dom/EntityReference -org/w3c/dom/ProcessingInstruction -org/w3c/dom/Comment -org/w3c/dom/DocumentFragment -org/w3c/dom/events/Event -org/w3c/dom/events/MutationEvent -org/w3c/dom/traversal/TreeWalker -org/w3c/dom/ranges/Range -org/w3c/dom/traversal/NodeIterator -org/w3c/dom/events/EventException -org/w3c/dom/NamedNodeMap -java/awt/GridLayout -javax/swing/plaf/metal/MetalRadioButtonUI -javax/swing/plaf/basic/BasicRadioButtonUI -javax/swing/plaf/basic/BasicBorders -javax/swing/plaf/metal/MetalIconFactory$RadioButtonIcon -java/awt/event/ItemEvent -java/awt/CardLayout$Card -javax/swing/JCheckBox -javax/swing/event/ListSelectionEvent -javax/swing/plaf/metal/MetalCheckBoxUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxIcon -java/lang/ExceptionInInitializerError -com/sun/java/swing/plaf/windows/WindowsTabbedPaneUI -javax/swing/JProgressBar -javax/swing/JProgressBar$ModelListener -javax/swing/plaf/metal/MetalProgressBarUI -javax/swing/plaf/basic/BasicProgressBarUI -javax/swing/plaf/ProgressBarUI -javax/swing/plaf/BorderUIResource$LineBorderUIResource -javax/swing/plaf/basic/BasicProgressBarUI$Handler -javax/swing/tree/TreeModel -javax/swing/table/TableCellRenderer -javax/swing/table/JTableHeader -javax/swing/event/TreeExpansionListener -javax/swing/table/AbstractTableModel -javax/swing/table/TableModel -javax/swing/table/DefaultTableCellRenderer -javax/swing/JTree -javax/swing/tree/TreeSelectionModel -javax/swing/tree/DefaultTreeCellRenderer -javax/swing/tree/TreeCellRenderer -javax/swing/table/TableCellEditor -javax/swing/CellEditor -javax/swing/JToolTip -javax/swing/table/TableColumn -javax/swing/table/DefaultTableColumnModel -javax/swing/table/TableColumnModel -javax/swing/table/DefaultTableModel -javax/swing/event/TableModelEvent -sun/swing/table/DefaultTableCellHeaderRenderer -javax/swing/plaf/basic/BasicTableHeaderUI -javax/swing/plaf/TableHeaderUI -javax/swing/plaf/basic/BasicTableHeaderUI$1 -javax/swing/plaf/basic/BasicTableHeaderUI$MouseInputHandler -javax/swing/DefaultCellEditor -javax/swing/tree/TreeCellEditor -javax/swing/AbstractCellEditor -javax/swing/plaf/basic/BasicTableUI -javax/swing/plaf/TableUI -javax/swing/plaf/basic/BasicTableUI$TableTransferHandler -javax/swing/plaf/basic/BasicTableUI$Handler -javax/swing/tree/DefaultTreeSelectionModel -javax/swing/tree/TreePath -javax/swing/plaf/metal/MetalTreeUI -javax/swing/plaf/basic/BasicTreeUI -javax/swing/plaf/TreeUI -javax/swing/plaf/basic/BasicTreeUI$Actions -javax/swing/plaf/basic/BasicTreeUI$TreeTransferHandler -javax/swing/plaf/metal/MetalTreeUI$LineListener -javax/swing/plaf/basic/BasicTreeUI$Handler -javax/swing/event/TreeModelListener -javax/swing/event/TreeSelectionListener -javax/swing/event/SwingPropertyChangeSupport -javax/swing/tree/VariableHeightLayoutCache +javax/swing/text/JTextComponent$KeymapWrapper +javax/swing/text/JTextComponent$MutableCaretEvent +javax/swing/text/Keymap +javax/swing/text/LayeredHighlighter +javax/swing/text/LayeredHighlighter$LayerPainter +javax/swing/text/MutableAttributeSet +javax/swing/text/PlainDocument +javax/swing/text/PlainView +javax/swing/text/Position +javax/swing/text/Position$Bias +javax/swing/text/Segment +javax/swing/text/SegmentCache +javax/swing/text/SegmentCache$CachedSegment +javax/swing/text/SimpleAttributeSet +javax/swing/text/SimpleAttributeSet$EmptyAttributeSet +javax/swing/text/Style +javax/swing/text/StyleConstants +javax/swing/text/StyleConstants$CharacterConstants +javax/swing/text/StyleConstants$ColorConstants +javax/swing/text/StyleConstants$FontConstants +javax/swing/text/StyleConstants$ParagraphConstants +javax/swing/text/StyleContext +javax/swing/text/StyleContext$FontKey +javax/swing/text/StyleContext$KeyEnumeration +javax/swing/text/StyleContext$NamedStyle +javax/swing/text/StyleContext$SmallAttributeSet +javax/swing/text/TabExpander +javax/swing/text/TextAction +javax/swing/text/Utilities +javax/swing/text/View +javax/swing/text/ViewFactory javax/swing/tree/AbstractLayoutCache -javax/swing/tree/RowMapper -javax/swing/plaf/basic/BasicTreeUI$NodeDimensionsHandler javax/swing/tree/AbstractLayoutCache$NodeDimensions -javax/swing/JTree$TreeModelHandler -javax/swing/tree/VariableHeightLayoutCache$TreeStateNode javax/swing/tree/DefaultMutableTreeNode -javax/swing/tree/MutableTreeNode javax/swing/tree/DefaultMutableTreeNode$PreorderEnumeration -javax/swing/event/TableColumnModelEvent -java/text/ParseException -java/text/NumberFormat$Field -javax/swing/event/UndoableEditListener -javax/swing/filechooser/FileFilter -javax/swing/tree/DefaultTreeModel javax/swing/tree/DefaultTreeCellEditor javax/swing/tree/DefaultTreeCellEditor$1 javax/swing/tree/DefaultTreeCellEditor$DefaultTextField -javax/swing/DefaultCellEditor$1 -javax/swing/DefaultCellEditor$EditorDelegate javax/swing/tree/DefaultTreeCellEditor$EditorContainer -javax/swing/JTree$TreeSelectionRedirector -javax/swing/event/TreeModelEvent -javax/swing/plaf/metal/MetalSplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneUI -javax/swing/plaf/SplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneDivider -javax/swing/plaf/basic/BasicBorders$SplitPaneBorder -javax/swing/plaf/metal/MetalSplitPaneDivider -javax/swing/plaf/basic/BasicSplitPaneDivider$DividerLayout -javax/swing/plaf/basic/BasicSplitPaneDivider$MouseHandler -javax/swing/plaf/basic/BasicBorders$SplitPaneDividerBorder -javax/swing/plaf/basic/BasicSplitPaneUI$BasicHorizontalLayoutManager -javax/swing/plaf/basic/BasicSplitPaneUI$1 -javax/swing/plaf/basic/BasicSplitPaneUI$Handler -javax/swing/plaf/metal/MetalSplitPaneDivider$1 -javax/swing/plaf/basic/BasicSplitPaneDivider$OneTouchActionHandler -javax/swing/plaf/metal/MetalSplitPaneDivider$2 -javax/swing/border/TitledBorder -javax/swing/plaf/basic/BasicTextAreaUI -java/util/Collections$UnmodifiableCollection$1 -java/io/InterruptedIOException -java/net/NoRouteToHostException -java/net/BindException +javax/swing/tree/DefaultTreeCellRenderer +javax/swing/tree/DefaultTreeModel +javax/swing/tree/DefaultTreeSelectionModel +javax/swing/tree/MutableTreeNode javax/swing/tree/PathPlaceHolder -javax/swing/event/TreeSelectionEvent -javax/swing/JList$3 -javax/swing/JList$ListSelectionHandler -javax/swing/JSlider -javax/swing/JSlider$ModelListener -javax/swing/plaf/metal/MetalSliderUI -javax/swing/plaf/basic/BasicSliderUI -javax/swing/plaf/SliderUI -javax/swing/plaf/basic/BasicSliderUI$Actions -javax/swing/plaf/metal/MetalIconFactory$HorizontalSliderThumbIcon -javax/swing/plaf/metal/MetalIconFactory$VerticalSliderThumbIcon -javax/swing/plaf/basic/BasicSliderUI$TrackListener -javax/swing/plaf/basic/BasicSliderUI$Handler -javax/swing/plaf/basic/BasicSliderUI$ScrollListener -javax/swing/plaf/metal/MetalSliderUI$MetalPropertyListener -javax/swing/plaf/basic/BasicSliderUI$PropertyChangeHandler -java/util/Hashtable$KeySet -sun/font/Type1Font$1 -java/nio/channels/FileChannel$MapMode -sun/nio/ch/FileChannelImpl$Unmapper -sun/nio/ch/Util$3 -java/nio/DirectByteBufferR -sun/nio/cs/US_ASCII$Decoder -sun/font/Type1Font$2 -sun/font/Type1GlyphMapper -javax/swing/DefaultListModel -javax/swing/event/ListDataEvent -javax/sound/sampled/DataLine -javax/sound/sampled/Line -javax/sound/sampled/Line$Info -javax/sound/sampled/DataLine$Info -javax/sound/sampled/Control$Type -javax/sound/sampled/FloatControl$Type -javax/sound/sampled/LineUnavailableException -javax/sound/sampled/UnsupportedAudioFileException -javax/swing/JRadioButtonMenuItem -javax/swing/JMenuItem$AccessibleJMenuItem -javax/swing/AbstractButton$AccessibleAbstractButton -javax/accessibility/AccessibleAction -javax/accessibility/AccessibleValue -javax/accessibility/AccessibleText -javax/accessibility/AccessibleExtendedComponent -javax/accessibility/AccessibleComponent -javax/swing/JComponent$AccessibleJComponent -java/awt/Container$AccessibleAWTContainer -java/awt/Component$AccessibleAWTComponent -javax/accessibility/AccessibleRelationSet -javax/accessibility/AccessibleState -javax/accessibility/AccessibleBundle -javax/swing/plaf/basic/BasicCheckBoxMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxMenuItemIcon -javax/swing/JCheckBoxMenuItem$AccessibleJCheckBoxMenuItem -javax/swing/plaf/basic/BasicRadioButtonMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$RadioButtonMenuItemIcon +javax/swing/tree/RowMapper +javax/swing/tree/TreeCellEditor +javax/swing/tree/TreeCellRenderer +javax/swing/tree/TreeModel +javax/swing/tree/TreeNode +javax/swing/tree/TreePath +javax/swing/tree/TreeSelectionModel +javax/swing/tree/VariableHeightLayoutCache +javax/swing/tree/VariableHeightLayoutCache$TreeStateNode +javax/swing/undo/AbstractUndoableEdit +javax/swing/undo/CompoundEdit +javax/swing/undo/UndoableEdit +javax/xml/parsers/DocumentBuilder +javax/xml/parsers/DocumentBuilderFactory +javax/xml/parsers/FactoryFinder +javax/xml/parsers/FactoryFinder$1 +javax/xml/parsers/ParserConfigurationException +javax/xml/parsers/SecuritySupport +javax/xml/parsers/SecuritySupport$2 +javax/xml/parsers/SecuritySupport$5 +org/w3c/dom/Attr +org/w3c/dom/CDATASection +org/w3c/dom/CharacterData +org/w3c/dom/Comment +org/w3c/dom/DOMException +org/w3c/dom/Document +org/w3c/dom/DocumentFragment +org/w3c/dom/DocumentType +org/w3c/dom/Element +org/w3c/dom/Entity +org/w3c/dom/EntityReference +org/w3c/dom/NamedNodeMap +org/w3c/dom/Node +org/w3c/dom/NodeList +org/w3c/dom/Notation +org/w3c/dom/ProcessingInstruction +org/w3c/dom/Text +org/w3c/dom/events/DocumentEvent +org/w3c/dom/events/Event +org/w3c/dom/events/EventException +org/w3c/dom/events/EventTarget +org/w3c/dom/events/MutationEvent +org/w3c/dom/ranges/DocumentRange +org/w3c/dom/ranges/Range +org/w3c/dom/traversal/DocumentTraversal +org/w3c/dom/traversal/NodeIterator +org/w3c/dom/traversal/TreeWalker +org/xml/sax/AttributeList +org/xml/sax/ContentHandler +org/xml/sax/DTDHandler +org/xml/sax/EntityResolver +org/xml/sax/ErrorHandler +org/xml/sax/InputSource +org/xml/sax/Locator +org/xml/sax/SAXException +org/xml/sax/SAXNotRecognizedException +org/xml/sax/SAXNotSupportedException +org/xml/sax/SAXParseException +org/xml/sax/helpers/DefaultHandler +sun/awt/AWTAccessor +sun/awt/AWTAccessor$AWTEventAccessor +sun/awt/AWTAccessor$ClientPropertyKeyAccessor +sun/awt/AWTAccessor$ComponentAccessor +sun/awt/AWTAccessor$ContainerAccessor +sun/awt/AWTAccessor$CursorAccessor +sun/awt/AWTAccessor$DefaultKeyboardFocusManagerAccessor +sun/awt/AWTAccessor$EventQueueAccessor +sun/awt/AWTAccessor$FrameAccessor +sun/awt/AWTAccessor$InputEventAccessor +sun/awt/AWTAccessor$InvocationEventAccessor +sun/awt/AWTAccessor$KeyEventAccessor +sun/awt/AWTAccessor$KeyboardFocusManagerAccessor +sun/awt/AWTAccessor$SequencedEventAccessor +sun/awt/AWTAccessor$ToolkitAccessor +sun/awt/AWTAccessor$WindowAccessor +sun/awt/AWTAutoShutdown +sun/awt/AWTIcon64_java_icon16_png +sun/awt/AWTIcon64_java_icon24_png +sun/awt/AWTIcon64_java_icon32_png +sun/awt/AWTIcon64_java_icon48_png +sun/awt/AppContext +sun/awt/AppContext$1 +sun/awt/AppContext$2 +sun/awt/AppContext$3 +sun/awt/AppContext$6 +sun/awt/AppContext$GetAppContextLock +sun/awt/AppContext$State +sun/awt/CausedFocusEvent +sun/awt/CausedFocusEvent$Cause +sun/awt/ComponentFactory +sun/awt/ConstrainableGraphics +sun/awt/DisplayChangedListener +sun/awt/EmbeddedFrame +sun/awt/EventQueueDelegate +sun/awt/EventQueueItem +sun/awt/FontConfiguration +sun/awt/FontConfiguration$1 +sun/awt/FontDescriptor +sun/awt/GlobalCursorManager +sun/awt/GlobalCursorManager$NativeUpdater +sun/awt/HeadlessToolkit +sun/awt/IconInfo +sun/awt/InputMethodSupport +sun/awt/KeyboardFocusManagerPeerImpl +sun/awt/KeyboardFocusManagerPeerProvider +sun/awt/LightweightFrame +sun/awt/ModalityListener +sun/awt/MostRecentKeyValue +sun/awt/NullComponentPeer +sun/awt/OSInfo +sun/awt/OSInfo$1 +sun/awt/OSInfo$OSType +sun/awt/OSInfo$WindowsVersion +sun/awt/PaintEventDispatcher +sun/awt/PeerEvent +sun/awt/PostEventQueue +sun/awt/RepaintArea +sun/awt/RequestFocusController +sun/awt/SubRegionShowable +sun/awt/SunDisplayChanger +sun/awt/SunGraphicsCallback +sun/awt/SunHints +sun/awt/SunHints$Key +sun/awt/SunHints$LCDContrastKey +sun/awt/SunHints$Value +sun/awt/SunToolkit +sun/awt/SunToolkit$ModalityListenerList +sun/awt/TimedWindowEvent +sun/awt/UNIXToolkit +sun/awt/WindowClosingListener +sun/awt/WindowClosingSupport +sun/awt/X11/AwtGraphicsConfigData +sun/awt/X11/AwtScreenData +sun/awt/X11/MotifColorUtilities +sun/awt/X11/MotifDnDConstants +sun/awt/X11/MotifDnDDragSourceProtocol +sun/awt/X11/MotifDnDDropTargetProtocol +sun/awt/X11/Native +sun/awt/X11/Native$1 +sun/awt/X11/OwnershipListener +sun/awt/X11/PropMwmHints +sun/awt/X11/UnsafeXDisposerRecord +sun/awt/X11/WindowDimensions +sun/awt/X11/WindowPropertyGetter +sun/awt/X11/XAWTXSettings +sun/awt/X11/XAnyEvent +sun/awt/X11/XAtom +sun/awt/X11/XAtomList +sun/awt/X11/XAwtState +sun/awt/X11/XBaseWindow +sun/awt/X11/XBaseWindow$1 +sun/awt/X11/XBaseWindow$InitialiseState +sun/awt/X11/XBaseWindow$StateLock +sun/awt/X11/XCanvasPeer +sun/awt/X11/XClientMessageEvent +sun/awt/X11/XClipboard +sun/awt/X11/XComponentPeer +sun/awt/X11/XComponentPeer$1 +sun/awt/X11/XConfigureEvent +sun/awt/X11/XContentWindow +sun/awt/X11/XCreateWindowParams +sun/awt/X11/XDecoratedPeer +sun/awt/X11/XDnDConstants +sun/awt/X11/XDnDDragSourceProtocol +sun/awt/X11/XDnDDropTargetProtocol +sun/awt/X11/XDragAndDropProtocols +sun/awt/X11/XDragSourceContextPeer +sun/awt/X11/XDragSourceProtocol +sun/awt/X11/XDragSourceProtocolListener +sun/awt/X11/XDropTargetContextPeer +sun/awt/X11/XDropTargetContextPeer$XDropTargetProtocolListenerImpl +sun/awt/X11/XDropTargetEventProcessor +sun/awt/X11/XDropTargetProtocol +sun/awt/X11/XDropTargetProtocolListener +sun/awt/X11/XDropTargetRegistry +sun/awt/X11/XEmbeddedFramePeer +sun/awt/X11/XErrorEvent +sun/awt/X11/XErrorHandler +sun/awt/X11/XErrorHandler$IgnoreBadWindowHandler +sun/awt/X11/XErrorHandler$VerifyChangePropertyHandler +sun/awt/X11/XErrorHandler$XBaseErrorHandler +sun/awt/X11/XErrorHandler$XErrorHandlerWithFlag +sun/awt/X11/XErrorHandler$XShmAttachHandler +sun/awt/X11/XErrorHandlerUtil +sun/awt/X11/XEvent +sun/awt/X11/XEventDispatcher +sun/awt/X11/XExposeEvent +sun/awt/X11/XFocusChangeEvent +sun/awt/X11/XFocusProxyWindow +sun/awt/X11/XFramePeer +sun/awt/X11/XGlobalCursorManager +sun/awt/X11/XInputMethod +sun/awt/X11/XInputMethodDescriptor +sun/awt/X11/XKeyboardFocusManagerPeer +sun/awt/X11/XLabelPeer +sun/awt/X11/XLayerProtocol +sun/awt/X11/XMSelection +sun/awt/X11/XMSelection$1 +sun/awt/X11/XMSelection$3 +sun/awt/X11/XMSelectionListener +sun/awt/X11/XModifierKeymap +sun/awt/X11/XNETProtocol +sun/awt/X11/XPanelPeer +sun/awt/X11/XPropertyCache +sun/awt/X11/XPropertyEvent +sun/awt/X11/XProtocol +sun/awt/X11/XRepaintArea +sun/awt/X11/XReparentEvent +sun/awt/X11/XRootWindow +sun/awt/X11/XSelection +sun/awt/X11/XSelection$IncrementalTransferHandler +sun/awt/X11/XSelection$SelectionEventHandler +sun/awt/X11/XSetWindowAttributes +sun/awt/X11/XSizeHints +sun/awt/X11/XStateProtocol +sun/awt/X11/XSystemTrayPeer +sun/awt/X11/XToolkit +sun/awt/X11/XToolkit$1 +sun/awt/X11/XToolkit$2 +sun/awt/X11/XToolkit$2$1 +sun/awt/X11/XToolkit$3 +sun/awt/X11/XToolkit$4 +sun/awt/X11/XToolkit$5 +sun/awt/X11/XTranslateCoordinates +sun/awt/X11/XUnmapEvent +sun/awt/X11/XVisibilityEvent +sun/awt/X11/XVisualInfo +sun/awt/X11/XWINProtocol +sun/awt/X11/XWM +sun/awt/X11/XWM$1 +sun/awt/X11/XWMHints +sun/awt/X11/XWindow +sun/awt/X11/XWindowAttributes +sun/awt/X11/XWindowAttributesData +sun/awt/X11/XWindowPeer +sun/awt/X11/XWindowPeer$2 +sun/awt/X11/XWindowPeer$4 +sun/awt/X11/XWrapperBase +sun/awt/X11/XlibUtil +sun/awt/X11/XlibWrapper +sun/awt/X11ComponentPeer +sun/awt/X11FontManager +sun/awt/X11GraphicsConfig +sun/awt/X11GraphicsConfig$X11GCDisposerRecord +sun/awt/X11GraphicsDevice +sun/awt/X11GraphicsEnvironment +sun/awt/X11GraphicsEnvironment$1 +sun/awt/X11InputMethod +sun/awt/X11InputMethodDescriptor +sun/awt/XSettings +sun/awt/XSettings$Update +sun/awt/datatransfer/SunClipboard +sun/awt/dnd/SunDragSourceContextPeer +sun/awt/dnd/SunDropTargetContextPeer +sun/awt/dnd/SunDropTargetEvent +sun/awt/event/IgnorePaintEvent +sun/awt/im/ExecutableInputMethodManager +sun/awt/im/ExecutableInputMethodManager$3 +sun/awt/im/InputContext +sun/awt/im/InputMethodAdapter +sun/awt/im/InputMethodContext +sun/awt/im/InputMethodLocator +sun/awt/im/InputMethodManager +sun/awt/image/BufImgSurfaceData +sun/awt/image/BufImgSurfaceData$ICMColorData +sun/awt/image/BufImgSurfaceManager +sun/awt/image/BufferedImageGraphicsConfig +sun/awt/image/ByteComponentRaster +sun/awt/image/ByteInterleavedRaster +sun/awt/image/BytePackedRaster +sun/awt/image/FetcherInfo +sun/awt/image/GifFrame +sun/awt/image/GifImageDecoder +sun/awt/image/ImageConsumerQueue +sun/awt/image/ImageDecoder sun/awt/image/ImageDecoder$1 -javax/swing/JTabbedPane$Page -java/net/DatagramSocket -java/net/MulticastSocket -java/net/DatagramPacket +sun/awt/image/ImageFetchable +sun/awt/image/ImageFetcher +sun/awt/image/ImageFetcher$1 +sun/awt/image/ImageRepresentation +sun/awt/image/ImageWatched +sun/awt/image/ImageWatched$Link +sun/awt/image/ImageWatched$WeakLink +sun/awt/image/InputStreamImageSource +sun/awt/image/IntegerComponentRaster +sun/awt/image/IntegerInterleavedRaster +sun/awt/image/NativeLibLoader +sun/awt/image/NativeLibLoader$1 +sun/awt/image/OffScreenImage +sun/awt/image/PNGFilterInputStream +sun/awt/image/PNGImageDecoder +sun/awt/image/PixelConverter +sun/awt/image/PixelConverter$Argb +sun/awt/image/PixelConverter$ArgbBm +sun/awt/image/PixelConverter$ArgbPre +sun/awt/image/PixelConverter$Bgrx +sun/awt/image/PixelConverter$ByteGray +sun/awt/image/PixelConverter$Rgba +sun/awt/image/PixelConverter$RgbaPre +sun/awt/image/PixelConverter$Rgbx +sun/awt/image/PixelConverter$Ushort4444Argb +sun/awt/image/PixelConverter$Ushort555Rgb +sun/awt/image/PixelConverter$Ushort555Rgbx +sun/awt/image/PixelConverter$Ushort565Rgb +sun/awt/image/PixelConverter$UshortGray +sun/awt/image/PixelConverter$Xbgr +sun/awt/image/PixelConverter$Xrgb +sun/awt/image/SunVolatileImage +sun/awt/image/SunWritableRaster +sun/awt/image/SunWritableRaster$DataStealer +sun/awt/image/SurfaceManager +sun/awt/image/SurfaceManager$FlushableCacheData +sun/awt/image/SurfaceManager$ImageAccessor +sun/awt/image/SurfaceManager$ProxiedGraphicsConfig +sun/awt/image/ToolkitImage +sun/awt/image/URLImageSource +sun/awt/image/VolatileSurfaceManager +sun/awt/motif/MFontConfiguration +sun/awt/resources/awt +sun/awt/util/IdentityArrayList +sun/dc/DuctusRenderingEngine +sun/font/AttributeValues +sun/font/CMap +sun/font/CMap$CMapFormat12 +sun/font/CMap$NullCMapClass +sun/font/CharToGlyphMapper +sun/font/CompositeFont +sun/font/CompositeFontDescriptor +sun/font/CompositeGlyphMapper +sun/font/CompositeStrike +sun/font/CoreMetrics +sun/font/EAttribute +sun/font/FcFontConfiguration +sun/font/FileFont +sun/font/FileFontStrike +sun/font/Font2D +sun/font/Font2DHandle +sun/font/FontAccess +sun/font/FontConfigManager +sun/font/FontConfigManager$FcCompFont +sun/font/FontConfigManager$FontConfigFont +sun/font/FontConfigManager$FontConfigInfo +sun/font/FontDesignMetrics +sun/font/FontDesignMetrics$KeyReference +sun/font/FontDesignMetrics$MetricsKey +sun/font/FontFamily +sun/font/FontLineMetrics +sun/font/FontManager +sun/font/FontManagerFactory +sun/font/FontManagerFactory$1 +sun/font/FontManagerForSGE +sun/font/FontManagerNativeLibrary +sun/font/FontManagerNativeLibrary$1 +sun/font/FontScaler +sun/font/FontStrike +sun/font/FontStrikeDesc +sun/font/FontStrikeDisposer +sun/font/FontUtilities +sun/font/FontUtilities$1 +sun/font/GlyphDisposedListener +sun/font/GlyphList +sun/font/PhysicalFont +sun/font/PhysicalStrike +sun/font/StandardGlyphVector +sun/font/StandardGlyphVector$GlyphStrike +sun/font/StrikeCache +sun/font/StrikeCache$1 +sun/font/StrikeCache$DisposableStrike +sun/font/StrikeCache$SoftDisposerRef +sun/font/StrikeMetrics +sun/font/SunFontManager +sun/font/SunFontManager$1 +sun/font/SunFontManager$11 +sun/font/SunFontManager$13 +sun/font/SunFontManager$2 +sun/font/SunFontManager$3 +sun/font/SunFontManager$FontRegistrationInfo +sun/font/SunFontManager$T1Filter +sun/font/SunFontManager$TTFilter +sun/font/T2KFontScaler +sun/font/T2KFontScaler$1 +sun/font/TrueTypeFont +sun/font/TrueTypeFont$1 +sun/font/TrueTypeFont$DirectoryEntry +sun/font/TrueTypeFont$TTDisposerRecord +sun/font/TrueTypeGlyphMapper +sun/font/Type1Font +sun/font/Type1Font$1 +sun/font/XRGlyphCache +sun/font/XRGlyphCacheEntry +sun/font/XRTextRenderer +sun/java2d/BackBufferCapsProvider +sun/java2d/DefaultDisposerRecord +sun/java2d/DestSurfaceProvider +sun/java2d/Disposer +sun/java2d/Disposer$1 +sun/java2d/Disposer$2 +sun/java2d/Disposer$PollDisposable +sun/java2d/DisposerRecord +sun/java2d/DisposerTarget +sun/java2d/FontSupport +sun/java2d/InvalidPipeException +sun/java2d/NullSurfaceData +sun/java2d/StateTrackable +sun/java2d/StateTrackable$State +sun/java2d/StateTrackableDelegate +sun/java2d/StateTrackableDelegate$1 +sun/java2d/StateTrackableDelegate$2 +sun/java2d/StateTracker +sun/java2d/StateTracker$1 +sun/java2d/StateTracker$2 +sun/java2d/SunGraphics2D +sun/java2d/SunGraphicsEnvironment +sun/java2d/SunGraphicsEnvironment$1 +sun/java2d/Surface +sun/java2d/SurfaceData +sun/java2d/SurfaceData$PixelToPgramLoopConverter +sun/java2d/SurfaceData$PixelToShapeLoopConverter +sun/java2d/SurfaceDataProxy +sun/java2d/SurfaceDataProxy$1 +sun/java2d/SurfaceManagerFactory +sun/java2d/UnixSurfaceManagerFactory +sun/java2d/cmm/CMSManager +sun/java2d/cmm/ProfileActivator +sun/java2d/cmm/ProfileDeferralInfo +sun/java2d/cmm/ProfileDeferralMgr +sun/java2d/jules/JulesPathBuf +sun/java2d/jules/JulesPathBuf$1 +sun/java2d/loops/Blit +sun/java2d/loops/BlitBg +sun/java2d/loops/CompositeType +sun/java2d/loops/CustomComponent +sun/java2d/loops/DrawGlyphList +sun/java2d/loops/DrawGlyphListAA +sun/java2d/loops/DrawGlyphListLCD +sun/java2d/loops/DrawLine +sun/java2d/loops/DrawParallelogram +sun/java2d/loops/DrawPath +sun/java2d/loops/DrawPolygons +sun/java2d/loops/DrawRect +sun/java2d/loops/FillParallelogram +sun/java2d/loops/FillPath +sun/java2d/loops/FillRect +sun/java2d/loops/FillSpans +sun/java2d/loops/FontInfo +sun/java2d/loops/GeneralRenderer +sun/java2d/loops/GraphicsPrimitive +sun/java2d/loops/GraphicsPrimitiveMgr +sun/java2d/loops/GraphicsPrimitiveMgr$1 +sun/java2d/loops/GraphicsPrimitiveMgr$2 +sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec +sun/java2d/loops/GraphicsPrimitiveProxy +sun/java2d/loops/MaskBlit +sun/java2d/loops/MaskFill +sun/java2d/loops/ProcessPath +sun/java2d/loops/ProcessPath$1 +sun/java2d/loops/ProcessPath$ActiveEdgeList +sun/java2d/loops/ProcessPath$DrawHandler +sun/java2d/loops/ProcessPath$Edge +sun/java2d/loops/ProcessPath$EndSubPathHandler +sun/java2d/loops/ProcessPath$FillData +sun/java2d/loops/ProcessPath$FillProcessHandler +sun/java2d/loops/ProcessPath$Point +sun/java2d/loops/ProcessPath$ProcessHandler +sun/java2d/loops/RenderCache +sun/java2d/loops/RenderCache$Entry +sun/java2d/loops/RenderLoops +sun/java2d/loops/ScaledBlit +sun/java2d/loops/SurfaceType +sun/java2d/loops/TransformBlit +sun/java2d/loops/TransformHelper +sun/java2d/loops/XORComposite +sun/java2d/opengl/GLXGraphicsConfig +sun/java2d/opengl/OGLGraphicsConfig +sun/java2d/pipe/AAShapePipe +sun/java2d/pipe/AATextRenderer +sun/java2d/pipe/AlphaColorPipe +sun/java2d/pipe/AlphaPaintPipe +sun/java2d/pipe/CompositePipe +sun/java2d/pipe/DrawImage +sun/java2d/pipe/DrawImagePipe +sun/java2d/pipe/GeneralCompositePipe +sun/java2d/pipe/GlyphListLoopPipe +sun/java2d/pipe/GlyphListPipe +sun/java2d/pipe/LCDTextRenderer +sun/java2d/pipe/LoopBasedPipe +sun/java2d/pipe/LoopPipe +sun/java2d/pipe/NullPipe +sun/java2d/pipe/OutlineTextRenderer +sun/java2d/pipe/ParallelogramPipe +sun/java2d/pipe/PixelDrawPipe +sun/java2d/pipe/PixelFillPipe +sun/java2d/pipe/PixelToParallelogramConverter +sun/java2d/pipe/PixelToShapeConverter +sun/java2d/pipe/Region +sun/java2d/pipe/Region$ImmutableRegion +sun/java2d/pipe/RegionIterator +sun/java2d/pipe/RenderingEngine +sun/java2d/pipe/RenderingEngine$1 +sun/java2d/pipe/ShapeDrawPipe +sun/java2d/pipe/SolidTextRenderer +sun/java2d/pipe/SpanClipRenderer +sun/java2d/pipe/SpanShapeRenderer +sun/java2d/pipe/SpanShapeRenderer$Composite +sun/java2d/pipe/TextPipe +sun/java2d/pipe/TextRenderer +sun/java2d/pipe/ValidatePipe +sun/java2d/pipe/hw/AccelGraphicsConfig +sun/java2d/pipe/hw/BufferedContextProvider +sun/java2d/x11/X11SurfaceData +sun/java2d/x11/X11SurfaceData$LazyPipe +sun/java2d/x11/XSurfaceData +sun/java2d/xr/DirtyRegion +sun/java2d/xr/GrowableEltArray +sun/java2d/xr/GrowableIntArray +sun/java2d/xr/GrowableRectArray +sun/java2d/xr/MaskTile +sun/java2d/xr/MaskTileManager +sun/java2d/xr/MutableInteger +sun/java2d/xr/XRBackend +sun/java2d/xr/XRBackendNative +sun/java2d/xr/XRColor +sun/java2d/xr/XRCompositeManager +sun/java2d/xr/XRCompositeManager$1 +sun/java2d/xr/XRDrawImage +sun/java2d/xr/XRDrawLine +sun/java2d/xr/XRGraphicsConfig +sun/java2d/xr/XRMaskBlit +sun/java2d/xr/XRMaskFill +sun/java2d/xr/XRMaskImage +sun/java2d/xr/XRPMBlit +sun/java2d/xr/XRPMBlitLoops +sun/java2d/xr/XRPMScaledBlit +sun/java2d/xr/XRPMTransformedBlit +sun/java2d/xr/XRPaints +sun/java2d/xr/XRPaints$XRGradient +sun/java2d/xr/XRPaints$XRLinearGradient +sun/java2d/xr/XRPaints$XRRadialGradient +sun/java2d/xr/XRPaints$XRTexture +sun/java2d/xr/XRRenderer +sun/java2d/xr/XRRenderer$XRDrawHandler +sun/java2d/xr/XRSolidSrcPict +sun/java2d/xr/XRSurfaceData +sun/java2d/xr/XRSurfaceData$XRInternalSurfaceData +sun/java2d/xr/XRSurfaceData$XRPixmapSurfaceData +sun/java2d/xr/XRSurfaceData$XRWindowSurfaceData +sun/java2d/xr/XRSurfaceDataProxy +sun/java2d/xr/XRUtils +sun/java2d/xr/XRVolatileSurfaceManager +sun/java2d/xr/XrSwToPMBlit +sun/java2d/xr/XrSwToPMScaledBlit +sun/java2d/xr/XrSwToPMTransformedBlit +sun/launcher/LauncherHelper +sun/launcher/LauncherHelper$FXHelper +sun/misc/ASCIICaseInsensitiveComparator +sun/misc/Cleaner +sun/misc/CompoundEnumeration +sun/misc/ExtensionDependency +sun/misc/FDBigInteger +sun/misc/FileURLMapper +sun/misc/FloatingDecimal +sun/misc/FloatingDecimal$1 +sun/misc/FloatingDecimal$ASCIIToBinaryBuffer +sun/misc/FloatingDecimal$ASCIIToBinaryConverter +sun/misc/FloatingDecimal$BinaryToASCIIBuffer +sun/misc/FloatingDecimal$BinaryToASCIIConverter +sun/misc/FloatingDecimal$ExceptionalBinaryToASCIIBuffer +sun/misc/FloatingDecimal$PreparedASCIIToBinaryBuffer +sun/misc/IOUtils +sun/misc/JarIndex +sun/misc/JavaAWTAccess +sun/misc/JavaIOFileDescriptorAccess +sun/misc/JavaLangAccess +sun/misc/JavaNetAccess +sun/misc/JavaNioAccess +sun/misc/JavaSecurityAccess +sun/misc/JavaSecurityProtectionDomainAccess +sun/misc/JavaUtilJarAccess +sun/misc/JavaUtilZipFileAccess +sun/misc/Launcher +sun/misc/Launcher$AppClassLoader +sun/misc/Launcher$AppClassLoader$1 +sun/misc/Launcher$BootClassPathHolder +sun/misc/Launcher$BootClassPathHolder$1 +sun/misc/Launcher$ExtClassLoader +sun/misc/Launcher$ExtClassLoader$1 +sun/misc/Launcher$Factory +sun/misc/MetaIndex +sun/misc/NativeSignalHandler +sun/misc/OSEnvironment +sun/misc/Perf +sun/misc/Perf$GetPerfAction +sun/misc/PerfCounter +sun/misc/PerfCounter$CoreCounters +sun/misc/PerformanceLogger +sun/misc/PerformanceLogger$TimeData +sun/misc/PostVMInitHook +sun/misc/Resource +sun/misc/SharedSecrets +sun/misc/Signal +sun/misc/SignalHandler +sun/misc/SoftCache +sun/misc/SoftCache$ValueCell +sun/misc/URLClassPath +sun/misc/URLClassPath$1 +sun/misc/URLClassPath$2 +sun/misc/URLClassPath$3 +sun/misc/URLClassPath$FileLoader +sun/misc/URLClassPath$JarLoader +sun/misc/URLClassPath$JarLoader$1 +sun/misc/URLClassPath$JarLoader$2 +sun/misc/URLClassPath$Loader +sun/misc/Unsafe +sun/misc/VM +sun/misc/Version +sun/net/DefaultProgressMeteringPolicy sun/net/InetAddressCachePolicy sun/net/InetAddressCachePolicy$1 sun/net/InetAddressCachePolicy$2 -java/net/InetAddress$CacheEntry -java/net/PlainDatagramSocketImpl -java/net/DatagramSocketImpl -java/net/NetworkInterface -java/net/InterfaceAddress -java/text/Collator -java/text/spi/CollatorProvider -sun/text/resources/CollationData -sun/text/resources/CollationData_en -sun/util/EmptyListResourceBundle -java/text/RuleBasedCollator -java/text/CollationRules -java/text/RBCollationTables -java/text/RBTableBuilder -java/text/RBCollationTables$BuildAPI -sun/text/IntHashtable -sun/text/UCompactIntArray -sun/text/normalizer/NormalizerImpl -sun/text/normalizer/ICUData -sun/text/normalizer/NormalizerDataReader -sun/text/normalizer/ICUBinary$Authenticate -sun/text/normalizer/ICUBinary -sun/text/normalizer/NormalizerImpl$FCDTrieImpl -sun/text/normalizer/Trie$DataManipulate -sun/text/normalizer/NormalizerImpl$NormTrieImpl -sun/text/normalizer/NormalizerImpl$AuxTrieImpl -sun/text/normalizer/IntTrie -sun/text/normalizer/Trie -sun/text/normalizer/CharTrie -sun/text/normalizer/CharTrie$FriendAgent -sun/text/normalizer/UnicodeSet -sun/text/normalizer/UnicodeMatcher -sun/text/normalizer/NormalizerImpl$DecomposeArgs -java/text/MergeCollation -java/text/PatternEntry$Parser -java/text/PatternEntry -java/text/EntryPair -sun/text/ComposedCharIter -sun/text/normalizer/UTF16 +sun/net/NetHooks +sun/net/NetHooks$Provider +sun/net/NetProperties +sun/net/NetProperties$1 +sun/net/ProgressMeteringPolicy +sun/net/ProgressMonitor +sun/net/ResourceManager +sun/net/sdp/SdpProvider +sun/net/spi/DefaultProxySelector +sun/net/spi/DefaultProxySelector$1 +sun/net/spi/DefaultProxySelector$3 +sun/net/spi/DefaultProxySelector$NonProxyInfo +sun/net/spi/nameservice/NameService +sun/net/util/IPAddressUtil +sun/net/util/URLUtil +sun/net/www/MessageHeader +sun/net/www/MimeEntry +sun/net/www/MimeTable +sun/net/www/MimeTable$1 +sun/net/www/MimeTable$DefaultInstanceHolder +sun/net/www/MimeTable$DefaultInstanceHolder$1 +sun/net/www/ParseUtil +sun/net/www/URLConnection +sun/net/www/protocol/file/FileURLConnection +sun/net/www/protocol/file/Handler sun/net/www/protocol/http/Handler -java/io/ObjectInputStream$BlockDataInputStream -java/io/ObjectInputStream$PeekInputStream -java/io/ObjectInputStream$HandleTable -java/io/ObjectInputStream$HandleTable$HandleList -java/io/ObjectInputStream$ValidationList -java/io/Bits -java/io/ObjectStreamClass$Caches -java/io/ObjectStreamClass$WeakClassKey -java/io/ObjectStreamClass$EntryFuture -java/io/ObjectStreamClass$2 +sun/net/www/protocol/jar/Handler +sun/net/www/protocol/jar/JarFileFactory +sun/net/www/protocol/jar/JarURLConnection +sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream +sun/net/www/protocol/jar/URLJarFile +sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController +sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry +sun/nio/ByteBuffered +sun/nio/ch/DirectBuffer +sun/nio/ch/FileChannelImpl +sun/nio/ch/FileChannelImpl$Unmapper +sun/nio/ch/FileDispatcher +sun/nio/ch/FileDispatcherImpl +sun/nio/ch/IOStatus +sun/nio/ch/IOUtil +sun/nio/ch/IOUtil$1 +sun/nio/ch/Interruptible +sun/nio/ch/NativeDispatcher +sun/nio/ch/NativeThread +sun/nio/ch/NativeThreadSet +sun/nio/ch/Util +sun/nio/ch/Util$1 +sun/nio/ch/Util$4 +sun/nio/ch/Util$BufferCache +sun/nio/cs/AbstractCharsetProvider +sun/nio/cs/ArrayDecoder +sun/nio/cs/ArrayEncoder +sun/nio/cs/FastCharsetProvider +sun/nio/cs/HistoricallyNamedCharset +sun/nio/cs/ISO_8859_1 +sun/nio/cs/ISO_8859_1$Decoder +sun/nio/cs/ISO_8859_1$Encoder +sun/nio/cs/StandardCharsets +sun/nio/cs/StandardCharsets$Aliases +sun/nio/cs/StandardCharsets$Cache +sun/nio/cs/StandardCharsets$Classes +sun/nio/cs/StreamDecoder +sun/nio/cs/StreamEncoder +sun/nio/cs/Surrogate +sun/nio/cs/Surrogate$Parser +sun/nio/cs/US_ASCII +sun/nio/cs/US_ASCII$Decoder +sun/nio/cs/UTF_16 +sun/nio/cs/UTF_16$Decoder +sun/nio/cs/UTF_16BE +sun/nio/cs/UTF_16LE +sun/nio/cs/UTF_8 +sun/nio/cs/UTF_8$Decoder +sun/nio/cs/UTF_8$Encoder +sun/nio/cs/Unicode +sun/nio/cs/UnicodeDecoder +sun/nio/cs/ext/DelegatableDecoder +sun/nio/cs/ext/DoubleByte +sun/nio/cs/ext/DoubleByte$Decoder +sun/nio/cs/ext/EUC_KR +sun/nio/cs/ext/ExtendedCharsets +sun/print/PrinterGraphicsConfig +sun/reflect/AccessorGenerator +sun/reflect/BootstrapConstructorAccessorImpl +sun/reflect/ByteVector +sun/reflect/ByteVectorFactory +sun/reflect/ByteVectorImpl +sun/reflect/CallerSensitive +sun/reflect/ClassDefiner +sun/reflect/ClassDefiner$1 +sun/reflect/ClassFileAssembler +sun/reflect/ClassFileConstants +sun/reflect/ConstantPool +sun/reflect/ConstructorAccessor +sun/reflect/ConstructorAccessorImpl +sun/reflect/DelegatingClassLoader +sun/reflect/DelegatingConstructorAccessorImpl +sun/reflect/DelegatingMethodAccessorImpl +sun/reflect/FieldAccessor +sun/reflect/FieldAccessorImpl +sun/reflect/Label +sun/reflect/Label$PatchInfo +sun/reflect/LangReflectAccess +sun/reflect/MagicAccessorImpl +sun/reflect/MethodAccessor +sun/reflect/MethodAccessorGenerator +sun/reflect/MethodAccessorGenerator$1 +sun/reflect/MethodAccessorImpl +sun/reflect/NativeConstructorAccessorImpl +sun/reflect/NativeMethodAccessorImpl +sun/reflect/Reflection +sun/reflect/ReflectionFactory +sun/reflect/ReflectionFactory$1 +sun/reflect/ReflectionFactory$GetReflectionFactoryAction sun/reflect/SerializationConstructorAccessorImpl -java/io/ObjectStreamClass$FieldReflectorKey -java/io/ObjectStreamClass$FieldReflector -java/io/ObjectStreamClass$1 -java/io/DataOutputStream -java/io/ObjectStreamClass$MemberSignature -java/io/ObjectStreamClass$3 -java/io/ObjectStreamClass$4 -java/io/ObjectStreamClass$5 -java/security/MessageDigest -java/security/MessageDigestSpi +sun/reflect/UTF8 +sun/reflect/UnsafeFieldAccessorFactory +sun/reflect/UnsafeFieldAccessorImpl +sun/reflect/UnsafeObjectFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticLongFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl +sun/reflect/UnsafeStaticFieldAccessorImpl +sun/reflect/annotation/AnnotationType +sun/reflect/generics/repository/AbstractRepository +sun/reflect/generics/repository/ClassRepository +sun/reflect/generics/repository/GenericDeclRepository +sun/reflect/misc/MethodUtil +sun/reflect/misc/MethodUtil$1 +sun/reflect/misc/ReflectUtil +sun/security/action/GetBooleanAction +sun/security/action/GetIntegerAction +sun/security/action/GetPropertyAction +sun/security/action/PutAllAction sun/security/jca/GetInstance -sun/security/jca/Providers -sun/security/jca/ProviderList +sun/security/jca/GetInstance$Instance sun/security/jca/ProviderConfig -sun/security/jca/ProviderList$3 +sun/security/jca/ProviderConfig$1 +sun/security/jca/ProviderConfig$2 +sun/security/jca/ProviderConfig$3 +sun/security/jca/ProviderList sun/security/jca/ProviderList$1 sun/security/jca/ProviderList$2 -sun/security/jca/ProviderConfig$2 -sun/security/util/PropertyExpander -sun/security/jca/ProviderConfig$1 -sun/security/jca/ProviderConfig$3 -sun/security/util/ManifestDigester -sun/security/util/ManifestDigester$Position -sun/security/util/ManifestDigester$Entry -sun/security/pkcs/PKCS7 -sun/security/util/DerInputStream -sun/security/util/DerIndefLenConverter -sun/security/util/DerInputBuffer -sun/security/pkcs/ContentInfo -sun/security/util/ObjectIdentifier -sun/security/util/DerValue -sun/security/util/DerOutputStream -sun/security/util/DerEncoder -sun/security/util/ByteArrayLexOrder -sun/security/util/ByteArrayTagOrder -java/math/BigInteger -sun/security/x509/AlgorithmId -java/security/cert/CertificateFactory -java/security/cert/CertificateFactorySpi -java/security/Provider$Service -java/security/Provider$UString -sun/security/provider/X509Factory -sun/security/util/Cache -sun/security/util/MemoryCache -sun/security/jca/GetInstance$Instance -java/security/cert/X509Certificate -java/security/cert/X509Extension -sun/security/util/Cache$EqualByteArray -sun/security/x509/X509CertImpl -sun/security/x509/X509CertInfo -sun/security/x509/CertAttrSet -sun/security/x509/CertificateVersion -sun/security/x509/CertificateSerialNumber -sun/security/x509/SerialNumber -sun/security/x509/CertificateAlgorithmId -sun/security/x509/CertificateIssuerName -sun/security/x509/X500Name -sun/security/x509/GeneralNameInterface -sun/security/x509/X500Name$1 -javax/security/auth/x500/X500Principal -sun/security/x509/RDN -sun/security/x509/AVA -sun/security/x509/CertificateValidity -sun/security/x509/CertificateSubjectName -sun/security/x509/CertificateX509Key -sun/security/x509/X509Key -java/security/PublicKey -java/security/Key -sun/security/util/BitArray -java/security/spec/X509EncodedKeySpec -java/security/spec/EncodedKeySpec -java/security/spec/KeySpec -java/security/KeyFactory +sun/security/jca/ProviderList$3 sun/security/jca/ProviderList$ServiceList sun/security/jca/ProviderList$ServiceList$1 -sun/security/rsa/RSAKeyFactory -java/security/KeyFactorySpi -java/security/spec/RSAPublicKeySpec -java/security/spec/RSAPrivateKeySpec -java/security/spec/RSAPrivateCrtKeySpec -java/security/spec/PKCS8EncodedKeySpec -sun/security/rsa/RSAPublicKeyImpl -java/security/interfaces/RSAPublicKey -java/security/interfaces/RSAKey -sun/security/rsa/RSAPrivateCrtKeyImpl -java/security/interfaces/RSAPrivateCrtKey -java/security/interfaces/RSAPrivateKey -java/security/PrivateKey +sun/security/jca/Providers +sun/security/jca/ServiceId +sun/security/pkcs/ContentInfo +sun/security/pkcs/PKCS7 sun/security/pkcs/PKCS8Key +sun/security/pkcs/PKCS9Attribute +sun/security/pkcs/SignerInfo +sun/security/provider/ByteArrayAccess +sun/security/provider/DSAKeyFactory +sun/security/provider/DSAParameters +sun/security/provider/DSAPublicKey +sun/security/provider/DSAPublicKeyImpl +sun/security/provider/DigestBase +sun/security/provider/NativePRNG +sun/security/provider/NativePRNG$1 +sun/security/provider/NativePRNG$2 +sun/security/provider/NativePRNG$Blocking +sun/security/provider/NativePRNG$NonBlocking +sun/security/provider/NativePRNG$RandomIO +sun/security/provider/NativePRNG$Variant +sun/security/provider/SHA2 +sun/security/provider/SHA2$SHA256 +sun/security/provider/Sun +sun/security/provider/SunEntries +sun/security/provider/SunEntries$1 +sun/security/provider/X509Factory +sun/security/provider/certpath/X509CertPath +sun/security/rsa/RSACore +sun/security/rsa/RSAKeyFactory +sun/security/rsa/RSAPadding +sun/security/rsa/RSAPrivateCrtKeyImpl +sun/security/rsa/RSAPrivateKeyImpl +sun/security/rsa/RSAPublicKeyImpl +sun/security/rsa/RSASignature +sun/security/rsa/RSASignature$SHA256withRSA +sun/security/rsa/SunRsaSign +sun/security/rsa/SunRsaSignEntries +sun/security/util/BitArray +sun/security/util/ByteArrayLexOrder +sun/security/util/ByteArrayTagOrder +sun/security/util/Cache +sun/security/util/Cache$EqualByteArray +sun/security/util/Debug +sun/security/util/DerEncoder +sun/security/util/DerIndefLenConverter +sun/security/util/DerInputBuffer +sun/security/util/DerInputStream +sun/security/util/DerOutputStream +sun/security/util/DerValue +sun/security/util/Length +sun/security/util/ManifestDigester +sun/security/util/ManifestDigester$Entry +sun/security/util/ManifestDigester$Position +sun/security/util/ManifestEntryVerifier +sun/security/util/ManifestEntryVerifier$SunProviderHolder +sun/security/util/MemoryCache +sun/security/util/MemoryCache$CacheEntry +sun/security/util/MemoryCache$HardCacheEntry +sun/security/util/MemoryCache$SoftCacheEntry +sun/security/util/ObjectIdentifier +sun/security/util/PropertyExpander +sun/security/util/SignatureFileVerifier +sun/security/x509/AVA +sun/security/x509/AVAKeyword +sun/security/x509/AlgorithmId +sun/security/x509/AuthorityKeyIdentifierExtension +sun/security/x509/BasicConstraintsExtension +sun/security/x509/CertAttrSet +sun/security/x509/CertificateAlgorithmId sun/security/x509/CertificateExtensions +sun/security/x509/CertificateSerialNumber +sun/security/x509/CertificateValidity +sun/security/x509/CertificateVersion +sun/security/x509/CertificateX509Key sun/security/x509/Extension -sun/security/x509/OIDMap -sun/security/x509/PKIXExtensions -sun/security/x509/OIDMap$OIDInfo +sun/security/x509/GeneralName +sun/security/x509/GeneralNameInterface +sun/security/x509/GeneralNames +sun/security/x509/KeyIdentifier +sun/security/x509/KeyUsageExtension sun/security/x509/NetscapeCertTypeExtension sun/security/x509/NetscapeCertTypeExtension$MapEntry -sun/security/x509/KeyUsageExtension -sun/security/x509/SubjectKeyIdentifierExtension -sun/security/x509/KeyIdentifier -sun/security/x509/AuthorityKeyIdentifierExtension -sun/security/x509/GeneralNames -sun/security/x509/SubjectAlternativeNameExtension -sun/security/x509/GeneralName +sun/security/x509/OIDMap +sun/security/x509/OIDMap$OIDInfo +sun/security/x509/PKIXExtensions +sun/security/x509/RDN sun/security/x509/RFC822Name +sun/security/x509/SerialNumber +sun/security/x509/SubjectAlternativeNameExtension +sun/security/x509/SubjectKeyIdentifierExtension +sun/security/x509/X500Name +sun/security/x509/X500Name$1 sun/security/x509/X509AttributeName -sun/security/util/MemoryCache$SoftCacheEntry -sun/security/util/MemoryCache$CacheEntry -java/security/AlgorithmParameters -java/security/AlgorithmParametersSpi -sun/security/provider/DSAParameters -sun/security/provider/DSAKeyFactory -java/security/spec/DSAPublicKeySpec -sun/security/provider/DSAPublicKeyImpl -sun/security/provider/DSAPublicKey -java/security/interfaces/DSAPublicKey -java/security/interfaces/DSAKey -sun/security/x509/BasicConstraintsExtension -sun/security/pkcs/SignerInfo -java/security/Signature -java/security/SignatureSpi -sun/security/jca/ServiceId -java/security/Signature$Delegate -sun/security/x509/AVAKeyword -sun/security/pkcs/PKCS9Attribute -java/text/Normalizer$Form -java/text/Normalizer +sun/security/x509/X509CertImpl +sun/security/x509/X509CertInfo +sun/security/x509/X509Key +sun/swing/DefaultLookup +sun/swing/ImageIconUIResource +sun/swing/JLightweightFrame +sun/swing/MenuItemLayoutHelper +sun/swing/MenuItemLayoutHelper$ColumnAlignment +sun/swing/MenuItemLayoutHelper$LayoutResult +sun/swing/MenuItemLayoutHelper$RectSize +sun/swing/PrintColorUIResource +sun/swing/StringUIClientPropertyKey +sun/swing/SwingAccessor +sun/swing/SwingAccessor$JTextComponentAccessor +sun/swing/SwingLazyValue +sun/swing/SwingLazyValue$1 +sun/swing/SwingUtilities2 +sun/swing/SwingUtilities2$2 +sun/swing/SwingUtilities2$AATextInfo +sun/swing/SwingUtilities2$LSBCacheEntry +sun/swing/UIAction +sun/swing/UIClientPropertyKey +sun/swing/table/DefaultTableCellHeaderRenderer +sun/swing/table/DefaultTableCellHeaderRenderer$EmptyIcon +sun/text/ComposedCharIter +sun/text/IntHashtable +sun/text/UCompactIntArray +sun/text/normalizer/CharTrie +sun/text/normalizer/CharTrie$FriendAgent +sun/text/normalizer/ICUBinary +sun/text/normalizer/ICUBinary$Authenticate +sun/text/normalizer/ICUData +sun/text/normalizer/IntTrie sun/text/normalizer/NormalizerBase -sun/text/normalizer/NormalizerBase$Mode -sun/text/normalizer/NormalizerBase$NFDMode -sun/text/normalizer/NormalizerBase$NFKDMode -sun/text/normalizer/NormalizerBase$NFCMode -sun/text/normalizer/NormalizerBase$NFKCMode -sun/text/normalizer/NormalizerBase$QuickCheckResult sun/text/normalizer/NormalizerBase$1 -sun/security/rsa/RSASignature$SHA1withRSA -sun/security/rsa/RSASignature -sun/security/provider/SHA -sun/security/provider/DigestBase -java/security/MessageDigest$Delegate -sun/security/rsa/RSACore -sun/security/rsa/RSAPadding -sun/security/provider/ByteArrayAccess -java/math/MutableBigInteger -sun/security/provider/certpath/X509CertPath -java/security/cert/CertPath -java/security/CodeSigner -sun/misc/CEStreamExhausted -java/util/jar/JarVerifier$VerifierStream -java/security/AuthProvider -java/security/SecurityPermission -javax/security/auth/login/LoginException -javax/security/auth/login/FailedLoginException -java/security/ProviderException -java/io/StreamTokenizer -java/lang/AssertionError -java/io/NotSerializableException -java/io/ObjectStreamException -java/security/InvalidParameterException -java/io/ObjectStreamClass$ClassDataSlot -sun/reflect/UnsafeQualifiedStaticLongFieldAccessorImpl -java/io/ObjectOutputStream$BlockDataOutputStream -java/io/ObjectOutputStream$HandleTable -java/io/ObjectOutputStream$ReplaceTable -java/security/SignatureException -java/security/InvalidKeyException -java/security/KeyException -java/security/interfaces/DSAParams -java/io/InvalidClassException -java/io/ObjectInputStream$GetFieldImpl -java/io/ObjectInputStream$GetField -java/security/interfaces/DSAPrivateKey -java/security/spec/InvalidKeySpecException -java/security/spec/DSAParameterSpec -java/security/spec/AlgorithmParameterSpec -sun/security/util/MemoryCache$HardCacheEntry -java/awt/EventQueue$1AWTInvocationLock -java/awt/Component$FlipBufferStrategy -java/awt/SentEvent -sun/awt/X11/XDestroyWindowEvent -sun/awt/X11/XDropTargetRegistry -sun/awt/X11/XEmbeddedFramePeer -sun/awt/X11/XDragAndDropProtocols -sun/awt/X11/XDropTargetContextPeer -sun/awt/dnd/SunDropTargetContextPeer -java/awt/dnd/peer/DropTargetContextPeer -sun/awt/X11/XDropTargetContextPeer$XDropTargetProtocolListenerImpl -sun/awt/X11/XDropTargetProtocolListener -sun/awt/X11/XDnDDragSourceProtocol -sun/awt/X11/XDragSourceProtocol -sun/awt/X11/MotifDnDDragSourceProtocol -sun/awt/X11/XDnDDropTargetProtocol -sun/awt/X11/XDropTargetProtocol -sun/awt/X11/MotifDnDDropTargetProtocol -sun/awt/X11/XDnDConstants -sun/awt/X11/MotifDnDConstants -javax/swing/JTable$2 -javax/swing/JTable$Resizable3 -javax/swing/JTable$Resizable2 -javax/swing/JTable$5 -javax/swing/event/AncestorEvent -com/sun/java/swing/plaf/gtk/GTKLookAndFeel -javax/swing/plaf/synth/SynthLookAndFeel -javax/swing/plaf/synth/DefaultSynthStyleFactory -javax/swing/plaf/synth/SynthStyleFactory -sun/swing/BakedArrayList -javax/swing/plaf/synth/SynthLookAndFeel$Handler -javax/swing/plaf/synth/SynthDefaultLookup -com/sun/java/swing/plaf/gtk/GTKEngine -javax/swing/plaf/synth/Region -com/sun/java/swing/plaf/gtk/GTKRegion -sun/swing/ImageCache -com/sun/java/swing/plaf/gtk/GTKEngine$Settings -com/sun/java/swing/plaf/gtk/GTKStyleFactory -com/sun/java/swing/plaf/gtk/PangoFonts -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$WeakPCL -javax/swing/plaf/synth/SynthLookAndFeel$AATextListener -com/sun/java/swing/plaf/gtk/GTKStyle -com/sun/java/swing/plaf/gtk/GTKConstants -javax/swing/plaf/synth/SynthStyle -javax/swing/plaf/synth/SynthGraphicsUtils -com/sun/java/swing/plaf/gtk/GTKGraphicsUtils -com/sun/java/swing/plaf/gtk/GTKStyle$GTKStockIcon -sun/swing/plaf/synth/SynthIcon -com/sun/java/swing/plaf/gtk/GTKColorType -javax/swing/plaf/synth/ColorType -com/sun/java/swing/plaf/gtk/GTKConstants$StateType -com/sun/java/swing/plaf/gtk/resources/gtk -com/sun/swing/internal/plaf/synth/resources/synth -com/sun/java/swing/plaf/gtk/GTKStyle$GTKLazyValue -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$1FontLazyValue -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$2 -com/sun/java/swing/plaf/gtk/GTKLookAndFeel$3 -javax/swing/plaf/synth/SynthPanelUI -javax/swing/plaf/synth/SynthConstants -javax/swing/plaf/synth/SynthContext -javax/swing/plaf/synth/SynthBorder -javax/swing/plaf/synth/SynthRootPaneUI -javax/swing/plaf/synth/SynthLabelUI -sun/java2d/x11/X11VolatileSurfaceManager -javax/swing/plaf/synth/SynthButtonUI -javax/swing/plaf/synth/SynthToggleButtonUI -javax/swing/plaf/basic/BasicBorders$FieldBorder -javax/swing/plaf/synth/SynthMenuBarUI -javax/swing/plaf/synth/SynthMenuUI -javax/swing/plaf/synth/SynthUI -com/sun/java/swing/plaf/gtk/GTKIconFactory -com/sun/java/swing/plaf/gtk/GTKIconFactory$MenuArrowIcon -com/sun/java/swing/plaf/gtk/GTKIconFactory$DelegatingIcon -com/sun/java/swing/plaf/gtk/GTKConstants$ArrowType -javax/swing/plaf/basic/BasicIconFactory -javax/swing/plaf/basic/BasicIconFactory$MenuItemCheckIcon -javax/swing/plaf/synth/SynthMenuItemUI -javax/swing/plaf/synth/SynthPopupMenuUI -javax/swing/plaf/synth/SynthSeparatorUI -javax/swing/plaf/synth/SynthScrollBarUI -javax/swing/plaf/synth/SynthArrowButton -javax/swing/plaf/synth/SynthArrowButton$SynthArrowButtonUI -javax/swing/plaf/synth/SynthComboBoxUI -javax/swing/plaf/synth/SynthComboPopup -javax/swing/plaf/synth/SynthListUI -javax/swing/plaf/synth/SynthListUI$SynthListCellRenderer -javax/swing/plaf/synth/SynthViewportUI -javax/swing/plaf/synth/SynthScrollPaneUI -javax/swing/plaf/synth/SynthScrollPaneUI$ViewportBorder -javax/swing/plaf/synth/SynthComboBoxUI$SynthComboBoxRenderer -javax/swing/plaf/synth/SynthComboBoxUI$SynthComboBoxEditor -javax/swing/plaf/synth/SynthTextFieldUI -javax/swing/plaf/synth/SynthToolBarUI -javax/swing/plaf/synth/SynthToolBarUI$SynthToolBarLayoutManager -com/sun/java/swing/plaf/gtk/GTKIconFactory$ToolBarHandleIcon -com/sun/java/swing/plaf/gtk/GTKConstants$Orientation -com/sun/java/swing/plaf/gtk/GTKPainter -javax/swing/plaf/synth/SynthPainter -javax/swing/plaf/synth/SynthPainter$1 -com/sun/java/swing/plaf/gtk/GTKConstants$PositionType -com/sun/java/swing/plaf/gtk/GTKConstants$ShadowType -sun/applet/Main -sun/applet/AppletMessageHandler -sun/applet/resources/MsgAppletViewer -sun/applet/AppletSecurity -sun/awt/AWTSecurityManager -java/lang/SecurityManager -java/security/DomainCombiner -sun/applet/AppletSecurity$1 -java/lang/SecurityManager$1 -java/util/PropertyPermission -sun/applet/AppletViewer -java/applet/AppletContext -java/awt/print/Printable -sun/security/util/SecurityConstants -java/awt/AWTPermission -java/net/NetPermission -java/net/SocketPermission -javax/security/auth/AuthPermission -java/lang/Thread$1 -java/util/logging/LogManager$5 -sun/applet/StdAppletViewerFactory -sun/applet/AppletViewerFactory -sun/applet/AppletViewer$UserActionListener -sun/applet/AppletViewerPanel -sun/applet/AppletPanel -java/applet/AppletStub -sun/misc/MessageUtils -sun/applet/AppletPanel$10 -java/security/Policy$1 -sun/security/provider/PolicyFile$1 -sun/security/provider/PolicyFile$3 -sun/security/provider/PolicyParser -sun/security/util/PolicyUtil -sun/security/provider/PolicyParser$GrantEntry -sun/security/provider/PolicyParser$PermissionEntry -sun/security/provider/PolicyFile$PolicyEntry -sun/security/provider/PolicyFile$6 -sun/security/provider/PolicyFile$7 -java/net/SocketPermissionCollection -java/util/PropertyPermissionCollection -sun/applet/AppletPanel$9 -sun/applet/AppletClassLoader -sun/applet/AppletThreadGroup -sun/applet/AppContextCreator -sun/applet/AppletPanel$1 -sun/awt/X11/XMenuBarPeer -java/awt/peer/MenuBarPeer -java/awt/peer/MenuComponentPeer -sun/awt/X11/XBaseMenuWindow -sun/awt/X11/XMenuPeer -java/awt/peer/MenuPeer -java/awt/peer/MenuItemPeer -sun/awt/X11/XMenuItemPeer -java/awt/MenuShortcut -sun/awt/X11/XMenuWindow -sun/awt/AppContext$3 -sun/awt/X11/XMenuItemPeer$TextMetrics -sun/awt/X11/XMenuBarPeer$MappingData -sun/awt/X11/XBaseMenuWindow$MappingData -sun/applet/AppletViewer$1 -sun/applet/AppletViewer$1AppletEventListener -sun/applet/AppletListener -sun/applet/AppletEventMulticaster -sun/awt/X11/XBaseMenuWindow$3 -java/awt/DefaultKeyboardFocusManager$DefaultKeyboardFocusManagerSentEvent -sun/awt/CausedFocusEvent -sun/awt/X11/XWindow$1 -sun/misc/Queue -sun/misc/QueueElement -sun/applet/AppletEvent -sun/applet/AppletClassLoader$1 -java/net/URLClassLoader$4 -sun/applet/AppletClassLoader$2 -javax/swing/JApplet -java/lang/ClassLoader$1 -sun/security/provider/PolicyFile$5 -java/security/PermissionsEnumerator -java/util/Collections$1 -sun/applet/AppletPanel$11 -sun/applet/AppletPanel$8 -sun/applet/AppletPanel$2 -sun/applet/AppletPanel$3 -sun/applet/AppletPanel$6 -javax/swing/BufferStrategyPaintManager$1 -# 8662ff6d6adccb91 +sun/text/normalizer/NormalizerBase$Mode +sun/text/normalizer/NormalizerBase$NFCMode +sun/text/normalizer/NormalizerBase$NFDMode +sun/text/normalizer/NormalizerBase$NFKCMode +sun/text/normalizer/NormalizerBase$NFKDMode +sun/text/normalizer/NormalizerBase$QuickCheckResult +sun/text/normalizer/NormalizerDataReader +sun/text/normalizer/NormalizerImpl +sun/text/normalizer/NormalizerImpl$AuxTrieImpl +sun/text/normalizer/NormalizerImpl$DecomposeArgs +sun/text/normalizer/NormalizerImpl$FCDTrieImpl +sun/text/normalizer/NormalizerImpl$NormTrieImpl +sun/text/normalizer/Trie +sun/text/normalizer/Trie$DataManipulate +sun/text/normalizer/UTF16 +sun/text/normalizer/UnicodeMatcher +sun/text/normalizer/UnicodeSet +sun/text/resources/CollationData +sun/text/resources/FormatData +sun/text/resources/en/FormatData_en +sun/text/resources/en/FormatData_en_US +sun/util/CoreResourceBundleControl +sun/util/PreHashedMap +sun/util/ResourceBundleEnumeration +sun/util/calendar/AbstractCalendar +sun/util/calendar/BaseCalendar +sun/util/calendar/BaseCalendar$Date +sun/util/calendar/CalendarDate +sun/util/calendar/CalendarSystem +sun/util/calendar/CalendarUtils +sun/util/calendar/Gregorian +sun/util/calendar/Gregorian$Date +sun/util/calendar/ZoneInfo +sun/util/calendar/ZoneInfoFile +sun/util/calendar/ZoneInfoFile$1 +sun/util/calendar/ZoneInfoFile$Checksum +sun/util/calendar/ZoneInfoFile$ZoneOffsetTransitionRule +sun/util/locale/BaseLocale +sun/util/locale/BaseLocale$Cache +sun/util/locale/BaseLocale$Key +sun/util/locale/LanguageTag +sun/util/locale/LocaleObjectCache +sun/util/locale/LocaleObjectCache$CacheEntry +sun/util/locale/LocaleUtils +sun/util/locale/provider/AuxLocaleProviderAdapter +sun/util/locale/provider/AuxLocaleProviderAdapter$NullProvider +sun/util/locale/provider/AvailableLanguageTags +sun/util/locale/provider/CalendarDataProviderImpl +sun/util/locale/provider/CalendarDataUtility +sun/util/locale/provider/CalendarDataUtility$CalendarWeekParameterGetter +sun/util/locale/provider/CalendarProviderImpl +sun/util/locale/provider/CollatorProviderImpl +sun/util/locale/provider/CurrencyNameProviderImpl +sun/util/locale/provider/DateFormatSymbolsProviderImpl +sun/util/locale/provider/DecimalFormatSymbolsProviderImpl +sun/util/locale/provider/JRELocaleProviderAdapter +sun/util/locale/provider/JRELocaleProviderAdapter$1 +sun/util/locale/provider/LocaleDataMetaInfo +sun/util/locale/provider/LocaleProviderAdapter +sun/util/locale/provider/LocaleProviderAdapter$1 +sun/util/locale/provider/LocaleProviderAdapter$Type +sun/util/locale/provider/LocaleResources +sun/util/locale/provider/LocaleResources$ResourceReference +sun/util/locale/provider/LocaleServiceProviderPool +sun/util/locale/provider/LocaleServiceProviderPool$LocalizedObjectGetter +sun/util/locale/provider/NumberFormatProviderImpl +sun/util/locale/provider/ResourceBundleBasedAdapter +sun/util/locale/provider/SPILocaleProviderAdapter +sun/util/locale/provider/SPILocaleProviderAdapter$1 +sun/util/locale/provider/TimeZoneNameProviderImpl +sun/util/locale/provider/TimeZoneNameUtility +sun/util/locale/provider/TimeZoneNameUtility$TimeZoneNameGetter +sun/util/logging/LoggingProxy +sun/util/logging/LoggingSupport +sun/util/logging/LoggingSupport$1 +sun/util/logging/LoggingSupport$2 +sun/util/logging/PlatformLogger +sun/util/logging/PlatformLogger$1 +sun/util/logging/PlatformLogger$DefaultLoggerProxy +sun/util/logging/PlatformLogger$JavaLoggerProxy +sun/util/logging/PlatformLogger$Level +sun/util/logging/PlatformLogger$LoggerProxy +sun/util/logging/resources/logging +sun/util/resources/CalendarData +sun/util/resources/CurrencyNames +sun/util/resources/LocaleData +sun/util/resources/LocaleData$1 +sun/util/resources/LocaleData$LocaleDataResourceBundleControl +sun/util/resources/LocaleNamesBundle +sun/util/resources/OpenListResourceBundle +sun/util/resources/ParallelListResourceBundle +sun/util/resources/ParallelListResourceBundle$KeySet +sun/util/resources/TimeZoneNames +sun/util/resources/TimeZoneNamesBundle +sun/util/resources/en/CalendarData_en +sun/util/resources/en/CurrencyNames_en_US +sun/util/resources/en/TimeZoneNames_en +sun/util/spi/CalendarProvider +# fcfd7386dfd2b3ad diff --git a/jdk/make/tools/sharing/classlist.windows b/jdk/make/tools/sharing/classlist.windows index 1bf64407f92..debed79c4a4 100644 --- a/jdk/make/tools/sharing/classlist.windows +++ b/jdk/make/tools/sharing/classlist.windows @@ -1,2203 +1,2378 @@ -java/lang/Object -java/lang/String -java/io/Serializable -java/lang/Comparable -java/lang/CharSequence -java/lang/Class -java/lang/reflect/GenericDeclaration -java/lang/reflect/Type -java/lang/reflect/AnnotatedElement -java/lang/Cloneable -java/lang/ClassLoader -java/lang/System -java/lang/Throwable -java/lang/Error -java/lang/ThreadDeath -java/lang/Exception -java/lang/RuntimeException -java/security/ProtectionDomain -java/security/AccessControlContext -java/lang/ClassNotFoundException -java/lang/NoClassDefFoundError -java/lang/LinkageError -java/lang/ClassCastException -java/lang/ArrayStoreException -java/lang/VirtualMachineError -java/lang/OutOfMemoryError -java/lang/StackOverflowError -java/lang/IllegalMonitorStateException -java/lang/ref/Reference -java/lang/ref/SoftReference -java/lang/ref/WeakReference -java/lang/ref/FinalReference -java/lang/ref/PhantomReference -java/lang/ref/Finalizer -java/lang/Thread -java/lang/Runnable -java/lang/ThreadGroup -java/lang/Thread$UncaughtExceptionHandler -java/util/Properties -java/util/Hashtable -java/util/Map -java/util/Dictionary -java/lang/reflect/AccessibleObject -java/lang/reflect/Field -java/lang/reflect/Member -java/lang/reflect/Method -java/lang/reflect/Constructor -sun/reflect/MagicAccessorImpl -sun/reflect/MethodAccessorImpl -sun/reflect/MethodAccessor -sun/reflect/ConstructorAccessorImpl -sun/reflect/ConstructorAccessor -sun/reflect/DelegatingClassLoader -sun/reflect/ConstantPool -sun/reflect/UnsafeStaticFieldAccessorImpl -sun/reflect/UnsafeFieldAccessorImpl -sun/reflect/FieldAccessorImpl -sun/reflect/FieldAccessor -java/util/Vector -java/util/List -java/util/Collection -java/lang/Iterable -java/util/RandomAccess -java/util/AbstractList -java/util/AbstractCollection -java/lang/StringBuffer -java/lang/AbstractStringBuilder -java/lang/Appendable -java/lang/StackTraceElement -java/nio/Buffer -java/lang/Boolean -java/lang/Character -java/lang/Float -java/lang/Number -java/lang/Double -java/lang/Byte -java/lang/Short -java/lang/Integer -java/lang/Long -java/lang/NullPointerException -java/lang/ArithmeticException -java/io/ObjectStreamField -java/lang/String$CaseInsensitiveComparator -java/util/Comparator -java/lang/RuntimePermission -java/security/BasicPermission -java/security/Permission -java/security/Guard -sun/misc/SoftCache -java/util/AbstractMap -java/lang/ref/ReferenceQueue -java/lang/ref/ReferenceQueue$Null -java/lang/ref/ReferenceQueue$Lock -java/util/HashMap -java/lang/annotation/Annotation -java/util/HashMap$Entry -java/util/Map$Entry -java/security/AccessController -java/lang/reflect/ReflectPermission -sun/reflect/ReflectionFactory$GetReflectionFactoryAction -java/security/PrivilegedAction -java/util/Stack -sun/reflect/ReflectionFactory -java/lang/ref/Reference$Lock -java/lang/ref/Reference$ReferenceHandler -java/lang/ref/Finalizer$FinalizerThread -java/util/Enumeration -java/util/Iterator -java/util/Hashtable$Entry -sun/misc/Version -java/io/FileInputStream -java/io/InputStream -java/io/Closeable -java/io/FileDescriptor -java/io/FileOutputStream -java/io/OutputStream -java/io/Flushable -java/io/BufferedInputStream -java/io/FilterInputStream -java/util/concurrent/atomic/AtomicReferenceFieldUpdater -java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl -sun/misc/Unsafe -java/lang/NoSuchMethodError -java/lang/IncompatibleClassChangeError -sun/reflect/Reflection -java/util/Collections -java/util/Collections$EmptySet -java/util/AbstractSet -java/util/Set -java/util/Collections$EmptyList -java/util/Collections$EmptyMap -java/util/Collections$ReverseComparator -java/util/Collections$SynchronizedMap -java/lang/Class$3 -java/lang/reflect/Modifier -java/lang/reflect/ReflectAccess -sun/reflect/LangReflectAccess -sun/reflect/misc/ReflectUtil -java/io/PrintStream -java/io/FilterOutputStream -java/io/BufferedOutputStream -java/io/OutputStreamWriter -java/io/Writer -sun/nio/cs/StreamEncoder -java/nio/charset/Charset -sun/nio/cs/StandardCharsets -sun/nio/cs/FastCharsetProvider -java/nio/charset/spi/CharsetProvider -sun/nio/cs/StandardCharsets$Aliases -sun/util/PreHashedMap -sun/nio/cs/StandardCharsets$Classes -sun/nio/cs/StandardCharsets$Cache -java/lang/ThreadLocal -java/util/concurrent/atomic/AtomicInteger -sun/security/action/GetPropertyAction -java/util/Arrays -java/lang/Math -java/lang/StringBuilder -sun/nio/cs/MS1252 -sun/nio/cs/HistoricallyNamedCharset -java/lang/Class$1 -sun/reflect/ReflectionFactory$1 -sun/reflect/NativeConstructorAccessorImpl -sun/reflect/DelegatingConstructorAccessorImpl -sun/misc/VM -sun/nio/cs/SingleByteEncoder -java/nio/charset/CharsetEncoder -java/nio/charset/CodingErrorAction -sun/nio/cs/SingleByteDecoder -java/nio/charset/CharsetDecoder -java/nio/ByteBuffer -java/nio/HeapByteBuffer -java/nio/Bits -java/lang/Runtime -java/nio/ByteOrder -java/nio/CharBuffer -java/lang/Readable -java/nio/HeapCharBuffer -java/nio/charset/CoderResult -java/nio/charset/CoderResult$1 -java/nio/charset/CoderResult$Cache -java/nio/charset/CoderResult$2 -sun/nio/cs/Surrogate$Parser -sun/nio/cs/Surrogate -java/io/BufferedWriter -java/io/File -java/io/FileSystem -java/io/WinNTFileSystem -java/io/Win32FileSystem -java/io/ExpiringCache -java/io/ExpiringCache$1 -java/util/LinkedHashMap -java/util/LinkedHashMap$Entry -sun/misc/SharedSecrets -java/lang/ClassLoader$3 -java/io/ExpiringCache$Entry -java/lang/ClassLoader$NativeLibrary -java/lang/Terminator -java/lang/Terminator$1 -sun/misc/SignalHandler -sun/misc/Signal -sun/misc/NativeSignalHandler -java/io/Console -java/io/Console$1 -sun/misc/JavaIOAccess -java/lang/Shutdown -java/util/ArrayList -java/lang/Shutdown$Lock -java/lang/ApplicationShutdownHooks -java/util/IdentityHashMap -sun/misc/OSEnvironment -sun/io/Win32ErrorMode -java/lang/System$2 -sun/misc/JavaLangAccess -java/lang/Compiler -java/lang/Compiler$1 -sun/misc/Launcher -sun/misc/Launcher$Factory -java/net/URLStreamHandlerFactory -sun/misc/Launcher$ExtClassLoader -java/net/URLClassLoader -java/security/SecureClassLoader -sun/security/util/Debug -java/net/URLClassLoader$7 -sun/misc/JavaNetAccess -java/util/StringTokenizer -sun/misc/Launcher$ExtClassLoader$1 -java/security/PrivilegedExceptionAction -sun/misc/MetaIndex -java/io/BufferedReader -java/io/Reader -java/io/FileReader -java/io/InputStreamReader -sun/nio/cs/StreamDecoder -java/lang/reflect/Array -java/util/Locale -java/util/concurrent/ConcurrentHashMap -java/util/concurrent/ConcurrentMap -java/util/concurrent/ConcurrentHashMap$Segment -java/util/concurrent/locks/ReentrantLock -java/util/concurrent/locks/Lock -java/util/concurrent/locks/ReentrantLock$NonfairSync -java/util/concurrent/locks/ReentrantLock$Sync -java/util/concurrent/locks/AbstractQueuedSynchronizer -java/util/concurrent/locks/AbstractOwnableSynchronizer -java/util/concurrent/locks/AbstractQueuedSynchronizer$Node -java/util/concurrent/ConcurrentHashMap$HashEntry -java/lang/CharacterDataLatin1 -java/io/ObjectStreamClass -sun/net/www/ParseUtil -java/util/BitSet -java/net/URL -java/net/Parts -sun/net/www/protocol/file/Handler -java/net/URLStreamHandler -java/util/HashSet -sun/misc/URLClassPath -sun/net/www/protocol/jar/Handler -sun/misc/Launcher$AppClassLoader -sun/misc/Launcher$AppClassLoader$1 -java/lang/SystemClassLoaderAction -java/lang/StringCoding -java/lang/ThreadLocal$ThreadLocalMap -java/lang/ThreadLocal$ThreadLocalMap$Entry -java/lang/StringCoding$StringDecoder -java/net/URLClassLoader$1 -sun/misc/URLClassPath$3 -sun/misc/URLClassPath$JarLoader -sun/misc/URLClassPath$Loader -java/security/PrivilegedActionException -sun/misc/URLClassPath$FileLoader -sun/misc/URLClassPath$FileLoader$1 -sun/misc/Resource -sun/nio/ByteBuffered -java/security/CodeSource -java/security/Permissions -java/security/PermissionCollection -sun/net/www/protocol/file/FileURLConnection -sun/net/www/URLConnection -java/net/URLConnection -java/net/UnknownContentHandler -java/net/ContentHandler -sun/net/www/MessageHeader -java/io/FilePermission -java/io/FilePermission$1 -sun/security/provider/PolicyFile -java/security/Policy -java/security/Policy$UnsupportedEmptyCollection -java/io/FilePermissionCollection -java/security/AllPermission -java/security/UnresolvedPermission -java/security/BasicPermissionCollection -java/security/Principal -java/security/cert/Certificate -java/util/AbstractList$Itr -java/util/IdentityHashMap$KeySet -java/util/IdentityHashMap$KeyIterator -java/util/IdentityHashMap$IdentityHashMapIterator -java/io/DeleteOnExitHook -java/util/LinkedHashSet -java/util/HashMap$KeySet -java/util/LinkedHashMap$KeyIterator -java/util/LinkedHashMap$LinkedHashIterator -java/awt/Frame -java/awt/MenuContainer -java/awt/Window -javax/accessibility/Accessible -java/awt/Container -java/awt/Component -java/awt/image/ImageObserver -java/lang/InterruptedException -java/awt/Label -java/util/logging/Logger -java/util/logging/Handler -java/util/logging/Level -java/util/logging/LogManager -java/util/logging/LogManager$1 -java/beans/PropertyChangeSupport -java/util/logging/LogManager$LogNode -java/util/logging/LoggingPermission -java/util/logging/LogManager$Cleaner -java/util/logging/LogManager$RootLogger -java/util/logging/LogManager$2 -java/util/Properties$LineReader -java/util/Hashtable$Enumerator -java/beans/PropertyChangeEvent -java/util/EventObject -java/awt/Component$AWTTreeLock -sun/awt/NativeLibLoader -sun/security/action/LoadLibraryAction -java/awt/Toolkit -java/awt/Toolkit$3 -sun/util/CoreResourceBundleControl -java/util/ResourceBundle$Control -java/util/Arrays$ArrayList -java/util/Collections$UnmodifiableRandomAccessList -java/util/Collections$UnmodifiableList -java/util/Collections$UnmodifiableCollection -java/util/ResourceBundle -java/util/ResourceBundle$1 -java/util/ResourceBundle$RBClassLoader -java/util/ResourceBundle$RBClassLoader$1 -java/util/ResourceBundle$CacheKey -java/util/ResourceBundle$LoaderReference -java/util/ResourceBundle$CacheKeyReference -java/util/ResourceBundle$SingleFormatControl -sun/awt/resources/awt -java/util/ListResourceBundle -java/awt/Toolkit$1 -java/io/FileNotFoundException -java/io/IOException -java/awt/GraphicsEnvironment -java/awt/GraphicsEnvironment$1 -java/awt/Insets -sun/awt/windows/WComponentPeer -java/awt/peer/ComponentPeer -java/awt/dnd/peer/DropTargetPeer -sun/awt/DisplayChangedListener -java/util/EventListener -sun/awt/windows/WObjectPeer -java/awt/Font -java/awt/geom/AffineTransform -sun/font/AttributeValues -sun/font/EAttribute -java/lang/Enum -java/text/AttributedCharacterIterator$Attribute -java/lang/Class$4 -sun/reflect/NativeMethodAccessorImpl -sun/reflect/DelegatingMethodAccessorImpl -java/awt/font/TextAttribute -java/lang/Integer$IntegerCache -java/util/WeakHashMap -java/util/WeakHashMap$Entry +com/sun/java/swing/SwingUtilities3 +com/sun/java/swing/plaf/windows/WindowsPopupWindow +com/sun/java/swing/plaf/windows/WindowsTabbedPaneUI +com/sun/swing/internal/plaf/basic/resources/basic +com/sun/swing/internal/plaf/metal/resources/metal +java/applet/Applet java/awt/AWTEvent -java/awt/Component$DummyRequestFocusController -sun/awt/RequestFocusController -java/awt/LayoutManager -java/awt/LightweightDispatcher -java/awt/event/AWTEventListener -java/awt/Dimension -java/awt/geom/Dimension2D -java/util/concurrent/atomic/AtomicBoolean -java/awt/ComponentOrientation -java/awt/Component$2 -java/lang/NoSuchMethodException -sun/awt/AppContext -sun/awt/AppContext$1 -sun/awt/AppContext$2 -sun/awt/MostRecentKeyValue -java/awt/Cursor -java/awt/Point -java/awt/geom/Point2D -sun/awt/Win32GraphicsEnvironment -sun/java2d/SunGraphicsEnvironment -sun/java2d/FontSupport -java/io/FilenameFilter -sun/awt/windows/WToolkit -sun/awt/SunToolkit -sun/awt/WindowClosingSupport -sun/awt/WindowClosingListener -sun/awt/ComponentFactory -sun/awt/InputMethodSupport -java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject -java/util/concurrent/locks/Condition -sun/awt/AWTAutoShutdown -sun/awt/SunToolkit$6 -java/awt/Dialog$ModalExclusionType -java/awt/Dialog -java/awt/Dialog$ModalityType -java/awt/ModalEventFilter -java/awt/EventFilter -sun/reflect/UnsafeFieldAccessorFactory -sun/awt/windows/WWindowPeer -java/awt/peer/WindowPeer -java/awt/peer/ContainerPeer -sun/awt/windows/WPanelPeer -java/awt/peer/PanelPeer -sun/awt/windows/WCanvasPeer -java/awt/peer/CanvasPeer -java/awt/Color -java/awt/Paint -java/awt/Transparency -java/awt/GraphicsConfiguration -java/awt/image/BufferStrategy -java/awt/dnd/DropTarget -java/awt/dnd/DropTargetListener -java/awt/event/ComponentListener -java/awt/event/FocusListener -java/awt/event/HierarchyListener -java/awt/event/HierarchyBoundsListener -java/awt/event/KeyListener -java/awt/event/MouseListener -java/awt/event/MouseMotionListener -java/awt/event/MouseWheelListener -java/awt/event/InputMethodListener -java/awt/event/ContainerListener -javax/accessibility/AccessibleContext -java/io/ObjectOutputStream -java/io/ObjectOutput -java/io/DataOutput -java/io/ObjectStreamConstants -java/io/ObjectInputStream -java/io/ObjectInput -java/io/DataInput -java/awt/HeadlessException -java/lang/UnsupportedOperationException -java/awt/Rectangle -java/awt/Shape -java/awt/geom/Rectangle2D -java/awt/geom/RectangularShape -java/awt/Image -java/awt/event/KeyEvent -java/awt/event/InputEvent -java/awt/event/ComponentEvent -java/awt/Event -java/awt/im/InputContext -java/awt/event/WindowListener -java/awt/event/WindowStateListener -java/awt/event/WindowFocusListener -java/awt/event/WindowEvent -java/lang/SecurityException -java/beans/PropertyChangeListener -java/awt/event/MouseWheelEvent -java/awt/event/MouseEvent -java/awt/BufferCapabilities -java/awt/AWTException -sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl -sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl -sun/java2d/SurfaceData -sun/java2d/DisposerTarget -sun/java2d/InvalidPipeException -java/lang/IllegalStateException -sun/java2d/NullSurfaceData -sun/java2d/loops/SurfaceType -sun/awt/image/PixelConverter -sun/awt/image/PixelConverter$Xrgb -sun/awt/image/PixelConverter$Argb -sun/awt/image/PixelConverter$ArgbPre -sun/awt/image/PixelConverter$Xbgr -sun/awt/image/PixelConverter$Rgba -sun/awt/image/PixelConverter$RgbaPre -sun/awt/image/PixelConverter$Ushort565Rgb -sun/awt/image/PixelConverter$Ushort555Rgb -sun/awt/image/PixelConverter$Ushort555Rgbx -sun/awt/image/PixelConverter$Ushort4444Argb -sun/awt/image/PixelConverter$ByteGray -sun/awt/image/PixelConverter$UshortGray -sun/awt/image/PixelConverter$Rgbx -sun/awt/image/PixelConverter$Bgrx -sun/awt/image/PixelConverter$ArgbBm -java/awt/image/ColorModel -java/awt/image/DirectColorModel -java/awt/image/PackedColorModel -java/awt/color/ColorSpace -java/awt/color/ICC_Profile -java/awt/color/ICC_ProfileRGB -java/awt/color/ICC_Profile$1 -java/awt/color/ICC_ColorSpace -sun/java2d/pipe/NullPipe -sun/java2d/pipe/PixelDrawPipe -sun/java2d/pipe/PixelFillPipe -sun/java2d/pipe/ShapeDrawPipe -sun/java2d/pipe/TextPipe -sun/java2d/pipe/DrawImagePipe -java/awt/image/IndexColorModel -sun/java2d/pipe/LoopPipe -sun/java2d/pipe/OutlineTextRenderer -sun/java2d/pipe/SolidTextRenderer -sun/java2d/pipe/GlyphListLoopPipe -sun/java2d/pipe/GlyphListPipe -sun/java2d/pipe/AATextRenderer -sun/java2d/pipe/LCDTextRenderer -sun/java2d/pipe/AlphaColorPipe -sun/java2d/pipe/CompositePipe -sun/java2d/pipe/PixelToShapeConverter -sun/java2d/pipe/TextRenderer -sun/java2d/pipe/SpanClipRenderer -sun/java2d/pipe/Region -sun/java2d/pipe/RegionIterator -sun/java2d/pipe/AlphaPaintPipe -sun/java2d/pipe/SpanShapeRenderer$Composite -sun/java2d/pipe/SpanShapeRenderer -sun/java2d/pipe/GeneralCompositePipe -sun/java2d/pipe/DrawImage -sun/java2d/loops/RenderCache -sun/java2d/loops/RenderCache$Entry -sun/awt/image/SunVolatileImage -java/awt/image/VolatileImage -java/awt/ImageCapabilities -java/awt/Image$1 -sun/awt/image/SurfaceManager$ImageAccessor -sun/awt/image/SurfaceManager -sun/awt/image/VolatileSurfaceManager -sun/java2d/windows/WindowsFlags -sun/java2d/windows/WindowsFlags$1 -sun/java2d/loops/Blit -sun/java2d/loops/GraphicsPrimitive -sun/java2d/loops/GraphicsPrimitiveMgr -sun/java2d/loops/CompositeType -sun/java2d/SunGraphics2D -sun/awt/ConstrainableGraphics -java/awt/Graphics2D -java/awt/Graphics -sun/java2d/loops/XORComposite -java/awt/Composite -java/awt/AlphaComposite -java/awt/geom/Path2D -java/awt/geom/Path2D$Float -sun/awt/SunHints -sun/java2d/loops/BlitBg -sun/java2d/loops/ScaledBlit -sun/java2d/loops/FillRect -sun/java2d/loops/FillSpans -sun/java2d/loops/DrawLine -sun/java2d/loops/DrawRect -sun/java2d/loops/DrawPolygons -sun/java2d/loops/DrawPath -sun/java2d/loops/FillPath -sun/java2d/loops/MaskBlit -sun/java2d/loops/MaskFill -sun/java2d/loops/DrawGlyphList -sun/java2d/loops/DrawGlyphListAA -sun/java2d/loops/DrawGlyphListLCD -sun/java2d/loops/TransformHelper -java/awt/BasicStroke -java/awt/Stroke -sun/misc/PerformanceLogger -sun/misc/PerformanceLogger$TimeData -sun/java2d/pipe/ValidatePipe -sun/awt/SunHints$Key -java/awt/RenderingHints$Key -sun/awt/SunHints$Value -sun/awt/SunHints$LCDContrastKey -sun/java2d/loops/CustomComponent -sun/java2d/loops/GraphicsPrimitiveProxy -sun/java2d/loops/GeneralRenderer -sun/java2d/loops/GraphicsPrimitiveMgr$1 -sun/java2d/loops/GraphicsPrimitiveMgr$2 -sun/java2d/windows/GDIBlitLoops -sun/java2d/windows/GDIRenderer -sun/awt/windows/WToolkit$1 -sun/awt/SunDisplayChanger -sun/java2d/SunGraphicsEnvironment$1 -sun/font/FontManager -sun/font/FileFont -sun/font/PhysicalFont -sun/font/Font2D -sun/font/CompositeFont -java/util/HashMap$Values -java/util/HashMap$ValueIterator -java/util/HashMap$HashIterator -sun/font/TrueTypeFont -java/awt/font/FontRenderContext -java/awt/RenderingHints -sun/font/Type1Font -java/awt/geom/Point2D$Float -sun/font/StrikeMetrics -java/awt/geom/Rectangle2D$Float -java/awt/geom/GeneralPath -sun/font/CharToGlyphMapper -sun/font/PhysicalStrike -sun/font/FontStrike -sun/font/GlyphList -sun/font/StrikeCache -sun/java2d/Disposer -sun/java2d/Disposer$1 -sun/font/StrikeCache$1 -sun/awt/windows/WFontConfiguration -sun/awt/FontConfiguration -sun/awt/FontDescriptor -java/io/DataInputStream -java/lang/Short$ShortCache -java/util/HashMap$KeyIterator -sun/font/CompositeFontDescriptor -sun/font/Font2DHandle -sun/font/FontFamily -java/awt/GraphicsDevice -sun/awt/Win32GraphicsDevice -sun/awt/Win32GraphicsConfig -java/awt/BorderLayout -java/awt/LayoutManager2 -java/awt/Toolkit$2 -sun/awt/SunToolkit$ModalityListenerList -sun/awt/ModalityListener -sun/awt/SunToolkit$1 -java/util/MissingResourceException -java/awt/EventQueue -java/awt/Queue -sun/awt/PostEventQueue -sun/awt/windows/WToolkit$ToolkitDisposer -sun/java2d/DisposerRecord -sun/awt/windows/WToolkit$2 -sun/awt/windows/WToolkit$3 -java/awt/Window$WindowDisposerRecord -java/awt/KeyboardFocusManager -java/awt/KeyEventDispatcher -java/awt/KeyEventPostProcessor -java/awt/event/NativeLibLoader +java/awt/AWTEvent$1 +java/awt/AWTEventMulticaster java/awt/AWTKeyStroke java/awt/AWTKeyStroke$1 -java/util/LinkedList -java/util/Deque -java/util/Queue -java/util/AbstractSequentialList -java/awt/DefaultKeyboardFocusManager -java/awt/DefaultFocusTraversalPolicy -java/awt/ContainerOrderFocusTraversalPolicy -java/awt/FocusTraversalPolicy -java/util/Collections$UnmodifiableSet -sun/awt/HeadlessToolkit -sun/awt/KeyboardFocusManagerPeerImpl -java/awt/peer/KeyboardFocusManagerPeer -sun/awt/windows/WFramePeer -java/awt/peer/FramePeer -sun/awt/RepaintArea -sun/awt/EmbeddedFrame -sun/awt/im/InputMethodWindow -sun/awt/windows/WComponentPeer$2 -sun/awt/PaintEventDispatcher -java/awt/event/InvocationEvent java/awt/ActiveEvent -java/awt/MenuComponent -sun/awt/SunToolkit$3 -java/util/EmptyStackException -java/lang/reflect/InvocationTargetException -java/awt/event/PaintEvent -java/awt/EventDispatchThread -sun/awt/PeerEvent -java/awt/EventQueue$1 -sun/java2d/loops/RenderLoops -java/awt/EventDispatchThread$1 -java/awt/Conditional -java/awt/EventDispatchThread$HierarchyEventFilter -java/awt/EventFilter$FilterAction -sun/awt/dnd/SunDragSourceContextPeer -java/awt/dnd/peer/DragSourceContextPeer -java/awt/event/InputMethodEvent -java/awt/event/ActionEvent -sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec -sun/awt/windows/WFileDialogPeer -java/awt/peer/FileDialogPeer -java/awt/peer/DialogPeer -sun/awt/windows/WPrintDialogPeer -sun/java2d/DefaultDisposerRecord -sun/awt/windows/WColor -sun/awt/windows/WFontPeer -sun/awt/PlatformFont -java/awt/peer/FontPeer -sun/awt/FontConfiguration$1 -sun/awt/windows/WingDings -sun/awt/windows/WingDings$Encoder -sun/awt/Symbol -sun/awt/Symbol$Encoder -sun/awt/im/InputMethodManager -sun/awt/im/ExecutableInputMethodManager -sun/awt/windows/WInputMethodDescriptor -java/awt/im/spi/InputMethodDescriptor -sun/awt/im/InputMethodLocator -sun/awt/im/ExecutableInputMethodManager$2 -sun/misc/Service -sun/misc/Service$LazyIterator -java/util/TreeSet -java/util/NavigableSet -java/util/SortedSet -java/util/TreeMap -java/util/NavigableMap -java/util/SortedMap -sun/misc/Launcher$1 -sun/misc/URLClassPath$2 -java/lang/ClassLoader$2 -sun/misc/URLClassPath$1 -java/net/URLClassLoader$3 -sun/misc/CompoundEnumeration -sun/misc/URLClassPath$JarLoader$1 -sun/misc/FileURLMapper -java/net/URLClassLoader$3$1 -sun/awt/SunToolkit$2 -sun/reflect/UnsafeObjectFieldAccessorImpl -java/awt/peer/LightweightPeer -sun/awt/windows/WLabelPeer -java/awt/peer/LabelPeer -java/awt/PopupMenu -java/awt/Menu -java/awt/MenuItem -java/io/PrintWriter -sun/awt/CausedFocusEvent$Cause -java/awt/PointerInfo +java/awt/Adjustable +java/awt/AlphaComposite +java/awt/BasicStroke +java/awt/BorderLayout +java/awt/BufferCapabilities +java/awt/Canvas +java/awt/CardLayout +java/awt/CardLayout$Card +java/awt/Color +java/awt/Component +java/awt/Component$1 +java/awt/Component$3 +java/awt/Component$AWTTreeLock +java/awt/Component$AccessibleAWTComponent java/awt/Component$BaselineResizeBehavior -java/awt/FontMetrics -java/awt/image/ImageProducer -java/awt/im/InputMethodRequests -java/awt/event/FocusEvent -java/awt/event/HierarchyEvent -javax/accessibility/AccessibleStateSet -java/awt/SequencedEvent -sun/awt/PlatformFont$PlatformFontCache -sun/awt/windows/WGlobalCursorManager -sun/awt/GlobalCursorManager -sun/awt/GlobalCursorManager$NativeUpdater -sun/nio/cs/UTF_16LE -sun/nio/cs/Unicode -sun/nio/cs/UTF_16LE$Encoder -sun/nio/cs/UnicodeEncoder -sun/nio/cs/UTF_16LE$Decoder -sun/nio/cs/UnicodeDecoder -sun/awt/event/IgnorePaintEvent -sun/awt/dnd/SunDropTargetEvent +java/awt/Component$BltBufferStrategy +java/awt/Component$BltSubRegionBufferStrategy +java/awt/Component$DummyRequestFocusController +java/awt/Component$FlipBufferStrategy +java/awt/ComponentOrientation +java/awt/Composite +java/awt/Conditional +java/awt/Container +java/awt/Container$1 +java/awt/Container$AccessibleAWTContainer +java/awt/ContainerOrderFocusTraversalPolicy +java/awt/Cursor +java/awt/Cursor$1 +java/awt/Cursor$CursorDisposer +java/awt/DefaultFocusTraversalPolicy +java/awt/DefaultKeyboardFocusManager +java/awt/DefaultKeyboardFocusManager$1 java/awt/DefaultKeyboardFocusManager$DefaultKeyboardFocusManagerSentEvent -java/awt/SentEvent -java/awt/KeyboardFocusManager$HeavyweightFocusRequest -java/util/LinkedList$ListItr -java/util/ListIterator java/awt/DefaultKeyboardFocusManager$TypeAheadMarker +java/awt/Dialog +java/awt/Dialog$ModalExclusionType +java/awt/Dialog$ModalityType +java/awt/Dimension +java/awt/Event +java/awt/EventDispatchThread +java/awt/EventDispatchThread$1 +java/awt/EventDispatchThread$HierarchyEventFilter +java/awt/EventFilter +java/awt/EventFilter$FilterAction +java/awt/EventQueue +java/awt/EventQueue$1 +java/awt/EventQueue$1AWTInvocationLock +java/awt/EventQueue$2 +java/awt/EventQueue$3 +java/awt/EventQueue$4 +java/awt/EventQueue$5 +java/awt/FlowLayout +java/awt/FocusTraversalPolicy +java/awt/Font +java/awt/Font$FontAccessImpl +java/awt/FontMetrics +java/awt/Frame +java/awt/Frame$1 +java/awt/Graphics +java/awt/Graphics2D +java/awt/GraphicsCallback +java/awt/GraphicsCallback$PaintCallback +java/awt/GraphicsConfiguration +java/awt/GraphicsDevice +java/awt/GraphicsEnvironment +java/awt/GraphicsEnvironment$1 +java/awt/GridLayout +java/awt/Image +java/awt/Image$1 +java/awt/ImageCapabilities +java/awt/ImageMediaEntry +java/awt/Insets +java/awt/ItemSelectable +java/awt/KeyEventDispatcher +java/awt/KeyEventPostProcessor +java/awt/KeyboardFocusManager +java/awt/KeyboardFocusManager$1 +java/awt/KeyboardFocusManager$3 +java/awt/KeyboardFocusManager$HeavyweightFocusRequest java/awt/KeyboardFocusManager$LightweightFocusRequest -javax/swing/JFrame -javax/swing/WindowConstants -javax/swing/RootPaneContainer -javax/swing/TransferHandler$HasGetTransferHandler -javax/swing/JLabel -javax/swing/SwingConstants +java/awt/Label +java/awt/LayoutManager +java/awt/LayoutManager2 +java/awt/LightweightDispatcher +java/awt/LightweightDispatcher$2 +java/awt/MediaEntry +java/awt/MediaTracker +java/awt/MenuBar +java/awt/MenuComponent +java/awt/MenuContainer +java/awt/ModalEventFilter +java/awt/Paint +java/awt/Panel +java/awt/Point +java/awt/PrintGraphics +java/awt/Queue +java/awt/Rectangle +java/awt/RenderingHints +java/awt/RenderingHints$Key +java/awt/SentEvent +java/awt/SequencedEvent +java/awt/SequencedEvent$1 +java/awt/Shape +java/awt/SplashScreen +java/awt/Stroke +java/awt/Toolkit +java/awt/Toolkit$1 +java/awt/Toolkit$2 +java/awt/Toolkit$3 +java/awt/Toolkit$4 +java/awt/Toolkit$5 +java/awt/Toolkit$DesktopPropertyChangeSupport +java/awt/Toolkit$DesktopPropertyChangeSupport$1 +java/awt/Toolkit$SelectiveAWTEventListener +java/awt/Toolkit$ToolkitEventMulticaster +java/awt/Transparency +java/awt/TrayIcon +java/awt/VKCollection +java/awt/Window +java/awt/Window$1 +java/awt/Window$1DisposeAction +java/awt/Window$Type +java/awt/Window$WindowDisposerRecord +java/awt/color/ColorSpace +java/awt/color/ICC_ColorSpace +java/awt/color/ICC_Profile +java/awt/color/ICC_Profile$1 +java/awt/color/ICC_ProfileRGB +java/awt/datatransfer/ClipboardOwner +java/awt/datatransfer/FlavorMap +java/awt/datatransfer/FlavorTable +java/awt/datatransfer/SystemFlavorMap +java/awt/dnd/DropTarget +java/awt/dnd/DropTargetContext +java/awt/dnd/DropTargetListener +java/awt/dnd/peer/DragSourceContextPeer +java/awt/dnd/peer/DropTargetPeer +java/awt/event/AWTEventListener +java/awt/event/AWTEventListenerProxy +java/awt/event/ActionEvent +java/awt/event/ActionListener +java/awt/event/AdjustmentEvent +java/awt/event/AdjustmentListener +java/awt/event/ComponentAdapter +java/awt/event/ComponentEvent +java/awt/event/ComponentListener +java/awt/event/ContainerEvent +java/awt/event/ContainerListener +java/awt/event/FocusAdapter +java/awt/event/FocusEvent +java/awt/event/FocusListener +java/awt/event/HierarchyBoundsListener +java/awt/event/HierarchyListener +java/awt/event/InputEvent +java/awt/event/InputEvent$1 +java/awt/event/InputMethodEvent +java/awt/event/InputMethodListener +java/awt/event/InvocationEvent +java/awt/event/InvocationEvent$1 +java/awt/event/ItemEvent +java/awt/event/ItemListener +java/awt/event/KeyAdapter +java/awt/event/KeyEvent +java/awt/event/KeyEvent$1 +java/awt/event/KeyListener +java/awt/event/MouseAdapter +java/awt/event/MouseEvent +java/awt/event/MouseListener +java/awt/event/MouseMotionAdapter +java/awt/event/MouseMotionListener +java/awt/event/MouseWheelListener +java/awt/event/NativeLibLoader +java/awt/event/NativeLibLoader$1 +java/awt/event/PaintEvent +java/awt/event/TextListener +java/awt/event/WindowAdapter +java/awt/event/WindowEvent +java/awt/event/WindowFocusListener +java/awt/event/WindowListener +java/awt/event/WindowStateListener +java/awt/font/FontRenderContext +java/awt/font/GlyphVector +java/awt/font/LineMetrics +java/awt/font/TextAttribute +java/awt/geom/AffineTransform +java/awt/geom/Dimension2D +java/awt/geom/GeneralPath +java/awt/geom/Line2D +java/awt/geom/Line2D$Float +java/awt/geom/LineIterator +java/awt/geom/Path2D +java/awt/geom/Path2D$Float +java/awt/geom/PathIterator +java/awt/geom/Point2D +java/awt/geom/Point2D$Float +java/awt/geom/RectIterator +java/awt/geom/Rectangle2D +java/awt/geom/Rectangle2D$Float +java/awt/geom/RectangularShape +java/awt/im/InputContext +java/awt/im/InputMethodRequests +java/awt/im/spi/InputMethod +java/awt/im/spi/InputMethodContext +java/awt/im/spi/InputMethodDescriptor +java/awt/image/BufferStrategy +java/awt/image/BufferedImage +java/awt/image/BufferedImage$1 +java/awt/image/ColorModel +java/awt/image/ColorModel$1 +java/awt/image/ComponentSampleModel +java/awt/image/DataBuffer +java/awt/image/DataBuffer$1 +java/awt/image/DataBufferByte +java/awt/image/DataBufferInt +java/awt/image/DirectColorModel +java/awt/image/FilteredImageSource +java/awt/image/ImageConsumer +java/awt/image/ImageFilter +java/awt/image/ImageObserver +java/awt/image/ImageProducer +java/awt/image/IndexColorModel +java/awt/image/PackedColorModel +java/awt/image/PixelInterleavedSampleModel +java/awt/image/RGBImageFilter +java/awt/image/Raster +java/awt/image/RenderedImage +java/awt/image/SampleModel +java/awt/image/SinglePixelPackedSampleModel +java/awt/image/VolatileImage +java/awt/image/WritableRaster +java/awt/image/WritableRenderedImage +java/awt/peer/CanvasPeer +java/awt/peer/ComponentPeer +java/awt/peer/ContainerPeer +java/awt/peer/FontPeer +java/awt/peer/FramePeer +java/awt/peer/KeyboardFocusManagerPeer +java/awt/peer/LabelPeer +java/awt/peer/LightweightPeer +java/awt/peer/PanelPeer +java/awt/peer/WindowPeer +java/awt/print/PrinterGraphics +java/beans/ChangeListenerMap +java/beans/PropertyChangeEvent +java/beans/PropertyChangeListener +java/beans/PropertyChangeListenerProxy +java/beans/PropertyChangeSupport +java/beans/PropertyChangeSupport$PropertyChangeListenerMap +java/beans/VetoableChangeListener +java/io/Bits +java/io/BufferedInputStream +java/io/BufferedOutputStream +java/io/BufferedReader +java/io/BufferedWriter +java/io/ByteArrayInputStream +java/io/ByteArrayOutputStream +java/io/Closeable +java/io/DataInput +java/io/DataInputStream +java/io/DataOutput +java/io/DataOutputStream +java/io/DefaultFileSystem +java/io/EOFException +java/io/ExpiringCache +java/io/ExpiringCache$1 +java/io/ExpiringCache$Entry +java/io/Externalizable +java/io/File +java/io/File$PathStatus +java/io/FileDescriptor +java/io/FileDescriptor$1 +java/io/FileInputStream +java/io/FileInputStream$1 +java/io/FileNotFoundException +java/io/FileOutputStream +java/io/FileOutputStream$1 +java/io/FilePermission +java/io/FilePermission$1 +java/io/FilePermissionCollection +java/io/FileReader +java/io/FileSystem +java/io/FileWriter +java/io/FilenameFilter +java/io/FilterInputStream +java/io/FilterOutputStream +java/io/FilterReader +java/io/Flushable +java/io/IOException +java/io/InputStream +java/io/InputStreamReader +java/io/InterruptedIOException +java/io/ObjectInput +java/io/ObjectInputStream +java/io/ObjectInputStream$BlockDataInputStream +java/io/ObjectInputStream$GetField +java/io/ObjectInputStream$GetFieldImpl +java/io/ObjectInputStream$HandleTable +java/io/ObjectInputStream$HandleTable$HandleList +java/io/ObjectInputStream$PeekInputStream +java/io/ObjectInputStream$ValidationList +java/io/ObjectOutput +java/io/ObjectOutputStream +java/io/ObjectOutputStream$BlockDataOutputStream +java/io/ObjectOutputStream$HandleTable +java/io/ObjectOutputStream$ReplaceTable +java/io/ObjectStreamClass +java/io/ObjectStreamClass$1 +java/io/ObjectStreamClass$2 +java/io/ObjectStreamClass$3 +java/io/ObjectStreamClass$4 +java/io/ObjectStreamClass$5 +java/io/ObjectStreamClass$Caches +java/io/ObjectStreamClass$ClassDataSlot +java/io/ObjectStreamClass$EntryFuture +java/io/ObjectStreamClass$ExceptionInfo +java/io/ObjectStreamClass$FieldReflector +java/io/ObjectStreamClass$FieldReflectorKey +java/io/ObjectStreamClass$MemberSignature +java/io/ObjectStreamClass$WeakClassKey +java/io/ObjectStreamConstants +java/io/ObjectStreamField +java/io/OutputStream +java/io/OutputStreamWriter +java/io/PrintStream +java/io/PushbackInputStream +java/io/RandomAccessFile +java/io/RandomAccessFile$1 +java/io/Reader +java/io/SerialCallbackContext +java/io/Serializable +java/io/StringReader +java/io/StringWriter +java/io/UnsupportedEncodingException +java/io/WinNTFileSystem +java/io/Writer +java/lang/AbstractStringBuilder +java/lang/Appendable +java/lang/ApplicationShutdownHooks +java/lang/ApplicationShutdownHooks$1 +java/lang/ArithmeticException +java/lang/ArrayIndexOutOfBoundsException +java/lang/ArrayStoreException +java/lang/AutoCloseable +java/lang/Boolean +java/lang/BootstrapMethodError +java/lang/Byte +java/lang/CharSequence +java/lang/Character +java/lang/Character$CharacterCache +java/lang/CharacterData +java/lang/CharacterData00 +java/lang/CharacterDataLatin1 +java/lang/Class +java/lang/Class$1 +java/lang/Class$3 +java/lang/Class$4 +java/lang/Class$AnnotationData +java/lang/Class$Atomic +java/lang/Class$ReflectionData +java/lang/ClassCastException +java/lang/ClassFormatError +java/lang/ClassLoader +java/lang/ClassLoader$2 +java/lang/ClassLoader$3 +java/lang/ClassLoader$NativeLibrary +java/lang/ClassLoader$ParallelLoaders +java/lang/ClassLoaderHelper +java/lang/ClassNotFoundException +java/lang/ClassValue$ClassValueMap +java/lang/CloneNotSupportedException +java/lang/Cloneable +java/lang/Comparable +java/lang/Compiler +java/lang/Compiler$1 +java/lang/Double +java/lang/Enum +java/lang/Error +java/lang/Exception +java/lang/ExceptionInInitializerError +java/lang/Float +java/lang/IllegalAccessError +java/lang/IllegalAccessException +java/lang/IllegalArgumentException +java/lang/IllegalMonitorStateException +java/lang/IllegalStateException +java/lang/IncompatibleClassChangeError +java/lang/IndexOutOfBoundsException +java/lang/InheritableThreadLocal +java/lang/InstantiationException +java/lang/Integer +java/lang/Integer$IntegerCache +java/lang/InternalError +java/lang/InterruptedException +java/lang/Iterable +java/lang/LinkageError +java/lang/Long +java/lang/Long$LongCache +java/lang/Math +java/lang/NoClassDefFoundError +java/lang/NoSuchFieldException +java/lang/NoSuchMethodError +java/lang/NoSuchMethodException +java/lang/NullPointerException +java/lang/Number +java/lang/NumberFormatException +java/lang/Object +java/lang/OutOfMemoryError +java/lang/Package +java/lang/ProcessEnvironment +java/lang/ProcessEnvironment$CheckedEntry +java/lang/ProcessEnvironment$CheckedEntrySet +java/lang/ProcessEnvironment$CheckedEntrySet$1 +java/lang/ProcessEnvironment$EntryComparator +java/lang/ProcessEnvironment$NameComparator +java/lang/Readable +java/lang/ReflectiveOperationException +java/lang/Runnable +java/lang/Runtime +java/lang/RuntimeException +java/lang/RuntimePermission +java/lang/SecurityException +java/lang/SecurityManager +java/lang/Short +java/lang/Short$ShortCache +java/lang/Shutdown +java/lang/Shutdown$Lock +java/lang/StackOverflowError +java/lang/StackTraceElement +java/lang/StrictMath +java/lang/String +java/lang/String$CaseInsensitiveComparator +java/lang/StringBuffer +java/lang/StringBuilder +java/lang/StringCoding +java/lang/StringCoding$StringDecoder +java/lang/StringCoding$StringEncoder +java/lang/StringIndexOutOfBoundsException +java/lang/System +java/lang/System$2 +java/lang/SystemClassLoaderAction +java/lang/Terminator +java/lang/Terminator$1 +java/lang/Thread +java/lang/Thread$State +java/lang/Thread$UncaughtExceptionHandler +java/lang/ThreadDeath +java/lang/ThreadGroup +java/lang/ThreadLocal +java/lang/ThreadLocal$ThreadLocalMap +java/lang/ThreadLocal$ThreadLocalMap$Entry +java/lang/Throwable +java/lang/Throwable$PrintStreamOrWriter +java/lang/Throwable$WrappedPrintStream +java/lang/UnsatisfiedLinkError +java/lang/UnsupportedOperationException +java/lang/VirtualMachineError +java/lang/Void +java/lang/annotation/Annotation +java/lang/invoke/CallSite +java/lang/invoke/ConstantCallSite +java/lang/invoke/DirectMethodHandle +java/lang/invoke/Invokers +java/lang/invoke/LambdaForm +java/lang/invoke/LambdaForm$NamedFunction +java/lang/invoke/MemberName +java/lang/invoke/MemberName$Factory +java/lang/invoke/MethodHandle +java/lang/invoke/MethodHandleImpl +java/lang/invoke/MethodHandleNatives +java/lang/invoke/MethodHandleStatics +java/lang/invoke/MethodHandleStatics$1 +java/lang/invoke/MethodType +java/lang/invoke/MethodType$ConcurrentWeakInternSet +java/lang/invoke/MethodType$ConcurrentWeakInternSet$WeakEntry +java/lang/invoke/MethodTypeForm +java/lang/invoke/MutableCallSite +java/lang/invoke/VolatileCallSite +java/lang/ref/FinalReference +java/lang/ref/Finalizer +java/lang/ref/Finalizer$FinalizerThread +java/lang/ref/PhantomReference +java/lang/ref/Reference +java/lang/ref/Reference$Lock +java/lang/ref/Reference$ReferenceHandler +java/lang/ref/ReferenceQueue +java/lang/ref/ReferenceQueue$Lock +java/lang/ref/ReferenceQueue$Null +java/lang/ref/SoftReference +java/lang/ref/WeakReference +java/lang/reflect/AccessibleObject +java/lang/reflect/AnnotatedElement +java/lang/reflect/Array +java/lang/reflect/Constructor +java/lang/reflect/Executable +java/lang/reflect/Field +java/lang/reflect/GenericDeclaration +java/lang/reflect/InvocationHandler +java/lang/reflect/InvocationTargetException +java/lang/reflect/Member +java/lang/reflect/Method +java/lang/reflect/Modifier +java/lang/reflect/Parameter +java/lang/reflect/Proxy +java/lang/reflect/Proxy$KeyFactory +java/lang/reflect/Proxy$ProxyClassFactory +java/lang/reflect/ReflectAccess +java/lang/reflect/ReflectPermission +java/lang/reflect/Type +java/lang/reflect/WeakCache +java/math/BigInteger +java/math/BigInteger$UnsafeHolder +java/math/MutableBigInteger +java/math/RoundingMode +java/math/SignedMutableBigInteger +java/net/AbstractPlainDatagramSocketImpl +java/net/AbstractPlainDatagramSocketImpl$1 +java/net/AbstractPlainSocketImpl +java/net/AbstractPlainSocketImpl$1 +java/net/Authenticator +java/net/BindException +java/net/ConnectException +java/net/DatagramPacket +java/net/DatagramPacket$1 +java/net/DatagramSocket +java/net/DatagramSocket$1 +java/net/DatagramSocketImpl +java/net/DefaultDatagramSocketImplFactory$1 +java/net/DefaultInterface +java/net/DualStackPlainDatagramSocketImpl +java/net/DualStackPlainSocketImpl +java/net/FileNameMap +java/net/HttpURLConnection +java/net/Inet4Address +java/net/Inet4AddressImpl +java/net/Inet6Address +java/net/Inet6Address$Inet6AddressHolder +java/net/Inet6AddressImpl +java/net/InetAddress +java/net/InetAddress$1 +java/net/InetAddress$2 +java/net/InetAddress$Cache +java/net/InetAddress$Cache$Type +java/net/InetAddress$CacheEntry +java/net/InetAddress$InetAddressHolder +java/net/InetAddressImpl +java/net/InetAddressImplFactory +java/net/InetSocketAddress +java/net/InetSocketAddress$InetSocketAddressHolder +java/net/InterfaceAddress +java/net/JarURLConnection +java/net/MalformedURLException +java/net/MulticastSocket +java/net/NetworkInterface +java/net/NetworkInterface$1 +java/net/NoRouteToHostException +java/net/Parts +java/net/PlainSocketImpl +java/net/PlainSocketImpl$1 +java/net/Proxy +java/net/Proxy$Type +java/net/ProxySelector +java/net/ServerSocket +java/net/Socket +java/net/SocketAddress +java/net/SocketException +java/net/SocketImpl +java/net/SocketImplFactory +java/net/SocketOptions +java/net/SocketTimeoutException +java/net/SocksConsts +java/net/SocksSocketImpl +java/net/SocksSocketImpl$3 +java/net/TwoStacksPlainDatagramSocketImpl +java/net/URI +java/net/URI$Parser +java/net/URL +java/net/URLClassLoader +java/net/URLClassLoader$1 +java/net/URLClassLoader$2 +java/net/URLClassLoader$3 +java/net/URLClassLoader$3$1 +java/net/URLClassLoader$7 +java/net/URLConnection +java/net/URLConnection$1 +java/net/URLStreamHandler +java/net/URLStreamHandlerFactory +java/net/UnknownHostException +java/nio/Bits +java/nio/Bits$1 +java/nio/Buffer +java/nio/ByteBuffer +java/nio/ByteBufferAsCharBufferB +java/nio/ByteBufferAsIntBufferB +java/nio/ByteBufferAsShortBufferB +java/nio/ByteOrder +java/nio/CharBuffer +java/nio/DirectByteBuffer +java/nio/DirectByteBuffer$Deallocator +java/nio/DirectLongBufferU +java/nio/HeapByteBuffer +java/nio/HeapCharBuffer +java/nio/IntBuffer +java/nio/LongBuffer +java/nio/MappedByteBuffer +java/nio/ShortBuffer +java/nio/channels/ByteChannel +java/nio/channels/Channel +java/nio/channels/FileChannel +java/nio/channels/GatheringByteChannel +java/nio/channels/InterruptibleChannel +java/nio/channels/NetworkChannel +java/nio/channels/ReadableByteChannel +java/nio/channels/ScatteringByteChannel +java/nio/channels/SeekableByteChannel +java/nio/channels/SelectableChannel +java/nio/channels/SocketChannel +java/nio/channels/WritableByteChannel +java/nio/channels/spi/AbstractInterruptibleChannel +java/nio/channels/spi/AbstractInterruptibleChannel$1 +java/nio/channels/spi/AbstractSelectableChannel +java/nio/charset/Charset +java/nio/charset/CharsetDecoder +java/nio/charset/CharsetEncoder +java/nio/charset/CoderResult +java/nio/charset/CoderResult$1 +java/nio/charset/CoderResult$2 +java/nio/charset/CoderResult$Cache +java/nio/charset/CodingErrorAction +java/nio/charset/StandardCharsets +java/nio/charset/spi/CharsetProvider +java/nio/file/Path +java/nio/file/Watchable +java/nio/file/attribute/FileAttribute +java/security/AccessControlContext +java/security/AccessController +java/security/AlgorithmParameters +java/security/AlgorithmParametersSpi +java/security/AllPermission +java/security/AllPermissionCollection +java/security/BasicPermission +java/security/BasicPermissionCollection +java/security/CodeSigner +java/security/CodeSource +java/security/GeneralSecurityException +java/security/Guard +java/security/InvalidKeyException +java/security/Key +java/security/KeyException +java/security/MessageDigest +java/security/MessageDigest$Delegate +java/security/MessageDigestSpi +java/security/NoSuchAlgorithmException +java/security/Permission +java/security/PermissionCollection +java/security/Permissions +java/security/Principal +java/security/PrivateKey +java/security/PrivilegedAction +java/security/PrivilegedActionException +java/security/PrivilegedExceptionAction +java/security/ProtectionDomain +java/security/ProtectionDomain$1 +java/security/ProtectionDomain$3 +java/security/ProtectionDomain$Key +java/security/Provider +java/security/Provider$EngineDescription +java/security/Provider$Service +java/security/Provider$ServiceKey +java/security/Provider$UString +java/security/PublicKey +java/security/SecureClassLoader +java/security/Security +java/security/Security$1 +java/security/Signature +java/security/Signature$Delegate +java/security/SignatureException +java/security/SignatureSpi +java/security/UnresolvedPermission +java/security/cert/Certificate +java/security/interfaces/DSAKey +java/security/interfaces/DSAParams +java/security/interfaces/DSAPrivateKey +java/security/interfaces/DSAPublicKey +java/security/spec/AlgorithmParameterSpec +java/security/spec/DSAParameterSpec +java/text/AttributedCharacterIterator$Attribute +java/text/CharacterIterator +java/text/Collator +java/text/DateFormat +java/text/DateFormat$Field +java/text/DateFormatSymbols +java/text/DecimalFormat +java/text/DecimalFormatSymbols +java/text/DigitList +java/text/DontCareFieldPosition +java/text/DontCareFieldPosition$1 +java/text/EntryPair +java/text/FieldPosition +java/text/Format +java/text/Format$Field +java/text/Format$FieldDelegate +java/text/MergeCollation +java/text/MessageFormat +java/text/MessageFormat$Field +java/text/NumberFormat +java/text/NumberFormat$Field +java/text/ParseException +java/text/PatternEntry +java/text/PatternEntry$Parser +java/text/RBCollationTables +java/text/RBCollationTables$BuildAPI +java/text/RuleBasedCollator +java/text/SimpleDateFormat +java/text/spi/BreakIteratorProvider +java/text/spi/CollatorProvider +java/text/spi/DateFormatProvider +java/text/spi/DateFormatSymbolsProvider +java/text/spi/DecimalFormatSymbolsProvider +java/text/spi/NumberFormatProvider +java/util/AbstractCollection +java/util/AbstractList +java/util/AbstractList$Itr +java/util/AbstractList$ListItr +java/util/AbstractMap +java/util/AbstractQueue +java/util/AbstractSequentialList +java/util/AbstractSet +java/util/ArrayDeque +java/util/ArrayList +java/util/ArrayList$Itr +java/util/ArrayList$ListItr +java/util/ArrayList$SubList +java/util/ArrayList$SubList$1 +java/util/Arrays +java/util/Arrays$ArrayList +java/util/Arrays$LegacyMergeSort +java/util/BitSet +java/util/Calendar +java/util/Calendar$Builder +java/util/Collection +java/util/Collections +java/util/Collections$3 +java/util/Collections$EmptyEnumeration +java/util/Collections$EmptyIterator +java/util/Collections$EmptyList +java/util/Collections$EmptyMap +java/util/Collections$EmptySet +java/util/Collections$SetFromMap +java/util/Collections$SynchronizedCollection +java/util/Collections$SynchronizedMap +java/util/Collections$SynchronizedSet +java/util/Collections$UnmodifiableCollection +java/util/Collections$UnmodifiableCollection$1 +java/util/Collections$UnmodifiableList +java/util/Collections$UnmodifiableList$1 +java/util/Collections$UnmodifiableMap +java/util/Collections$UnmodifiableRandomAccessList +java/util/Collections$UnmodifiableSet +java/util/ComparableTimSort +java/util/Comparator +java/util/Currency +java/util/Currency$1 +java/util/Currency$CurrencyNameGetter +java/util/Date +java/util/Deque +java/util/Dictionary +java/util/Enumeration +java/util/EventListener +java/util/EventListenerProxy +java/util/EventObject +java/util/GregorianCalendar +java/util/HashMap +java/util/HashMap$EntryIterator +java/util/HashMap$EntrySet +java/util/HashMap$HashIterator +java/util/HashMap$KeyIterator +java/util/HashMap$KeySet +java/util/HashMap$Node +java/util/HashMap$TreeNode +java/util/HashMap$ValueIterator +java/util/HashMap$Values +java/util/HashSet +java/util/Hashtable +java/util/Hashtable$Entry +java/util/Hashtable$EntrySet +java/util/Hashtable$Enumerator +java/util/Hashtable$ValueCollection +java/util/IdentityHashMap +java/util/IdentityHashMap$IdentityHashMapIterator +java/util/IdentityHashMap$KeyIterator +java/util/IdentityHashMap$KeySet +java/util/IdentityHashMap$ValueIterator +java/util/IdentityHashMap$Values +java/util/Iterator +java/util/LinkedHashMap +java/util/LinkedHashMap$Entry +java/util/LinkedHashMap$LinkedEntryIterator +java/util/LinkedHashMap$LinkedEntrySet +java/util/LinkedHashMap$LinkedHashIterator +java/util/LinkedHashMap$LinkedKeyIterator +java/util/LinkedHashMap$LinkedKeySet +java/util/LinkedList +java/util/LinkedList$ListItr +java/util/LinkedList$Node +java/util/List +java/util/ListIterator +java/util/ListResourceBundle +java/util/Locale +java/util/Locale$1 +java/util/Locale$Cache +java/util/Locale$Category +java/util/Locale$LocaleKey +java/util/Map +java/util/Map$Entry +java/util/MissingResourceException +java/util/NavigableMap +java/util/Objects +java/util/PriorityQueue +java/util/Properties +java/util/Properties$LineReader +java/util/PropertyResourceBundle +java/util/Queue +java/util/Random +java/util/RandomAccess +java/util/ResourceBundle +java/util/ResourceBundle$1 +java/util/ResourceBundle$BundleReference +java/util/ResourceBundle$CacheKey +java/util/ResourceBundle$CacheKeyReference +java/util/ResourceBundle$Control +java/util/ResourceBundle$Control$1 +java/util/ResourceBundle$Control$CandidateListCache +java/util/ResourceBundle$LoaderReference +java/util/ResourceBundle$RBClassLoader +java/util/ResourceBundle$RBClassLoader$1 +java/util/ResourceBundle$SingleFormatControl +java/util/ServiceLoader +java/util/ServiceLoader$1 +java/util/ServiceLoader$LazyIterator +java/util/Set +java/util/SortedMap +java/util/Stack +java/util/StringTokenizer +java/util/TimSort +java/util/TimeZone +java/util/TimeZone$1 +java/util/TreeMap +java/util/TreeMap$Entry +java/util/Vector +java/util/Vector$1 +java/util/Vector$Itr +java/util/Vector$ListItr +java/util/WeakHashMap +java/util/WeakHashMap$Entry +java/util/WeakHashMap$KeySet +java/util/concurrent/BlockingQueue +java/util/concurrent/ConcurrentHashMap +java/util/concurrent/ConcurrentHashMap$BaseIterator +java/util/concurrent/ConcurrentHashMap$CollectionView +java/util/concurrent/ConcurrentHashMap$CounterCell +java/util/concurrent/ConcurrentHashMap$EntrySetView +java/util/concurrent/ConcurrentHashMap$ForwardingNode +java/util/concurrent/ConcurrentHashMap$KeyIterator +java/util/concurrent/ConcurrentHashMap$KeySetView +java/util/concurrent/ConcurrentHashMap$Node +java/util/concurrent/ConcurrentHashMap$Segment +java/util/concurrent/ConcurrentHashMap$Traverser +java/util/concurrent/ConcurrentHashMap$ValueIterator +java/util/concurrent/ConcurrentHashMap$ValuesView +java/util/concurrent/ConcurrentMap +java/util/concurrent/CopyOnWriteArrayList +java/util/concurrent/DelayQueue +java/util/concurrent/Delayed +java/util/concurrent/TimeUnit +java/util/concurrent/TimeUnit$1 +java/util/concurrent/TimeUnit$2 +java/util/concurrent/TimeUnit$3 +java/util/concurrent/TimeUnit$4 +java/util/concurrent/TimeUnit$5 +java/util/concurrent/TimeUnit$6 +java/util/concurrent/TimeUnit$7 +java/util/concurrent/atomic/AtomicBoolean +java/util/concurrent/atomic/AtomicInteger +java/util/concurrent/atomic/AtomicLong +java/util/concurrent/atomic/AtomicMarkableReference +java/util/concurrent/atomic/AtomicMarkableReference$Pair +java/util/concurrent/atomic/AtomicReferenceFieldUpdater +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl +java/util/concurrent/atomic/AtomicReferenceFieldUpdater$AtomicReferenceFieldUpdaterImpl$1 +java/util/concurrent/locks/AbstractOwnableSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer +java/util/concurrent/locks/AbstractQueuedSynchronizer$ConditionObject +java/util/concurrent/locks/AbstractQueuedSynchronizer$Node +java/util/concurrent/locks/Condition +java/util/concurrent/locks/Lock +java/util/concurrent/locks/LockSupport +java/util/concurrent/locks/ReadWriteLock +java/util/concurrent/locks/ReentrantLock +java/util/concurrent/locks/ReentrantLock$NonfairSync +java/util/concurrent/locks/ReentrantLock$Sync +java/util/concurrent/locks/ReentrantReadWriteLock +java/util/concurrent/locks/ReentrantReadWriteLock$NonfairSync +java/util/concurrent/locks/ReentrantReadWriteLock$ReadLock +java/util/concurrent/locks/ReentrantReadWriteLock$Sync +java/util/concurrent/locks/ReentrantReadWriteLock$Sync$ThreadLocalHoldCounter +java/util/concurrent/locks/ReentrantReadWriteLock$WriteLock +java/util/function/BiFunction +java/util/jar/Attributes +java/util/jar/Attributes$Name +java/util/jar/JarEntry +java/util/jar/JarFile +java/util/jar/JarFile$JarEntryIterator +java/util/jar/JarFile$JarFileEntry +java/util/jar/JarVerifier +java/util/jar/JarVerifier$3 +java/util/jar/JavaUtilJarAccessImpl +java/util/jar/Manifest +java/util/jar/Manifest$FastInputStream +java/util/logging/Handler +java/util/logging/Level +java/util/logging/Level$KnownLevel +java/util/logging/LogManager +java/util/logging/LogManager$1 +java/util/logging/LogManager$2 +java/util/logging/LogManager$3 +java/util/logging/LogManager$5 +java/util/logging/LogManager$Cleaner +java/util/logging/LogManager$LogNode +java/util/logging/LogManager$LoggerContext +java/util/logging/LogManager$LoggerContext$1 +java/util/logging/LogManager$LoggerWeakRef +java/util/logging/LogManager$RootLogger +java/util/logging/LogManager$SystemLoggerContext +java/util/logging/Logger +java/util/logging/Logger$1 +java/util/logging/LoggingPermission +java/util/logging/LoggingProxyImpl +java/util/spi/CalendarDataProvider +java/util/spi/CurrencyNameProvider +java/util/spi/LocaleNameProvider +java/util/spi/LocaleServiceProvider +java/util/spi/ResourceBundleControlProvider +java/util/spi/TimeZoneNameProvider +java/util/zip/CRC32 +java/util/zip/Checksum +java/util/zip/DeflaterOutputStream +java/util/zip/GZIPInputStream +java/util/zip/Inflater +java/util/zip/InflaterInputStream +java/util/zip/ZStreamRef +java/util/zip/ZipCoder +java/util/zip/ZipConstants +java/util/zip/ZipEntry +java/util/zip/ZipFile +java/util/zip/ZipFile$1 +java/util/zip/ZipFile$ZipEntryIterator +java/util/zip/ZipFile$ZipFileInflaterInputStream +java/util/zip/ZipFile$ZipFileInputStream +java/util/zip/ZipInputStream +java/util/zip/ZipUtils +javax/accessibility/Accessible +javax/accessibility/AccessibleAction +javax/accessibility/AccessibleBundle +javax/accessibility/AccessibleComponent +javax/accessibility/AccessibleContext +javax/accessibility/AccessibleExtendedComponent +javax/accessibility/AccessibleRelationSet +javax/accessibility/AccessibleState +javax/accessibility/AccessibleText +javax/accessibility/AccessibleValue +javax/security/auth/Destroyable +javax/sound/sampled/Control$Type +javax/sound/sampled/DataLine +javax/sound/sampled/DataLine$Info +javax/sound/sampled/FloatControl$Type +javax/sound/sampled/Line +javax/sound/sampled/Line$Info +javax/sound/sampled/LineUnavailableException +javax/sound/sampled/UnsupportedAudioFileException +javax/swing/AbstractAction +javax/swing/AbstractButton +javax/swing/AbstractButton$AccessibleAbstractButton +javax/swing/AbstractButton$Handler +javax/swing/AbstractCellEditor +javax/swing/AbstractListModel +javax/swing/Action +javax/swing/ActionMap +javax/swing/AncestorNotifier +javax/swing/ArrayTable +javax/swing/BorderFactory +javax/swing/BoundedRangeModel +javax/swing/Box +javax/swing/Box$Filler +javax/swing/BoxLayout +javax/swing/BufferStrategyPaintManager +javax/swing/BufferStrategyPaintManager$BufferInfo +javax/swing/ButtonGroup +javax/swing/ButtonModel +javax/swing/CellEditor +javax/swing/CellRendererPane +javax/swing/ClientPropertyKey +javax/swing/ClientPropertyKey$1 +javax/swing/ComboBoxEditor +javax/swing/ComboBoxModel +javax/swing/ComponentInputMap +javax/swing/DefaultBoundedRangeModel +javax/swing/DefaultButtonModel +javax/swing/DefaultCellEditor +javax/swing/DefaultCellEditor$1 +javax/swing/DefaultCellEditor$EditorDelegate +javax/swing/DefaultComboBoxModel +javax/swing/DefaultListCellRenderer +javax/swing/DefaultListCellRenderer$UIResource +javax/swing/DefaultListModel +javax/swing/DefaultListSelectionModel +javax/swing/DefaultSingleSelectionModel +javax/swing/DropMode +javax/swing/FocusManager +javax/swing/GrayFilter +javax/swing/Icon +javax/swing/ImageIcon +javax/swing/ImageIcon$1 +javax/swing/ImageIcon$2 +javax/swing/ImageIcon$2$1 +javax/swing/ImageIcon$3 +javax/swing/InputMap +javax/swing/InternalFrameFocusTraversalPolicy +javax/swing/JButton +javax/swing/JCheckBox +javax/swing/JCheckBoxMenuItem +javax/swing/JCheckBoxMenuItem$AccessibleJCheckBoxMenuItem +javax/swing/JComboBox +javax/swing/JComboBox$1 +javax/swing/JComboBox$KeySelectionManager javax/swing/JComponent javax/swing/JComponent$1 -javax/swing/SwingUtilities -javax/swing/JRootPane -sun/security/action/GetBooleanAction -javax/swing/event/EventListenerList +javax/swing/JComponent$2 +javax/swing/JComponent$AccessibleJComponent +javax/swing/JDialog +javax/swing/JEditorPane +javax/swing/JFrame +javax/swing/JInternalFrame +javax/swing/JLabel +javax/swing/JLayer +javax/swing/JLayeredPane +javax/swing/JList +javax/swing/JList$3 +javax/swing/JList$ListSelectionHandler +javax/swing/JMenu +javax/swing/JMenu$MenuChangeListener +javax/swing/JMenu$WinListener +javax/swing/JMenuBar +javax/swing/JMenuItem +javax/swing/JMenuItem$AccessibleJMenuItem +javax/swing/JMenuItem$MenuItemFocusListener javax/swing/JPanel -java/awt/FlowLayout -javax/swing/UIManager -javax/swing/UIManager$LookAndFeelInfo -sun/awt/windows/WDesktopProperties -sun/awt/windows/WDesktopProperties$WinPlaySound -sun/awt/shell/Win32ShellFolderManager2 -sun/awt/shell/ShellFolderManager -sun/swing/SwingUtilities2 -sun/swing/SwingUtilities2$LSBCacheEntry -javax/swing/UIManager$LAFState -javax/swing/UIDefaults -javax/swing/MultiUIDefaults -javax/swing/UIManager$1 -javax/swing/plaf/metal/MetalLookAndFeel -javax/swing/plaf/basic/BasicLookAndFeel +javax/swing/JPopupMenu +javax/swing/JPopupMenu$Separator +javax/swing/JProgressBar +javax/swing/JProgressBar$ModelListener +javax/swing/JRadioButton +javax/swing/JRadioButtonMenuItem +javax/swing/JRootPane +javax/swing/JRootPane$1 +javax/swing/JRootPane$RootLayout +javax/swing/JScrollBar +javax/swing/JScrollBar$ModelListener +javax/swing/JScrollPane +javax/swing/JScrollPane$ScrollBar +javax/swing/JSeparator +javax/swing/JSlider +javax/swing/JSlider$ModelListener +javax/swing/JSplitPane +javax/swing/JTabbedPane +javax/swing/JTabbedPane$ModelListener +javax/swing/JTabbedPane$Page +javax/swing/JTable +javax/swing/JTable$2 +javax/swing/JTable$5 +javax/swing/JTable$Resizable2 +javax/swing/JTable$Resizable3 +javax/swing/JTextArea +javax/swing/JTextField +javax/swing/JTextField$NotifyAction +javax/swing/JTextField$ScrollRepainter +javax/swing/JToggleButton +javax/swing/JToggleButton$ToggleButtonModel +javax/swing/JToolBar +javax/swing/JToolBar$DefaultToolBarLayout +javax/swing/JToolBar$Separator +javax/swing/JToolTip +javax/swing/JTree +javax/swing/JTree$TreeModelHandler +javax/swing/JTree$TreeSelectionRedirector +javax/swing/JViewport +javax/swing/JViewport$ViewListener +javax/swing/JWindow +javax/swing/KeyStroke +javax/swing/KeyboardManager +javax/swing/KeyboardManager$ComponentKeyStrokePair +javax/swing/LayoutComparator +javax/swing/LayoutFocusTraversalPolicy +javax/swing/ListCellRenderer +javax/swing/ListModel +javax/swing/ListSelectionModel javax/swing/LookAndFeel -sun/swing/DefaultLookup -javax/swing/plaf/metal/OceanTheme -javax/swing/plaf/metal/DefaultMetalTheme -javax/swing/plaf/metal/MetalTheme -javax/swing/plaf/ColorUIResource -javax/swing/plaf/UIResource -sun/swing/PrintColorUIResource -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate -javax/swing/plaf/FontUIResource -sun/swing/SwingLazyValue -javax/swing/UIDefaults$LazyValue +javax/swing/MenuElement +javax/swing/MenuSelectionManager +javax/swing/MultiUIDefaults +javax/swing/MutableComboBoxModel +javax/swing/Popup$HeavyWeightWindow +javax/swing/RepaintManager +javax/swing/RepaintManager$1 +javax/swing/RepaintManager$1$1 +javax/swing/RepaintManager$2 +javax/swing/RepaintManager$3 +javax/swing/RepaintManager$DisplayChangedHandler +javax/swing/RepaintManager$PaintManager +javax/swing/RepaintManager$ProcessingRunnable +javax/swing/RootPaneContainer +javax/swing/ScrollPaneConstants +javax/swing/ScrollPaneLayout +javax/swing/ScrollPaneLayout$UIResource +javax/swing/Scrollable +javax/swing/SingleSelectionModel +javax/swing/SizeRequirements +javax/swing/SortingFocusTraversalPolicy +javax/swing/SwingConstants +javax/swing/SwingContainerOrderFocusTraversalPolicy +javax/swing/SwingDefaultFocusTraversalPolicy +javax/swing/SwingPaintEventDispatcher +javax/swing/SwingUtilities +javax/swing/SwingUtilities$SharedOwnerFrame +javax/swing/Timer +javax/swing/Timer$DoPostEvent +javax/swing/TimerQueue +javax/swing/TimerQueue$1 +javax/swing/TimerQueue$DelayedTimer +javax/swing/ToolTipManager +javax/swing/ToolTipManager$AccessibilityKeyListener +javax/swing/ToolTipManager$MoveBeforeEnterListener +javax/swing/ToolTipManager$insideTimerAction +javax/swing/ToolTipManager$outsideTimerAction +javax/swing/ToolTipManager$stillInsideTimerAction +javax/swing/TransferHandler +javax/swing/TransferHandler$DropHandler +javax/swing/TransferHandler$HasGetTransferHandler +javax/swing/TransferHandler$SwingDropTarget +javax/swing/TransferHandler$TransferAction +javax/swing/TransferHandler$TransferSupport +javax/swing/UIDefaults javax/swing/UIDefaults$ActiveValue -javax/swing/plaf/InsetsUIResource -sun/swing/SwingUtilities2$2 -javax/swing/plaf/basic/BasicLookAndFeel$2 -javax/swing/plaf/DimensionUIResource javax/swing/UIDefaults$LazyInputMap -java/lang/Character$CharacterCache -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue -javax/swing/plaf/metal/MetalLookAndFeel$FontActiveValue -sun/swing/SwingUtilities2$AATextInfo -java/util/HashMap$EntrySet -java/util/HashMap$EntryIterator +javax/swing/UIDefaults$LazyValue +javax/swing/UIDefaults$TextAndMnemonicHashMap +javax/swing/UIManager +javax/swing/UIManager$1 +javax/swing/UIManager$2 +javax/swing/UIManager$LAFState +javax/swing/UIManager$LookAndFeelInfo +javax/swing/UnsupportedLookAndFeelException +javax/swing/ViewportLayout +javax/swing/WindowConstants +javax/swing/border/AbstractBorder +javax/swing/border/BevelBorder +javax/swing/border/Border +javax/swing/border/CompoundBorder +javax/swing/border/EmptyBorder +javax/swing/border/EtchedBorder +javax/swing/border/LineBorder +javax/swing/border/MatteBorder +javax/swing/border/TitledBorder +javax/swing/event/AncestorListener +javax/swing/event/CaretEvent +javax/swing/event/CaretListener +javax/swing/event/CellEditorListener +javax/swing/event/ChangeEvent +javax/swing/event/ChangeListener +javax/swing/event/DocumentEvent +javax/swing/event/DocumentEvent$ElementChange +javax/swing/event/DocumentEvent$EventType +javax/swing/event/DocumentListener +javax/swing/event/EventListenerList +javax/swing/event/ListDataEvent +javax/swing/event/ListDataListener +javax/swing/event/ListSelectionEvent +javax/swing/event/ListSelectionListener +javax/swing/event/MenuDragMouseListener +javax/swing/event/MenuEvent +javax/swing/event/MenuKeyListener +javax/swing/event/MenuListener +javax/swing/event/MouseInputAdapter +javax/swing/event/MouseInputListener +javax/swing/event/PopupMenuListener +javax/swing/event/RowSorterListener +javax/swing/event/SwingPropertyChangeSupport +javax/swing/event/TableColumnModelEvent +javax/swing/event/TableColumnModelListener +javax/swing/event/TableModelEvent +javax/swing/event/TableModelListener +javax/swing/event/TreeExpansionListener +javax/swing/event/TreeModelEvent +javax/swing/event/TreeModelListener +javax/swing/event/TreeSelectionEvent +javax/swing/event/TreeSelectionListener +javax/swing/event/UndoableEditEvent +javax/swing/event/UndoableEditListener +javax/swing/filechooser/FileFilter +javax/swing/filechooser/FileSystemView +javax/swing/filechooser/FileSystemView$1 +javax/swing/filechooser/WindowsFileSystemView +javax/swing/plaf/ActionMapUIResource +javax/swing/plaf/BorderUIResource +javax/swing/plaf/BorderUIResource$CompoundBorderUIResource +javax/swing/plaf/BorderUIResource$EmptyBorderUIResource +javax/swing/plaf/BorderUIResource$LineBorderUIResource +javax/swing/plaf/ButtonUI +javax/swing/plaf/ColorUIResource +javax/swing/plaf/ComboBoxUI +javax/swing/plaf/ComponentInputMapUIResource +javax/swing/plaf/ComponentUI +javax/swing/plaf/DimensionUIResource +javax/swing/plaf/FontUIResource +javax/swing/plaf/InputMapUIResource +javax/swing/plaf/InsetsUIResource +javax/swing/plaf/LabelUI +javax/swing/plaf/ListUI +javax/swing/plaf/MenuBarUI +javax/swing/plaf/MenuItemUI +javax/swing/plaf/PanelUI +javax/swing/plaf/PopupMenuUI +javax/swing/plaf/ProgressBarUI +javax/swing/plaf/RootPaneUI +javax/swing/plaf/ScrollBarUI +javax/swing/plaf/ScrollPaneUI +javax/swing/plaf/SeparatorUI +javax/swing/plaf/SliderUI +javax/swing/plaf/SplitPaneUI +javax/swing/plaf/TabbedPaneUI +javax/swing/plaf/TableHeaderUI +javax/swing/plaf/TableUI +javax/swing/plaf/TextUI +javax/swing/plaf/ToolBarUI +javax/swing/plaf/TreeUI +javax/swing/plaf/UIResource +javax/swing/plaf/ViewportUI +javax/swing/plaf/basic/BasicArrowButton +javax/swing/plaf/basic/BasicBorders +javax/swing/plaf/basic/BasicBorders$ButtonBorder +javax/swing/plaf/basic/BasicBorders$MarginBorder +javax/swing/plaf/basic/BasicBorders$RadioButtonBorder +javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder +javax/swing/plaf/basic/BasicBorders$SplitPaneBorder +javax/swing/plaf/basic/BasicBorders$SplitPaneDividerBorder +javax/swing/plaf/basic/BasicButtonListener +javax/swing/plaf/basic/BasicButtonUI +javax/swing/plaf/basic/BasicCheckBoxMenuItemUI +javax/swing/plaf/basic/BasicComboBoxEditor +javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField +javax/swing/plaf/basic/BasicComboBoxEditor$UIResource +javax/swing/plaf/basic/BasicComboBoxRenderer +javax/swing/plaf/basic/BasicComboBoxRenderer$UIResource +javax/swing/plaf/basic/BasicComboBoxUI +javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager +javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager +javax/swing/plaf/basic/BasicComboBoxUI$Handler +javax/swing/plaf/basic/BasicComboBoxUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicComboPopup +javax/swing/plaf/basic/BasicComboPopup$1 +javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass +javax/swing/plaf/basic/BasicComboPopup$Handler +javax/swing/plaf/basic/BasicGraphicsUtils +javax/swing/plaf/basic/BasicHTML +javax/swing/plaf/basic/BasicLabelUI +javax/swing/plaf/basic/BasicListUI +javax/swing/plaf/basic/BasicListUI$Handler +javax/swing/plaf/basic/BasicListUI$ListTransferHandler +javax/swing/plaf/basic/BasicLookAndFeel +javax/swing/plaf/basic/BasicLookAndFeel$1 +javax/swing/plaf/basic/BasicLookAndFeel$2 +javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper +javax/swing/plaf/basic/BasicMenuBarUI +javax/swing/plaf/basic/BasicMenuBarUI$Handler +javax/swing/plaf/basic/BasicMenuItemUI +javax/swing/plaf/basic/BasicMenuItemUI$Handler +javax/swing/plaf/basic/BasicMenuUI +javax/swing/plaf/basic/BasicMenuUI$Handler +javax/swing/plaf/basic/BasicPanelUI +javax/swing/plaf/basic/BasicPopupMenuUI +javax/swing/plaf/basic/BasicPopupMenuUI$BasicMenuKeyListener +javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener +javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper +javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper$1 +javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber +javax/swing/plaf/basic/BasicProgressBarUI +javax/swing/plaf/basic/BasicProgressBarUI$Handler +javax/swing/plaf/basic/BasicRadioButtonMenuItemUI +javax/swing/plaf/basic/BasicRadioButtonUI +javax/swing/plaf/basic/BasicRootPaneUI +javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap +javax/swing/plaf/basic/BasicScrollBarUI +javax/swing/plaf/basic/BasicScrollBarUI$ArrowButtonListener +javax/swing/plaf/basic/BasicScrollBarUI$Handler +javax/swing/plaf/basic/BasicScrollBarUI$ModelListener +javax/swing/plaf/basic/BasicScrollBarUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicScrollBarUI$ScrollListener +javax/swing/plaf/basic/BasicScrollBarUI$TrackListener +javax/swing/plaf/basic/BasicScrollPaneUI +javax/swing/plaf/basic/BasicScrollPaneUI$Handler +javax/swing/plaf/basic/BasicSeparatorUI +javax/swing/plaf/basic/BasicSliderUI +javax/swing/plaf/basic/BasicSliderUI$Actions +javax/swing/plaf/basic/BasicSliderUI$Handler +javax/swing/plaf/basic/BasicSliderUI$PropertyChangeHandler +javax/swing/plaf/basic/BasicSliderUI$ScrollListener +javax/swing/plaf/basic/BasicSliderUI$TrackListener +javax/swing/plaf/basic/BasicSplitPaneDivider +javax/swing/plaf/basic/BasicSplitPaneDivider$DividerLayout +javax/swing/plaf/basic/BasicSplitPaneDivider$MouseHandler +javax/swing/plaf/basic/BasicSplitPaneDivider$OneTouchActionHandler +javax/swing/plaf/basic/BasicSplitPaneUI +javax/swing/plaf/basic/BasicSplitPaneUI$1 +javax/swing/plaf/basic/BasicSplitPaneUI$BasicHorizontalLayoutManager +javax/swing/plaf/basic/BasicSplitPaneUI$Handler +javax/swing/plaf/basic/BasicTabbedPaneUI +javax/swing/plaf/basic/BasicTabbedPaneUI$Handler +javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneLayout +javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneScrollLayout +javax/swing/plaf/basic/BasicTableHeaderUI +javax/swing/plaf/basic/BasicTableHeaderUI$1 +javax/swing/plaf/basic/BasicTableHeaderUI$MouseInputHandler +javax/swing/plaf/basic/BasicTableUI +javax/swing/plaf/basic/BasicTableUI$Handler +javax/swing/plaf/basic/BasicTableUI$TableTransferHandler +javax/swing/plaf/basic/BasicTextAreaUI +javax/swing/plaf/basic/BasicTextFieldUI +javax/swing/plaf/basic/BasicTextUI +javax/swing/plaf/basic/BasicTextUI$BasicCaret +javax/swing/plaf/basic/BasicTextUI$BasicCursor +javax/swing/plaf/basic/BasicTextUI$BasicHighlighter +javax/swing/plaf/basic/BasicTextUI$DragListener +javax/swing/plaf/basic/BasicTextUI$FocusAction +javax/swing/plaf/basic/BasicTextUI$RootView +javax/swing/plaf/basic/BasicTextUI$TextActionWrapper +javax/swing/plaf/basic/BasicTextUI$TextTransferHandler +javax/swing/plaf/basic/BasicTextUI$UpdateHandler +javax/swing/plaf/basic/BasicToggleButtonUI +javax/swing/plaf/basic/BasicToolBarSeparatorUI +javax/swing/plaf/basic/BasicToolBarUI +javax/swing/plaf/basic/BasicToolBarUI$DockingListener +javax/swing/plaf/basic/BasicToolBarUI$Handler +javax/swing/plaf/basic/BasicTreeUI +javax/swing/plaf/basic/BasicTreeUI$Actions +javax/swing/plaf/basic/BasicTreeUI$Handler +javax/swing/plaf/basic/BasicTreeUI$NodeDimensionsHandler +javax/swing/plaf/basic/BasicTreeUI$TreeTransferHandler +javax/swing/plaf/basic/BasicViewportUI +javax/swing/plaf/basic/ComboPopup +javax/swing/plaf/basic/DefaultMenuLayout +javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag +javax/swing/plaf/basic/LazyActionMap +javax/swing/plaf/metal/BumpBuffer +javax/swing/plaf/metal/DefaultMetalTheme +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate +javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 +javax/swing/plaf/metal/MetalBorders +javax/swing/plaf/metal/MetalBorders$ButtonBorder +javax/swing/plaf/metal/MetalBorders$Flush3DBorder +javax/swing/plaf/metal/MetalBorders$MenuBarBorder +javax/swing/plaf/metal/MetalBorders$MenuItemBorder +javax/swing/plaf/metal/MetalBorders$PopupMenuBorder +javax/swing/plaf/metal/MetalBorders$RolloverButtonBorder +javax/swing/plaf/metal/MetalBorders$RolloverMarginBorder +javax/swing/plaf/metal/MetalBorders$ScrollPaneBorder +javax/swing/plaf/metal/MetalBorders$TextFieldBorder +javax/swing/plaf/metal/MetalBorders$ToggleButtonBorder +javax/swing/plaf/metal/MetalBorders$ToolBarBorder +javax/swing/plaf/metal/MetalBumps +javax/swing/plaf/metal/MetalButtonUI +javax/swing/plaf/metal/MetalCheckBoxUI +javax/swing/plaf/metal/MetalComboBoxButton +javax/swing/plaf/metal/MetalComboBoxButton$1 +javax/swing/plaf/metal/MetalComboBoxEditor +javax/swing/plaf/metal/MetalComboBoxEditor$1 +javax/swing/plaf/metal/MetalComboBoxEditor$EditorBorder +javax/swing/plaf/metal/MetalComboBoxEditor$UIResource +javax/swing/plaf/metal/MetalComboBoxIcon +javax/swing/plaf/metal/MetalComboBoxUI +javax/swing/plaf/metal/MetalComboBoxUI$MetalComboBoxLayoutManager +javax/swing/plaf/metal/MetalComboBoxUI$MetalPropertyChangeListener +javax/swing/plaf/metal/MetalIconFactory +javax/swing/plaf/metal/MetalIconFactory$CheckBoxIcon +javax/swing/plaf/metal/MetalIconFactory$CheckBoxMenuItemIcon +javax/swing/plaf/metal/MetalIconFactory$FolderIcon16 +javax/swing/plaf/metal/MetalIconFactory$HorizontalSliderThumbIcon +javax/swing/plaf/metal/MetalIconFactory$MenuArrowIcon +javax/swing/plaf/metal/MetalIconFactory$MenuItemArrowIcon +javax/swing/plaf/metal/MetalIconFactory$RadioButtonIcon +javax/swing/plaf/metal/MetalIconFactory$RadioButtonMenuItemIcon +javax/swing/plaf/metal/MetalIconFactory$TreeFolderIcon +javax/swing/plaf/metal/MetalIconFactory$VerticalSliderThumbIcon +javax/swing/plaf/metal/MetalLabelUI +javax/swing/plaf/metal/MetalLookAndFeel javax/swing/plaf/metal/MetalLookAndFeel$AATextListener -java/beans/PropertyChangeListenerProxy -java/util/EventListenerProxy -sun/awt/EventListenerAggregate -javax/swing/UIDefaults$ProxyLazyValue +javax/swing/plaf/metal/MetalLookAndFeel$FontActiveValue +javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue +javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue$1 +javax/swing/plaf/metal/MetalPopupMenuSeparatorUI +javax/swing/plaf/metal/MetalProgressBarUI +javax/swing/plaf/metal/MetalRadioButtonUI +javax/swing/plaf/metal/MetalRootPaneUI +javax/swing/plaf/metal/MetalScrollBarUI +javax/swing/plaf/metal/MetalScrollBarUI$ScrollBarListener +javax/swing/plaf/metal/MetalScrollButton +javax/swing/plaf/metal/MetalScrollPaneUI +javax/swing/plaf/metal/MetalScrollPaneUI$1 +javax/swing/plaf/metal/MetalSeparatorUI +javax/swing/plaf/metal/MetalSliderUI +javax/swing/plaf/metal/MetalSliderUI$MetalPropertyListener +javax/swing/plaf/metal/MetalSplitPaneDivider +javax/swing/plaf/metal/MetalSplitPaneDivider$1 +javax/swing/plaf/metal/MetalSplitPaneDivider$2 +javax/swing/plaf/metal/MetalSplitPaneUI +javax/swing/plaf/metal/MetalTabbedPaneUI +javax/swing/plaf/metal/MetalTabbedPaneUI$TabbedPaneLayout +javax/swing/plaf/metal/MetalTextFieldUI +javax/swing/plaf/metal/MetalTheme +javax/swing/plaf/metal/MetalToggleButtonUI +javax/swing/plaf/metal/MetalToolBarUI +javax/swing/plaf/metal/MetalToolBarUI$MetalDockingListener +javax/swing/plaf/metal/MetalTreeUI +javax/swing/plaf/metal/MetalTreeUI$LineListener +javax/swing/plaf/metal/MetalUtils +javax/swing/plaf/metal/OceanTheme javax/swing/plaf/metal/OceanTheme$1 javax/swing/plaf/metal/OceanTheme$2 javax/swing/plaf/metal/OceanTheme$3 javax/swing/plaf/metal/OceanTheme$4 javax/swing/plaf/metal/OceanTheme$5 javax/swing/plaf/metal/OceanTheme$6 -javax/swing/FocusManager -javax/swing/LayoutFocusTraversalPolicy -javax/swing/SortingFocusTraversalPolicy -javax/swing/InternalFrameFocusTraversalPolicy -javax/swing/SwingContainerOrderFocusTraversalPolicy -javax/swing/SwingDefaultFocusTraversalPolicy -javax/swing/LayoutComparator -javax/swing/RepaintManager -javax/swing/RepaintManager$DisplayChangedHandler -javax/swing/SwingPaintEventDispatcher -javax/swing/UIManager$2 -com/sun/swing/internal/plaf/metal/resources/metal -sun/util/ResourceBundleEnumeration -com/sun/swing/internal/plaf/basic/resources/basic -javax/swing/plaf/basic/BasicPanelUI -javax/swing/plaf/PanelUI -javax/swing/plaf/ComponentUI -sun/reflect/misc/MethodUtil -sun/reflect/misc/MethodUtil$1 -java/util/jar/JarFile -java/util/zip/ZipFile -java/util/zip/ZipConstants -java/util/jar/JavaUtilJarAccessImpl -sun/misc/JavaUtilJarAccess -sun/misc/JarIndex -java/util/zip/ZipEntry -java/util/jar/JarFile$JarFileEntry -java/util/jar/JarEntry -sun/misc/URLClassPath$JarLoader$2 -sun/net/www/protocol/jar/JarURLConnection -java/net/JarURLConnection -sun/net/www/protocol/jar/JarFileFactory -sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController -java/net/HttpURLConnection -sun/net/www/protocol/jar/URLJarFile -sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry -sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream -java/util/zip/ZipFile$ZipFileInputStream -java/security/AllPermissionCollection -java/lang/IllegalAccessException -javax/swing/JPasswordField -javax/swing/JTextField -javax/swing/text/JTextComponent -javax/swing/Scrollable -javax/swing/JLayeredPane -javax/swing/JRootPane$1 -javax/swing/ArrayTable -javax/swing/JInternalFrame -javax/swing/JRootPane$RootLayout -javax/swing/BufferStrategyPaintManager -javax/swing/RepaintManager$PaintManager -javax/swing/plaf/metal/MetalRootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI -javax/swing/plaf/RootPaneUI -javax/swing/plaf/basic/BasicRootPaneUI$RootPaneInputMap -javax/swing/plaf/ComponentInputMapUIResource -javax/swing/ComponentInputMap -javax/swing/InputMap -javax/swing/plaf/InputMapUIResource -javax/swing/KeyStroke -java/awt/VKCollection -sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl -javax/swing/plaf/basic/LazyActionMap -javax/swing/plaf/ActionMapUIResource -javax/swing/ActionMap -javax/swing/plaf/metal/MetalLabelUI -javax/swing/plaf/basic/BasicLabelUI -javax/swing/plaf/LabelUI -javax/swing/plaf/metal/DefaultMetalTheme$FontDelegate$1 -java/util/Hashtable$ValueCollection -java/util/Collections$SynchronizedCollection -javax/swing/plaf/basic/BasicHTML -sun/awt/AppContext$PostShutdownEventRunnable -sun/awt/AWTAutoShutdown$1 -sun/awt/NullComponentPeer -java/awt/GraphicsCallback$PaintCallback -java/awt/GraphicsCallback -sun/awt/SunGraphicsCallback -java/util/jar/Manifest -java/io/ByteArrayInputStream -java/util/jar/Attributes -java/util/jar/Manifest$FastInputStream -sun/nio/cs/UTF_8 -sun/nio/cs/UTF_8$Decoder -sun/nio/cs/Surrogate$Generator -java/util/jar/Attributes$Name -sun/misc/ASCIICaseInsensitiveComparator -java/util/jar/JarVerifier -java/io/ByteArrayOutputStream -sun/misc/ExtensionDependency -java/lang/Package -sun/security/util/ManifestEntryVerifier -java/security/Provider -java/security/Provider$ServiceKey -java/security/Provider$EngineDescription -java/security/Security -java/security/Security$1 -sun/misc/FloatingDecimal -sun/misc/FloatingDecimal$1 -java/util/regex/Pattern -java/util/regex/Pattern$Node -java/util/regex/Pattern$LastNode -java/util/regex/Pattern$GroupHead -java/util/regex/Pattern$GroupTail -java/util/regex/Pattern$BitClass -java/util/regex/Pattern$BmpCharProperty -java/util/regex/Pattern$CharProperty -java/util/regex/Pattern$Ques -java/util/regex/Pattern$BranchConn -java/util/regex/Pattern$Branch -java/util/regex/Pattern$5 -java/util/regex/Pattern$CharPropertyNames -java/util/regex/Pattern$CharPropertyNames$1 -java/util/regex/Pattern$CharPropertyNames$CharPropertyFactory -java/util/regex/Pattern$CharPropertyNames$2 -java/util/regex/Pattern$CharPropertyNames$5 -java/util/regex/Pattern$CharPropertyNames$3 -java/util/regex/Pattern$CharPropertyNames$6 -java/util/regex/Pattern$CharPropertyNames$CloneableProperty -java/util/regex/Pattern$CharPropertyNames$4 -java/util/regex/Pattern$CharPropertyNames$7 -java/util/regex/Pattern$CharPropertyNames$8 -java/util/regex/Pattern$CharPropertyNames$9 -java/util/regex/Pattern$CharPropertyNames$10 -java/util/regex/Pattern$CharPropertyNames$11 -java/util/regex/Pattern$CharPropertyNames$12 -java/util/regex/Pattern$CharPropertyNames$13 -java/util/regex/Pattern$CharPropertyNames$14 -java/util/regex/Pattern$CharPropertyNames$15 -java/util/regex/Pattern$CharPropertyNames$16 -java/util/regex/Pattern$CharPropertyNames$17 -java/util/regex/Pattern$CharPropertyNames$18 -java/util/regex/Pattern$CharPropertyNames$19 -java/util/regex/Pattern$CharPropertyNames$20 -java/util/regex/Pattern$CharPropertyNames$21 -java/util/regex/Pattern$Ctype -java/util/regex/Pattern$Curly -java/util/regex/Pattern$6 -java/util/regex/Pattern$Slice -java/util/regex/Pattern$Begin -java/util/regex/Pattern$First -java/util/regex/Pattern$Start -java/util/regex/Pattern$TreeInfo -java/lang/StrictMath -sun/security/provider/NativePRNG -sun/misc/BASE64Decoder -sun/misc/CharacterDecoder -sun/security/util/SignatureFileVerifier -java/awt/event/KeyAdapter -java/lang/NumberFormatException -java/lang/IllegalArgumentException -java/io/FileWriter -java/net/Authenticator -java/net/MalformedURLException -javax/swing/text/Element -javax/swing/text/Document -javax/swing/text/PlainDocument +javax/swing/plaf/synth/SynthConstants +javax/swing/plaf/synth/SynthUI +javax/swing/table/AbstractTableModel +javax/swing/table/DefaultTableCellRenderer +javax/swing/table/DefaultTableColumnModel +javax/swing/table/DefaultTableModel +javax/swing/table/JTableHeader +javax/swing/table/TableCellEditor +javax/swing/table/TableCellRenderer +javax/swing/table/TableColumn +javax/swing/table/TableColumnModel +javax/swing/table/TableModel javax/swing/text/AbstractDocument -javax/swing/text/GapContent -javax/swing/text/AbstractDocument$Content -javax/swing/text/GapVector -javax/swing/text/GapContent$MarkVector -javax/swing/text/GapContent$MarkData -javax/swing/text/StyleContext +javax/swing/text/AbstractDocument$1 +javax/swing/text/AbstractDocument$AbstractElement javax/swing/text/AbstractDocument$AttributeContext -javax/swing/text/StyleConstants -javax/swing/text/StyleConstants$CharacterConstants -javax/swing/text/AttributeSet$CharacterAttribute -javax/swing/text/StyleConstants$FontConstants -javax/swing/text/AttributeSet$FontAttribute -javax/swing/text/StyleConstants$ColorConstants -javax/swing/text/AttributeSet$ColorAttribute -javax/swing/text/StyleConstants$ParagraphConstants -javax/swing/text/AttributeSet$ParagraphAttribute -javax/swing/text/StyleContext$FontKey -javax/swing/text/SimpleAttributeSet -javax/swing/text/MutableAttributeSet -javax/swing/text/AttributeSet -javax/swing/text/SimpleAttributeSet$EmptyAttributeSet -javax/swing/text/StyleContext$NamedStyle -javax/swing/text/Style -javax/swing/text/StyleContext$SmallAttributeSet +javax/swing/text/AbstractDocument$BidiElement javax/swing/text/AbstractDocument$BidiRootElement javax/swing/text/AbstractDocument$BranchElement -javax/swing/text/AbstractDocument$AbstractElement -javax/swing/tree/TreeNode -javax/swing/text/AbstractDocument$1 -javax/swing/text/AbstractDocument$BidiElement -javax/swing/text/AbstractDocument$LeafElement -javax/swing/text/GapContent$StickyPosition -javax/swing/text/Position -javax/swing/text/StyleContext$KeyEnumeration -javax/swing/text/GapContent$InsertUndo -javax/swing/undo/AbstractUndoableEdit -javax/swing/undo/UndoableEdit +javax/swing/text/AbstractDocument$Content javax/swing/text/AbstractDocument$DefaultDocumentEvent -javax/swing/event/DocumentEvent -javax/swing/undo/CompoundEdit -javax/swing/event/DocumentEvent$EventType -javax/swing/text/Segment -java/text/CharacterIterator -javax/swing/text/Utilities -javax/swing/text/SegmentCache -javax/swing/text/SegmentCache$CachedSegment -javax/swing/event/UndoableEditEvent javax/swing/text/AbstractDocument$ElementEdit -javax/swing/event/DocumentEvent$ElementChange -javax/swing/JMenu -javax/swing/MenuElement -javax/swing/JMenuItem -javax/swing/AbstractButton -java/awt/ItemSelectable -javax/swing/event/MenuListener -javax/swing/JCheckBoxMenuItem -javax/swing/Icon -javax/swing/JButton -java/net/URLClassLoader$2 -javax/swing/ImageIcon -javax/swing/ImageIcon$1 -java/awt/MediaTracker -sun/misc/SoftCache$ValueCell -sun/awt/image/URLImageSource -sun/awt/image/InputStreamImageSource -sun/awt/image/ImageFetchable -sun/awt/image/ToolkitImage -sun/awt/image/NativeLibLoader -java/awt/ImageMediaEntry -java/awt/MediaEntry -sun/awt/image/ImageRepresentation -java/awt/image/ImageConsumer -sun/awt/image/ImageWatched -sun/awt/image/ImageWatched$Link -sun/awt/image/ImageWatched$WeakLink -sun/awt/image/ImageConsumerQueue -sun/awt/image/ImageFetcher -sun/awt/image/FetcherInfo -sun/awt/image/ImageFetcher$1 -sun/awt/image/GifImageDecoder -sun/awt/image/ImageDecoder -sun/awt/image/GifFrame -java/awt/image/Raster -java/awt/image/DataBufferByte -java/awt/image/DataBuffer -java/awt/image/PixelInterleavedSampleModel -java/awt/image/ComponentSampleModel -java/awt/image/SampleModel -sun/awt/image/ByteInterleavedRaster -sun/awt/image/ByteComponentRaster -sun/awt/image/SunWritableRaster -java/awt/image/WritableRaster -java/awt/image/BufferedImage -java/awt/image/WritableRenderedImage -java/awt/image/RenderedImage -sun/awt/image/IntegerComponentRaster -sun/awt/image/BytePackedRaster -java/awt/Canvas -sun/font/FontDesignMetrics -sun/font/FontStrikeDesc -sun/font/CompositeStrike -sun/font/FontStrikeDisposer -sun/font/StrikeCache$SoftDisposerRef -sun/font/StrikeCache$DisposableStrike -sun/font/TrueTypeFont$TTDisposerRecord -sun/font/TrueTypeFont$1 -java/io/RandomAccessFile -sun/nio/ch/FileChannelImpl -java/nio/channels/FileChannel -java/nio/channels/ByteChannel -java/nio/channels/ReadableByteChannel -java/nio/channels/Channel -java/nio/channels/WritableByteChannel -java/nio/channels/GatheringByteChannel -java/nio/channels/ScatteringByteChannel -java/nio/channels/spi/AbstractInterruptibleChannel -java/nio/channels/InterruptibleChannel -sun/nio/ch/Util -sun/nio/ch/IOUtil -sun/nio/ch/FileDispatcher -sun/nio/ch/NativeDispatcher -sun/nio/ch/Reflect -java/nio/MappedByteBuffer -sun/nio/ch/Reflect$1 -sun/nio/ch/NativeThreadSet -java/nio/channels/spi/AbstractInterruptibleChannel$1 -sun/nio/ch/Interruptible -sun/nio/ch/NativeThread -sun/nio/ch/IOStatus -sun/nio/ch/DirectBuffer -java/nio/DirectByteBuffer -java/nio/DirectByteBuffer$Deallocator -sun/misc/Cleaner -java/nio/ByteBufferAsIntBufferB -java/nio/IntBuffer -sun/font/TrueTypeFont$DirectoryEntry -java/nio/ByteBufferAsShortBufferB -java/nio/ShortBuffer -sun/nio/cs/UTF_16 -sun/nio/cs/UTF_16$Decoder -sun/font/FileFontStrike -sun/font/TrueTypeGlyphMapper -sun/font/CMap -sun/font/CMap$NullCMapClass -sun/font/CMap$CMapFormat4 -java/nio/ByteBufferAsCharBufferB -sun/font/FontDesignMetrics$KeyReference -sun/awt/image/PNGImageDecoder -sun/awt/image/PNGFilterInputStream -java/util/zip/InflaterInputStream -java/util/zip/Inflater -javax/swing/Popup$HeavyWeightWindow -sun/awt/ModalExclude -javax/swing/JWindow -com/sun/java/swing/plaf/windows/WindowsPopupWindow -java/awt/Cursor$CursorDisposer -java/awt/AWTEvent$1 -sun/reflect/UnsafeBooleanFieldAccessorImpl -java/awt/image/DataBufferInt -java/awt/image/SinglePixelPackedSampleModel -sun/awt/image/IntegerInterleavedRaster -java/util/Date -sun/util/calendar/CalendarSystem -sun/awt/image/OffScreenImage -sun/java2d/SurfaceManagerFactory -sun/util/calendar/Gregorian -sun/util/calendar/BaseCalendar -sun/util/calendar/AbstractCalendar -java/util/TimeZone -java/lang/InheritableThreadLocal -sun/awt/image/BufImgSurfaceData -sun/font/CompositeGlyphMapper -sun/util/calendar/ZoneInfo -sun/util/calendar/ZoneInfoFile -sun/util/calendar/ZoneInfoFile$1 -sun/java2d/loops/FontInfo -java/util/TimeZone$1 -sun/util/calendar/Gregorian$Date -sun/util/calendar/BaseCalendar$Date -sun/util/calendar/CalendarDate -sun/util/calendar/CalendarUtils -java/util/TimeZone$DisplayNames -sun/util/TimeZoneNameUtility -sun/util/resources/LocaleData -sun/util/resources/LocaleData$1 -sun/util/resources/LocaleData$LocaleDataResourceBundleControl -sun/util/LocaleDataMetaInfo -sun/util/resources/TimeZoneNames -sun/util/resources/TimeZoneNamesBundle -sun/util/resources/OpenListResourceBundle -java/util/ResourceBundle$BundleReference -sun/util/resources/TimeZoneNames_en -java/util/spi/TimeZoneNameProvider -java/util/spi/LocaleServiceProvider -sun/util/LocaleServiceProviderPool -sun/util/LocaleServiceProviderPool$1 -java/util/ServiceLoader -java/util/ServiceLoader$LazyIterator -java/util/ServiceLoader$1 -java/util/LinkedHashMap$EntryIterator -java/net/ServerSocket -java/net/InetAddress -java/net/InetAddress$Cache -java/net/InetAddress$Cache$Type -java/net/InetAddressImplFactory -java/net/Inet4AddressImpl -java/net/InetAddressImpl -java/net/InetAddress$1 -sun/net/spi/nameservice/NameService -sun/net/util/IPAddressUtil -java/util/regex/Matcher -java/util/regex/MatchResult -java/util/RandomAccessSubList -java/util/SubList -java/util/SubList$1 -java/util/AbstractList$ListItr -java/net/Inet4Address -java/net/SocksSocketImpl -java/net/SocksConsts -java/net/PlainSocketImpl -java/net/SocketImpl -java/net/SocketOptions -java/net/InetSocketAddress -java/net/SocketAddress -java/util/Random -java/util/concurrent/atomic/AtomicLong -java/lang/InternalError -java/io/StringReader -java/io/FilterReader -java/lang/reflect/Proxy -java/lang/reflect/InvocationHandler -java/lang/NoSuchFieldException -java/lang/InstantiationException -java/lang/ArrayIndexOutOfBoundsException -java/lang/IndexOutOfBoundsException -javax/swing/JDialog -java/io/EOFException -java/util/Vector$1 -javax/swing/filechooser/FileSystemView -javax/swing/filechooser/FileSystemView$1 -javax/swing/event/SwingPropertyChangeSupport -javax/swing/filechooser/WindowsFileSystemView -java/util/zip/ZipFile$1 -java/util/zip/ZipFile$2 -java/util/jar/JarFile$1 -java/util/PropertyResourceBundle -java/util/ResourceBundle$Control$1 -java/util/Hashtable$EntrySet -java/util/Collections$SynchronizedSet -java/lang/IllegalAccessError -java/text/MessageFormat -java/text/Format -java/text/FieldPosition -java/text/MessageFormat$Field -java/text/Format$Field -java/lang/CloneNotSupportedException -sun/reflect/MethodAccessorGenerator -sun/reflect/AccessorGenerator -sun/reflect/ClassFileConstants -java/lang/Void -sun/reflect/ByteVectorFactory -sun/reflect/ByteVectorImpl -sun/reflect/ByteVector -sun/reflect/ClassFileAssembler -sun/reflect/UTF8 -sun/reflect/Label -sun/reflect/Label$PatchInfo -sun/reflect/MethodAccessorGenerator$1 -sun/reflect/ClassDefiner -sun/reflect/ClassDefiner$1 -sun/reflect/BootstrapConstructorAccessorImpl -java/awt/event/ActionListener -javax/swing/Timer -javax/swing/Timer$DoPostEvent -javax/swing/TimerQueue -javax/swing/TimerQueue$1 -javax/swing/ToolTipManager -java/awt/event/MouseAdapter -javax/swing/ToolTipManager$insideTimerAction -javax/swing/ToolTipManager$outsideTimerAction -javax/swing/ToolTipManager$stillInsideTimerAction -sun/swing/UIAction -javax/swing/Action -javax/swing/ToolTipManager$MoveBeforeEnterListener -java/awt/event/MouseMotionAdapter -javax/swing/event/CaretListener -javax/swing/JToolBar -javax/swing/JSplitPane -javax/swing/border/Border -javax/swing/JToggleButton -javax/swing/border/EmptyBorder -javax/swing/border/AbstractBorder -javax/swing/DefaultButtonModel -javax/swing/ButtonModel -javax/swing/AbstractButton$Handler -javax/swing/event/ChangeListener -java/awt/event/ItemListener -javax/swing/plaf/metal/MetalButtonUI -javax/swing/plaf/basic/BasicButtonUI -javax/swing/plaf/ButtonUI -javax/swing/plaf/metal/MetalBorders -javax/swing/plaf/BorderUIResource$CompoundBorderUIResource -javax/swing/border/CompoundBorder -javax/swing/plaf/metal/MetalBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$MarginBorder -javax/swing/plaf/basic/BasicButtonListener -java/awt/AWTEventMulticaster -java/awt/event/AdjustmentListener -java/awt/event/TextListener -javax/swing/event/AncestorListener -java/beans/VetoableChangeListener -javax/swing/ButtonGroup -javax/swing/JToggleButton$ToggleButtonModel -javax/swing/plaf/metal/MetalToggleButtonUI -javax/swing/plaf/basic/BasicToggleButtonUI -javax/swing/plaf/metal/MetalBorders$ToggleButtonBorder -java/awt/CardLayout -javax/swing/Box -javax/swing/plaf/metal/MetalBorders$TextFieldBorder -javax/swing/plaf/metal/MetalBorders$Flush3DBorder -javax/swing/BoxLayout -javax/swing/JMenuBar -javax/swing/DefaultSingleSelectionModel -javax/swing/SingleSelectionModel -javax/swing/plaf/basic/BasicMenuBarUI -javax/swing/plaf/MenuBarUI -javax/swing/plaf/basic/DefaultMenuLayout -javax/swing/plaf/metal/MetalBorders$MenuBarBorder -javax/swing/plaf/basic/BasicMenuBarUI$Handler -javax/swing/KeyboardManager -javax/swing/event/MenuEvent -javax/swing/JMenu$MenuChangeListener -javax/swing/JMenuItem$MenuItemFocusListener -javax/swing/plaf/basic/BasicMenuUI -javax/swing/plaf/basic/BasicMenuItemUI -javax/swing/plaf/MenuItemUI -javax/swing/plaf/metal/MetalBorders$MenuItemBorder -javax/swing/plaf/metal/MetalIconFactory -javax/swing/plaf/metal/MetalIconFactory$MenuArrowIcon -javax/swing/plaf/basic/BasicMenuUI$Handler -javax/swing/event/MenuKeyListener -javax/swing/plaf/basic/BasicMenuItemUI$Handler -javax/swing/event/MenuDragMouseListener -javax/swing/event/MouseInputListener -javax/swing/event/ChangeEvent -java/awt/event/ContainerEvent -javax/swing/plaf/metal/MetalIconFactory$MenuItemArrowIcon -javax/swing/JPopupMenu -javax/swing/plaf/basic/BasicPopupMenuUI -javax/swing/plaf/PopupMenuUI -javax/swing/plaf/basic/BasicLookAndFeel$AWTEventHelper -java/awt/event/AWTEventListenerProxy -java/awt/Toolkit$SelectiveAWTEventListener -java/awt/Toolkit$ToolkitEventMulticaster -javax/swing/plaf/basic/BasicLookAndFeel$1 -javax/swing/plaf/metal/MetalBorders$PopupMenuBorder -javax/swing/plaf/basic/BasicPopupMenuUI$BasicPopupMenuListener -javax/swing/event/PopupMenuListener -javax/swing/plaf/basic/BasicPopupMenuUI$BasicMenuKeyListener -javax/swing/plaf/basic/BasicPopupMenuUI$MouseGrabber -javax/swing/MenuSelectionManager -javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper -javax/swing/plaf/basic/BasicPopupMenuUI$MenuKeyboardHelper$1 -java/awt/event/FocusAdapter -javax/swing/JMenu$WinListener -java/awt/event/WindowAdapter -javax/swing/JPopupMenu$Separator -javax/swing/JSeparator -javax/swing/plaf/metal/MetalPopupMenuSeparatorUI -javax/swing/plaf/metal/MetalSeparatorUI -javax/swing/plaf/basic/BasicSeparatorUI -javax/swing/plaf/SeparatorUI -javax/swing/JComboBox -javax/swing/event/ListDataListener -javax/swing/event/CaretEvent -javax/swing/text/TabExpander -javax/swing/JScrollBar -java/awt/Adjustable -javax/swing/event/MouseInputAdapter -javax/swing/JScrollBar$ModelListener -javax/swing/DefaultBoundedRangeModel -javax/swing/BoundedRangeModel -javax/swing/plaf/metal/MetalScrollBarUI -javax/swing/plaf/basic/BasicScrollBarUI -javax/swing/plaf/ScrollBarUI -javax/swing/plaf/metal/MetalBumps -javax/swing/plaf/metal/MetalScrollButton -javax/swing/plaf/basic/BasicArrowButton -javax/swing/plaf/basic/BasicScrollBarUI$TrackListener -javax/swing/plaf/basic/BasicScrollBarUI$ArrowButtonListener -javax/swing/plaf/basic/BasicScrollBarUI$ModelListener -javax/swing/plaf/metal/MetalScrollBarUI$ScrollBarListener -javax/swing/plaf/basic/BasicScrollBarUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicScrollBarUI$Handler -javax/swing/plaf/basic/BasicScrollBarUI$ScrollListener -javax/swing/CellRendererPane -javax/swing/border/MatteBorder -sun/font/StandardGlyphVector -java/awt/font/GlyphVector -sun/font/StandardGlyphVector$GlyphStrike -sun/font/CoreMetrics -sun/font/FontLineMetrics -java/awt/font/LineMetrics -javax/swing/ComboBoxModel -javax/swing/ListModel -javax/swing/ListCellRenderer -javax/swing/DefaultComboBoxModel -javax/swing/MutableComboBoxModel -javax/swing/AbstractListModel -javax/swing/JComboBox$1 -javax/swing/AncestorNotifier -javax/swing/plaf/metal/MetalComboBoxUI -javax/swing/plaf/basic/BasicComboBoxUI -javax/swing/plaf/ComboBoxUI -javax/swing/plaf/metal/MetalComboBoxUI$MetalComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboBoxUI$ComboBoxLayoutManager -javax/swing/plaf/basic/BasicComboPopup -javax/swing/plaf/basic/ComboPopup -javax/swing/plaf/basic/BasicComboPopup$EmptyListModelClass -javax/swing/border/LineBorder -javax/swing/plaf/basic/BasicComboPopup$1 -javax/swing/JList -javax/swing/DropMode -javax/swing/DefaultListSelectionModel -javax/swing/ListSelectionModel -javax/swing/plaf/basic/BasicListUI -javax/swing/plaf/ListUI -javax/swing/plaf/basic/BasicListUI$ListTransferHandler -javax/swing/TransferHandler -javax/swing/TransferHandler$TransferAction -javax/swing/DefaultListCellRenderer$UIResource -javax/swing/DefaultListCellRenderer -javax/swing/TransferHandler$SwingDropTarget -java/awt/dnd/DropTargetContext -java/awt/datatransfer/SystemFlavorMap -java/awt/datatransfer/FlavorMap -java/awt/datatransfer/FlavorTable -java/awt/datatransfer/SystemFlavorMap$1 -java/net/URI -java/net/URI$Parser -sun/net/ProgressMonitor -sun/net/DefaultProgressMeteringPolicy -sun/net/ProgressMeteringPolicy -sun/nio/cs/ISO_8859_1 -sun/nio/cs/ISO_8859_1$Decoder -java/awt/datatransfer/SystemFlavorMap$2 -java/awt/datatransfer/MimeType -java/io/Externalizable -java/awt/datatransfer/MimeTypeParameterList -sun/awt/datatransfer/DataTransferer -java/awt/datatransfer/DataFlavor -java/awt/datatransfer/DataFlavor$1 -sun/awt/datatransfer/DataTransferer$CharsetComparator -sun/awt/datatransfer/DataTransferer$IndexedComparator -sun/nio/cs/UTF_16BE -sun/nio/cs/US_ASCII -java/util/Collections$UnmodifiableMap -sun/awt/datatransfer/DataTransferer$DataFlavorComparator -java/rmi/Remote -sun/awt/datatransfer/DataTransferer$1 -sun/awt/windows/WDataTransferer -java/lang/Long$LongCache -java/awt/datatransfer/Transferable -sun/awt/datatransfer/ToolkitThreadBlockedHandler -sun/awt/windows/WToolkitThreadBlockedHandler -sun/awt/Mutex -javax/swing/TransferHandler$DropHandler -javax/swing/TransferHandler$TransferSupport -javax/swing/plaf/basic/BasicListUI$Handler -javax/swing/event/ListSelectionListener -javax/swing/plaf/basic/DragRecognitionSupport$BeforeDrag -javax/swing/plaf/basic/BasicComboPopup$Handler -javax/swing/JScrollPane -javax/swing/ScrollPaneConstants -javax/swing/ScrollPaneLayout$UIResource -javax/swing/ScrollPaneLayout -javax/swing/JViewport -javax/swing/ViewportLayout -javax/swing/plaf/basic/BasicViewportUI -javax/swing/plaf/ViewportUI -javax/swing/JScrollPane$ScrollBar -javax/swing/JViewport$ViewListener -java/awt/event/ComponentAdapter -javax/swing/plaf/metal/MetalScrollPaneUI -javax/swing/plaf/basic/BasicScrollPaneUI -javax/swing/plaf/ScrollPaneUI -javax/swing/plaf/metal/MetalBorders$ScrollPaneBorder -javax/swing/plaf/basic/BasicScrollPaneUI$Handler -javax/swing/plaf/metal/MetalScrollPaneUI$1 -javax/swing/plaf/basic/BasicComboBoxRenderer$UIResource -javax/swing/plaf/basic/BasicComboBoxRenderer -javax/swing/plaf/metal/MetalComboBoxEditor$UIResource -javax/swing/plaf/metal/MetalComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor -javax/swing/ComboBoxEditor -javax/swing/plaf/basic/BasicComboBoxEditor$BorderlessTextField -javax/swing/JTextField$NotifyAction -javax/swing/text/TextAction -javax/swing/AbstractAction -javax/swing/text/JTextComponent$MutableCaretEvent -javax/swing/plaf/metal/MetalTextFieldUI -javax/swing/plaf/basic/BasicTextFieldUI -javax/swing/plaf/basic/BasicTextUI -javax/swing/text/ViewFactory -javax/swing/plaf/TextUI -javax/swing/plaf/basic/BasicTextUI$BasicCursor +javax/swing/text/AbstractDocument$InsertStringResult +javax/swing/text/AbstractDocument$LeafElement +javax/swing/text/AttributeSet +javax/swing/text/AttributeSet$CharacterAttribute +javax/swing/text/AttributeSet$ColorAttribute +javax/swing/text/AttributeSet$FontAttribute +javax/swing/text/AttributeSet$ParagraphAttribute +javax/swing/text/Caret +javax/swing/text/DefaultCaret +javax/swing/text/DefaultCaret$Handler javax/swing/text/DefaultEditorKit -javax/swing/text/EditorKit -javax/swing/text/DefaultEditorKit$InsertContentAction -javax/swing/text/DefaultEditorKit$DeletePrevCharAction -javax/swing/text/DefaultEditorKit$DeleteNextCharAction -javax/swing/text/DefaultEditorKit$ReadOnlyAction -javax/swing/text/DefaultEditorKit$DeleteWordAction -javax/swing/text/DefaultEditorKit$WritableAction -javax/swing/text/DefaultEditorKit$CutAction -javax/swing/text/DefaultEditorKit$CopyAction -javax/swing/text/DefaultEditorKit$PasteAction -javax/swing/text/DefaultEditorKit$VerticalPageAction -javax/swing/text/DefaultEditorKit$PageAction -javax/swing/text/DefaultEditorKit$InsertBreakAction javax/swing/text/DefaultEditorKit$BeepAction -javax/swing/text/DefaultEditorKit$NextVisualPositionAction -javax/swing/text/DefaultEditorKit$BeginWordAction -javax/swing/text/DefaultEditorKit$EndWordAction -javax/swing/text/DefaultEditorKit$PreviousWordAction -javax/swing/text/DefaultEditorKit$NextWordAction -javax/swing/text/DefaultEditorKit$BeginLineAction -javax/swing/text/DefaultEditorKit$EndLineAction -javax/swing/text/DefaultEditorKit$BeginParagraphAction -javax/swing/text/DefaultEditorKit$EndParagraphAction javax/swing/text/DefaultEditorKit$BeginAction -javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$BeginLineAction +javax/swing/text/DefaultEditorKit$BeginParagraphAction +javax/swing/text/DefaultEditorKit$BeginWordAction +javax/swing/text/DefaultEditorKit$CopyAction +javax/swing/text/DefaultEditorKit$CutAction javax/swing/text/DefaultEditorKit$DefaultKeyTypedAction +javax/swing/text/DefaultEditorKit$DeleteNextCharAction +javax/swing/text/DefaultEditorKit$DeletePrevCharAction +javax/swing/text/DefaultEditorKit$DeleteWordAction +javax/swing/text/DefaultEditorKit$DumpModelAction +javax/swing/text/DefaultEditorKit$EndAction +javax/swing/text/DefaultEditorKit$EndLineAction +javax/swing/text/DefaultEditorKit$EndParagraphAction +javax/swing/text/DefaultEditorKit$EndWordAction +javax/swing/text/DefaultEditorKit$InsertBreakAction +javax/swing/text/DefaultEditorKit$InsertContentAction javax/swing/text/DefaultEditorKit$InsertTabAction -javax/swing/text/DefaultEditorKit$SelectWordAction +javax/swing/text/DefaultEditorKit$NextVisualPositionAction +javax/swing/text/DefaultEditorKit$NextWordAction +javax/swing/text/DefaultEditorKit$PageAction +javax/swing/text/DefaultEditorKit$PasteAction +javax/swing/text/DefaultEditorKit$PreviousWordAction +javax/swing/text/DefaultEditorKit$ReadOnlyAction +javax/swing/text/DefaultEditorKit$SelectAllAction javax/swing/text/DefaultEditorKit$SelectLineAction javax/swing/text/DefaultEditorKit$SelectParagraphAction -javax/swing/text/DefaultEditorKit$SelectAllAction -javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$SelectWordAction javax/swing/text/DefaultEditorKit$ToggleComponentOrientationAction -javax/swing/text/DefaultEditorKit$DumpModelAction -javax/swing/plaf/basic/BasicTextUI$TextTransferHandler -javax/swing/text/Position$Bias -javax/swing/plaf/basic/BasicTextUI$RootView -javax/swing/text/View -javax/swing/plaf/basic/BasicTextUI$UpdateHandler -javax/swing/event/DocumentListener -javax/swing/plaf/basic/BasicTextUI$DragListener -javax/swing/plaf/basic/BasicComboBoxEditor$UIResource -javax/swing/plaf/basic/BasicTextUI$BasicCaret -javax/swing/text/DefaultCaret -javax/swing/text/Caret -javax/swing/text/DefaultCaret$Handler -java/awt/datatransfer/ClipboardOwner -javax/swing/plaf/basic/BasicTextUI$BasicHighlighter +javax/swing/text/DefaultEditorKit$UnselectAction +javax/swing/text/DefaultEditorKit$VerticalPageAction +javax/swing/text/DefaultEditorKit$WritableAction javax/swing/text/DefaultHighlighter -javax/swing/text/LayeredHighlighter +javax/swing/text/DefaultHighlighter$DefaultHighlightPainter +javax/swing/text/DefaultHighlighter$SafeDamager +javax/swing/text/Document +javax/swing/text/EditorKit +javax/swing/text/Element +javax/swing/text/FieldView +javax/swing/text/GapContent +javax/swing/text/GapContent$InsertUndo +javax/swing/text/GapContent$MarkData +javax/swing/text/GapContent$MarkVector +javax/swing/text/GapContent$StickyPosition +javax/swing/text/GapVector javax/swing/text/Highlighter javax/swing/text/Highlighter$Highlight -javax/swing/text/DefaultHighlighter$DefaultHighlightPainter -javax/swing/text/LayeredHighlighter$LayerPainter javax/swing/text/Highlighter$HighlightPainter -javax/swing/text/DefaultHighlighter$SafeDamager -javax/swing/text/FieldView -javax/swing/text/PlainView +javax/swing/text/JTextComponent +javax/swing/text/JTextComponent$1 javax/swing/text/JTextComponent$DefaultKeymap -javax/swing/text/Keymap -javax/swing/text/JTextComponent$KeymapWrapper javax/swing/text/JTextComponent$KeymapActionMap -javax/swing/plaf/basic/BasicTextUI$FocusAction -javax/swing/plaf/basic/BasicTextUI$TextActionWrapper -javax/swing/JTextArea -javax/swing/JEditorPane -javax/swing/JTextField$ScrollRepainter -javax/swing/plaf/metal/MetalComboBoxEditor$1 -javax/swing/plaf/metal/MetalComboBoxEditor$EditorBorder -javax/swing/plaf/metal/MetalComboBoxUI$MetalPropertyChangeListener -javax/swing/plaf/basic/BasicComboBoxUI$PropertyChangeHandler -javax/swing/plaf/basic/BasicComboBoxUI$Handler -javax/swing/plaf/metal/MetalComboBoxButton -javax/swing/plaf/metal/MetalComboBoxIcon -javax/swing/plaf/metal/MetalComboBoxButton$1 -javax/swing/plaf/basic/BasicComboBoxUI$DefaultKeySelectionManager -javax/swing/JComboBox$KeySelectionManager -javax/swing/JToolBar$DefaultToolBarLayout -javax/swing/plaf/metal/MetalToolBarUI -javax/swing/plaf/basic/BasicToolBarUI -javax/swing/plaf/ToolBarUI -javax/swing/plaf/metal/MetalBorders$ToolBarBorder -javax/swing/plaf/metal/MetalLookAndFeel$MetalLazyValue$1 -javax/swing/plaf/metal/MetalBorders$RolloverButtonBorder -javax/swing/plaf/metal/MetalBorders$RolloverMarginBorder -javax/swing/plaf/basic/BasicBorders$RadioButtonBorder -javax/swing/plaf/basic/BasicBorders$ButtonBorder -javax/swing/plaf/basic/BasicBorders$RolloverMarginBorder -javax/swing/plaf/metal/MetalToolBarUI$MetalDockingListener -javax/swing/plaf/basic/BasicToolBarUI$DockingListener -javax/swing/plaf/basic/BasicToolBarUI$Handler -javax/swing/border/EtchedBorder -javax/swing/JToolBar$Separator -javax/swing/plaf/basic/BasicToolBarSeparatorUI -sun/font/FontDesignMetrics$MetricsKey -java/applet/Applet -java/awt/Panel -com/sun/awt/AWTUtilities -javax/swing/KeyboardManager$ComponentKeyStrokePair -sun/awt/im/InputMethodContext -java/awt/im/spi/InputMethodContext -sun/awt/im/InputContext -sun/awt/windows/WInputMethod -sun/awt/im/InputMethodAdapter -java/awt/im/spi/InputMethod -javax/swing/SizeRequirements -javax/swing/plaf/basic/BasicGraphicsUtils -java/awt/event/AdjustmentEvent -java/awt/MenuBar -java/awt/Window$1DisposeAction -java/io/StringWriter -java/io/UnsupportedEncodingException -java/lang/StringCoding$StringEncoder -java/net/UnknownHostException -java/net/Socket -java/nio/channels/SocketChannel -java/nio/channels/spi/AbstractSelectableChannel -java/nio/channels/SelectableChannel -java/net/SocketException -java/net/SocketImplFactory -java/net/Proxy -java/net/SocksSocketImpl$5 -java/net/ProxySelector -sun/net/spi/DefaultProxySelector -sun/net/spi/DefaultProxySelector$1 -sun/net/NetProperties -sun/net/NetProperties$1 -sun/net/spi/DefaultProxySelector$NonProxyInfo -java/util/regex/ASCII -java/util/regex/Pattern$GroupCurly -java/net/Inet6Address -java/net/Proxy$Type -java/net/SocketTimeoutException -java/io/InterruptedIOException -javax/swing/UnsupportedLookAndFeelException -java/lang/UnsatisfiedLinkError -javax/swing/Box$Filler -javax/swing/JComponent$2 -sun/net/www/MimeTable -java/net/FileNameMap -sun/net/www/MimeTable$1 -sun/net/www/MimeEntry -java/net/URLConnection$1 -java/text/SimpleDateFormat -java/text/DateFormat -java/text/DateFormat$Field -java/util/Calendar -java/util/GregorianCalendar -sun/util/resources/CalendarData -sun/util/resources/LocaleNamesBundle -sun/util/resources/CalendarData_en -java/text/DateFormatSymbols -java/text/spi/DateFormatSymbolsProvider -sun/text/resources/FormatData -sun/text/resources/FormatData_en -sun/text/resources/FormatData_en_US -java/text/NumberFormat -java/text/spi/NumberFormatProvider -java/text/DecimalFormatSymbols -java/text/spi/DecimalFormatSymbolsProvider -java/util/Currency -java/util/Currency$1 -java/util/spi/CurrencyNameProvider -sun/util/resources/CurrencyNames -sun/util/resources/CurrencyNames_en_US -java/text/DecimalFormat -java/text/DigitList -java/math/RoundingMode -java/text/DontCareFieldPosition -java/text/DontCareFieldPosition$1 -java/text/Format$FieldDelegate -javax/swing/plaf/BorderUIResource -javax/swing/BorderFactory -javax/swing/border/BevelBorder -javax/swing/plaf/metal/MetalIconFactory$TreeFolderIcon -javax/swing/plaf/metal/MetalIconFactory$FolderIcon16 -java/util/zip/ZipInputStream -java/io/PushbackInputStream -java/util/zip/CRC32 -java/util/zip/Checksum -java/awt/TrayIcon -java/lang/Thread$State -javax/swing/SwingUtilities$SharedOwnerFrame -javax/swing/JTable -javax/swing/event/TableModelListener -javax/swing/event/TableColumnModelListener -javax/swing/event/CellEditorListener -javax/swing/event/RowSorterListener -java/awt/Component$BltSubRegionBufferStrategy -sun/awt/SubRegionShowable -java/awt/Component$BltBufferStrategy -sun/print/PrinterGraphicsConfig -javax/swing/JRadioButton -java/lang/ClassFormatError -sun/java2d/opengl/OGLGraphicsConfig -java/awt/print/PrinterGraphics -java/awt/PrintGraphics -javax/swing/JTabbedPane -javax/swing/JTabbedPane$ModelListener -javax/swing/plaf/metal/MetalTabbedPaneUI -javax/swing/plaf/basic/BasicTabbedPaneUI -javax/swing/plaf/TabbedPaneUI -javax/swing/plaf/metal/MetalTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$TabbedPaneScrollLayout -javax/swing/plaf/basic/BasicTabbedPaneUI$Handler -sun/swing/ImageIconUIResource -javax/swing/GrayFilter -java/awt/image/RGBImageFilter -java/awt/image/ImageFilter -java/awt/image/FilteredImageSource -org/w3c/dom/Node -org/xml/sax/SAXException -javax/xml/parsers/ParserConfigurationException -org/xml/sax/EntityResolver -java/security/NoSuchAlgorithmException -java/security/GeneralSecurityException -java/util/zip/GZIPInputStream -java/util/zip/DeflaterOutputStream -org/xml/sax/InputSource -javax/xml/parsers/DocumentBuilderFactory -javax/xml/parsers/FactoryFinder -javax/xml/parsers/SecuritySupport -javax/xml/parsers/SecuritySupport$2 -javax/xml/parsers/SecuritySupport$5 -javax/xml/parsers/SecuritySupport$1 -javax/xml/parsers/SecuritySupport$4 -javax/xml/parsers/DocumentBuilder -org/w3c/dom/Document -org/xml/sax/helpers/DefaultHandler -org/xml/sax/DTDHandler -org/xml/sax/ContentHandler -org/xml/sax/ErrorHandler -org/xml/sax/SAXNotSupportedException -org/xml/sax/Locator -org/xml/sax/SAXNotRecognizedException -org/xml/sax/SAXParseException -org/w3c/dom/NodeList -org/w3c/dom/events/EventTarget -org/w3c/dom/traversal/DocumentTraversal -org/w3c/dom/events/DocumentEvent -org/w3c/dom/ranges/DocumentRange -org/w3c/dom/Entity -org/w3c/dom/Element -org/w3c/dom/CharacterData -org/w3c/dom/CDATASection -org/w3c/dom/Text -org/xml/sax/AttributeList -org/w3c/dom/DOMException -org/w3c/dom/Notation -org/w3c/dom/DocumentType -org/w3c/dom/Attr -org/w3c/dom/EntityReference -org/w3c/dom/ProcessingInstruction -org/w3c/dom/Comment -org/w3c/dom/DocumentFragment -org/w3c/dom/events/Event -org/w3c/dom/events/MutationEvent -org/w3c/dom/traversal/TreeWalker -org/w3c/dom/ranges/Range -org/w3c/dom/traversal/NodeIterator -org/w3c/dom/events/EventException -org/w3c/dom/NamedNodeMap -java/lang/StringIndexOutOfBoundsException -java/awt/GridLayout -javax/swing/plaf/metal/MetalRadioButtonUI -javax/swing/plaf/basic/BasicRadioButtonUI -javax/swing/plaf/basic/BasicBorders -javax/swing/plaf/metal/MetalIconFactory$RadioButtonIcon -java/awt/event/ItemEvent -java/awt/CardLayout$Card -javax/swing/JCheckBox -javax/swing/event/ListSelectionEvent -javax/swing/plaf/metal/MetalCheckBoxUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxIcon -java/lang/ExceptionInInitializerError -com/sun/java/swing/plaf/windows/WindowsTabbedPaneUI -javax/swing/JProgressBar -javax/swing/JProgressBar$ModelListener -javax/swing/plaf/metal/MetalProgressBarUI -javax/swing/plaf/basic/BasicProgressBarUI -javax/swing/plaf/ProgressBarUI -javax/swing/plaf/BorderUIResource$LineBorderUIResource -javax/swing/plaf/basic/BasicProgressBarUI$Handler -javax/swing/tree/TreeModel -javax/swing/table/TableCellRenderer -javax/swing/table/JTableHeader -javax/swing/event/TreeExpansionListener -javax/swing/table/AbstractTableModel -javax/swing/table/TableModel -javax/swing/table/DefaultTableCellRenderer -javax/swing/JTree -javax/swing/tree/TreeSelectionModel -javax/swing/tree/DefaultTreeCellRenderer -javax/swing/tree/TreeCellRenderer -javax/swing/table/TableCellEditor -javax/swing/CellEditor -javax/swing/JToolTip -javax/swing/table/TableColumn -javax/swing/table/DefaultTableColumnModel -javax/swing/table/TableColumnModel -javax/swing/table/DefaultTableModel -javax/swing/event/TableModelEvent -sun/swing/table/DefaultTableCellHeaderRenderer -javax/swing/plaf/basic/BasicTableHeaderUI -javax/swing/plaf/TableHeaderUI -javax/swing/plaf/basic/BasicTableHeaderUI$1 -javax/swing/plaf/basic/BasicTableHeaderUI$MouseInputHandler -javax/swing/DefaultCellEditor -javax/swing/tree/TreeCellEditor -javax/swing/AbstractCellEditor -javax/swing/plaf/basic/BasicTableUI -javax/swing/plaf/TableUI -javax/swing/plaf/basic/BasicTableUI$TableTransferHandler -javax/swing/plaf/basic/BasicTableUI$Handler -javax/swing/tree/DefaultTreeSelectionModel -javax/swing/tree/TreePath -javax/swing/plaf/metal/MetalTreeUI -javax/swing/plaf/basic/BasicTreeUI -javax/swing/plaf/TreeUI -javax/swing/plaf/basic/BasicTreeUI$Actions -javax/swing/plaf/basic/BasicTreeUI$TreeTransferHandler -javax/swing/plaf/metal/MetalTreeUI$LineListener -javax/swing/plaf/basic/BasicTreeUI$Handler -javax/swing/event/TreeModelListener -javax/swing/event/TreeSelectionListener -javax/swing/tree/VariableHeightLayoutCache +javax/swing/text/JTextComponent$KeymapWrapper +javax/swing/text/JTextComponent$MutableCaretEvent +javax/swing/text/Keymap +javax/swing/text/LayeredHighlighter +javax/swing/text/LayeredHighlighter$LayerPainter +javax/swing/text/MutableAttributeSet +javax/swing/text/PlainDocument +javax/swing/text/PlainView +javax/swing/text/Position +javax/swing/text/Position$Bias +javax/swing/text/Segment +javax/swing/text/SegmentCache +javax/swing/text/SegmentCache$CachedSegment +javax/swing/text/SimpleAttributeSet +javax/swing/text/SimpleAttributeSet$EmptyAttributeSet +javax/swing/text/Style +javax/swing/text/StyleConstants +javax/swing/text/StyleConstants$CharacterConstants +javax/swing/text/StyleConstants$ColorConstants +javax/swing/text/StyleConstants$FontConstants +javax/swing/text/StyleConstants$ParagraphConstants +javax/swing/text/StyleContext +javax/swing/text/StyleContext$FontKey +javax/swing/text/StyleContext$KeyEnumeration +javax/swing/text/StyleContext$NamedStyle +javax/swing/text/StyleContext$SmallAttributeSet +javax/swing/text/TabExpander +javax/swing/text/TextAction +javax/swing/text/Utilities +javax/swing/text/View +javax/swing/text/ViewFactory javax/swing/tree/AbstractLayoutCache -javax/swing/tree/RowMapper -javax/swing/plaf/basic/BasicTreeUI$NodeDimensionsHandler javax/swing/tree/AbstractLayoutCache$NodeDimensions -javax/swing/JTree$TreeModelHandler -javax/swing/tree/VariableHeightLayoutCache$TreeStateNode javax/swing/tree/DefaultMutableTreeNode -javax/swing/tree/MutableTreeNode javax/swing/tree/DefaultMutableTreeNode$PreorderEnumeration -javax/swing/event/TableColumnModelEvent -java/text/ParseException -java/text/NumberFormat$Field -javax/swing/event/UndoableEditListener -javax/swing/filechooser/FileFilter -javax/swing/tree/DefaultTreeModel javax/swing/tree/DefaultTreeCellEditor javax/swing/tree/DefaultTreeCellEditor$1 javax/swing/tree/DefaultTreeCellEditor$DefaultTextField -javax/swing/DefaultCellEditor$1 -javax/swing/DefaultCellEditor$EditorDelegate javax/swing/tree/DefaultTreeCellEditor$EditorContainer -javax/swing/JTree$TreeSelectionRedirector -javax/swing/event/TreeModelEvent -javax/swing/plaf/metal/MetalSplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneUI -javax/swing/plaf/SplitPaneUI -javax/swing/plaf/basic/BasicSplitPaneDivider -javax/swing/plaf/basic/BasicBorders$SplitPaneBorder -javax/swing/plaf/metal/MetalSplitPaneDivider -javax/swing/plaf/basic/BasicSplitPaneDivider$DividerLayout -javax/swing/plaf/basic/BasicSplitPaneDivider$MouseHandler -javax/swing/plaf/basic/BasicBorders$SplitPaneDividerBorder -javax/swing/plaf/basic/BasicSplitPaneUI$BasicHorizontalLayoutManager -javax/swing/plaf/basic/BasicSplitPaneUI$1 -javax/swing/plaf/basic/BasicSplitPaneUI$Handler -javax/swing/plaf/metal/MetalSplitPaneDivider$1 -javax/swing/plaf/basic/BasicSplitPaneDivider$OneTouchActionHandler -javax/swing/plaf/metal/MetalSplitPaneDivider$2 -javax/swing/border/TitledBorder -javax/swing/plaf/basic/BasicTextAreaUI -java/util/Collections$UnmodifiableCollection$1 -java/net/NoRouteToHostException -java/net/BindException +javax/swing/tree/DefaultTreeCellRenderer +javax/swing/tree/DefaultTreeModel +javax/swing/tree/DefaultTreeSelectionModel +javax/swing/tree/MutableTreeNode javax/swing/tree/PathPlaceHolder -javax/swing/event/TreeSelectionEvent -javax/swing/JList$3 -javax/swing/JList$ListSelectionHandler -javax/swing/JSlider -javax/swing/JSlider$ModelListener -javax/swing/plaf/metal/MetalSliderUI -javax/swing/plaf/basic/BasicSliderUI -javax/swing/plaf/SliderUI -javax/swing/plaf/basic/BasicSliderUI$Actions -javax/swing/plaf/metal/MetalIconFactory$HorizontalSliderThumbIcon -javax/swing/plaf/metal/MetalIconFactory$VerticalSliderThumbIcon -javax/swing/plaf/basic/BasicSliderUI$TrackListener -javax/swing/plaf/basic/BasicSliderUI$Handler -javax/swing/plaf/basic/BasicSliderUI$ScrollListener -javax/swing/plaf/metal/MetalSliderUI$MetalPropertyListener -javax/swing/plaf/basic/BasicSliderUI$PropertyChangeHandler -sun/java2d/HeadlessGraphicsEnvironment -java/util/Hashtable$KeySet -javax/swing/DefaultListModel -javax/swing/event/ListDataEvent -javax/sound/sampled/DataLine -javax/sound/sampled/Line -javax/sound/sampled/Line$Info -javax/sound/sampled/DataLine$Info -javax/sound/sampled/Control$Type -javax/sound/sampled/FloatControl$Type -javax/sound/sampled/LineUnavailableException -javax/sound/sampled/UnsupportedAudioFileException -javax/swing/JRadioButtonMenuItem -javax/swing/JMenuItem$AccessibleJMenuItem -javax/swing/AbstractButton$AccessibleAbstractButton -javax/accessibility/AccessibleAction -javax/accessibility/AccessibleValue -javax/accessibility/AccessibleText -javax/accessibility/AccessibleExtendedComponent -javax/accessibility/AccessibleComponent -javax/swing/JComponent$AccessibleJComponent -java/awt/Container$AccessibleAWTContainer -java/awt/Component$AccessibleAWTComponent -javax/accessibility/AccessibleRelationSet -javax/accessibility/AccessibleState -javax/accessibility/AccessibleBundle -javax/swing/plaf/basic/BasicCheckBoxMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$CheckBoxMenuItemIcon -javax/swing/JCheckBoxMenuItem$AccessibleJCheckBoxMenuItem -javax/swing/plaf/basic/BasicRadioButtonMenuItemUI -javax/swing/plaf/metal/MetalIconFactory$RadioButtonMenuItemIcon +javax/swing/tree/RowMapper +javax/swing/tree/TreeCellEditor +javax/swing/tree/TreeCellRenderer +javax/swing/tree/TreeModel +javax/swing/tree/TreeNode +javax/swing/tree/TreePath +javax/swing/tree/TreeSelectionModel +javax/swing/tree/VariableHeightLayoutCache +javax/swing/tree/VariableHeightLayoutCache$TreeStateNode +javax/swing/undo/AbstractUndoableEdit +javax/swing/undo/CompoundEdit +javax/swing/undo/UndoableEdit +javax/xml/parsers/DocumentBuilder +javax/xml/parsers/DocumentBuilderFactory +javax/xml/parsers/FactoryFinder +javax/xml/parsers/FactoryFinder$1 +javax/xml/parsers/ParserConfigurationException +javax/xml/parsers/SecuritySupport +javax/xml/parsers/SecuritySupport$2 +javax/xml/parsers/SecuritySupport$5 +org/w3c/dom/Attr +org/w3c/dom/CDATASection +org/w3c/dom/CharacterData +org/w3c/dom/Comment +org/w3c/dom/DOMException +org/w3c/dom/Document +org/w3c/dom/DocumentFragment +org/w3c/dom/DocumentType +org/w3c/dom/Element +org/w3c/dom/Entity +org/w3c/dom/EntityReference +org/w3c/dom/NamedNodeMap +org/w3c/dom/Node +org/w3c/dom/NodeList +org/w3c/dom/Notation +org/w3c/dom/ProcessingInstruction +org/w3c/dom/Text +org/w3c/dom/events/DocumentEvent +org/w3c/dom/events/Event +org/w3c/dom/events/EventException +org/w3c/dom/events/EventTarget +org/w3c/dom/events/MutationEvent +org/w3c/dom/ranges/DocumentRange +org/w3c/dom/ranges/Range +org/w3c/dom/traversal/DocumentTraversal +org/w3c/dom/traversal/NodeIterator +org/w3c/dom/traversal/TreeWalker +org/xml/sax/AttributeList +org/xml/sax/ContentHandler +org/xml/sax/DTDHandler +org/xml/sax/EntityResolver +org/xml/sax/ErrorHandler +org/xml/sax/InputSource +org/xml/sax/Locator +org/xml/sax/SAXException +org/xml/sax/SAXNotRecognizedException +org/xml/sax/SAXNotSupportedException +org/xml/sax/SAXParseException +org/xml/sax/helpers/DefaultHandler +sun/awt/AWTAccessor +sun/awt/AWTAccessor$AWTEventAccessor +sun/awt/AWTAccessor$ClientPropertyKeyAccessor +sun/awt/AWTAccessor$ComponentAccessor +sun/awt/AWTAccessor$ContainerAccessor +sun/awt/AWTAccessor$CursorAccessor +sun/awt/AWTAccessor$DefaultKeyboardFocusManagerAccessor +sun/awt/AWTAccessor$EventQueueAccessor +sun/awt/AWTAccessor$FrameAccessor +sun/awt/AWTAccessor$InputEventAccessor +sun/awt/AWTAccessor$InvocationEventAccessor +sun/awt/AWTAccessor$KeyEventAccessor +sun/awt/AWTAccessor$KeyboardFocusManagerAccessor +sun/awt/AWTAccessor$SequencedEventAccessor +sun/awt/AWTAccessor$ToolkitAccessor +sun/awt/AWTAccessor$WindowAccessor +sun/awt/AWTAutoShutdown +sun/awt/AWTAutoShutdown$1 +sun/awt/AppContext +sun/awt/AppContext$1 +sun/awt/AppContext$2 +sun/awt/AppContext$3 +sun/awt/AppContext$6 +sun/awt/AppContext$GetAppContextLock +sun/awt/AppContext$PostShutdownEventRunnable +sun/awt/AppContext$State +sun/awt/CausedFocusEvent +sun/awt/CausedFocusEvent$Cause +sun/awt/ComponentFactory +sun/awt/ConstrainableGraphics +sun/awt/DisplayChangedListener +sun/awt/EmbeddedFrame +sun/awt/EventQueueDelegate +sun/awt/EventQueueItem +sun/awt/ExtendedKeyCodes +sun/awt/FontConfiguration +sun/awt/FontConfiguration$2 +sun/awt/FontDescriptor +sun/awt/GlobalCursorManager +sun/awt/GlobalCursorManager$NativeUpdater +sun/awt/HeadlessToolkit +sun/awt/InputMethodSupport +sun/awt/KeyboardFocusManagerPeerImpl +sun/awt/KeyboardFocusManagerPeerProvider +sun/awt/LightweightFrame +sun/awt/ModalExclude +sun/awt/ModalityListener +sun/awt/MostRecentKeyValue +sun/awt/NativeLibLoader +sun/awt/NativeLibLoader$1 +sun/awt/NullComponentPeer +sun/awt/OSInfo +sun/awt/OSInfo$1 +sun/awt/OSInfo$OSType +sun/awt/OSInfo$WindowsVersion +sun/awt/PaintEventDispatcher +sun/awt/PeerEvent +sun/awt/PlatformFont +sun/awt/PostEventQueue +sun/awt/RepaintArea +sun/awt/RequestFocusController +sun/awt/SubRegionShowable +sun/awt/SunDisplayChanger +sun/awt/SunGraphicsCallback +sun/awt/SunHints +sun/awt/SunHints$Key +sun/awt/SunHints$LCDContrastKey +sun/awt/SunHints$Value +sun/awt/SunToolkit +sun/awt/SunToolkit$ModalityListenerList +sun/awt/Symbol +sun/awt/Symbol$Encoder +sun/awt/TimedWindowEvent +sun/awt/Win32FontManager +sun/awt/Win32FontManager$1 +sun/awt/Win32FontManager$2 +sun/awt/Win32GraphicsConfig +sun/awt/Win32GraphicsDevice +sun/awt/Win32GraphicsEnvironment +sun/awt/WindowClosingListener +sun/awt/WindowClosingSupport +sun/awt/dnd/SunDragSourceContextPeer +sun/awt/dnd/SunDropTargetEvent +sun/awt/event/IgnorePaintEvent +sun/awt/geom/PathConsumer2D +sun/awt/im/ExecutableInputMethodManager +sun/awt/im/ExecutableInputMethodManager$3 +sun/awt/im/InputContext +sun/awt/im/InputMethodAdapter +sun/awt/im/InputMethodContext +sun/awt/im/InputMethodLocator +sun/awt/im/InputMethodManager +sun/awt/im/InputMethodWindow +sun/awt/image/BufImgSurfaceData +sun/awt/image/BufImgSurfaceData$ICMColorData +sun/awt/image/BufImgSurfaceManager +sun/awt/image/BufImgVolatileSurfaceManager +sun/awt/image/BufferedImageDevice +sun/awt/image/BufferedImageGraphicsConfig +sun/awt/image/ByteComponentRaster +sun/awt/image/ByteInterleavedRaster +sun/awt/image/BytePackedRaster +sun/awt/image/FetcherInfo +sun/awt/image/GifFrame +sun/awt/image/GifImageDecoder +sun/awt/image/ImageConsumerQueue +sun/awt/image/ImageDecoder sun/awt/image/ImageDecoder$1 -javax/swing/JTabbedPane$Page -java/net/DatagramSocket -java/net/MulticastSocket -java/net/DatagramPacket +sun/awt/image/ImageFetchable +sun/awt/image/ImageFetcher +sun/awt/image/ImageFetcher$1 +sun/awt/image/ImageRepresentation +sun/awt/image/ImageWatched +sun/awt/image/ImageWatched$Link +sun/awt/image/ImageWatched$WeakLink +sun/awt/image/InputStreamImageSource +sun/awt/image/IntegerComponentRaster +sun/awt/image/IntegerInterleavedRaster +sun/awt/image/NativeLibLoader +sun/awt/image/NativeLibLoader$1 +sun/awt/image/OffScreenImage +sun/awt/image/PNGFilterInputStream +sun/awt/image/PNGImageDecoder +sun/awt/image/PixelConverter +sun/awt/image/PixelConverter$Argb +sun/awt/image/PixelConverter$ArgbBm +sun/awt/image/PixelConverter$ArgbPre +sun/awt/image/PixelConverter$Bgrx +sun/awt/image/PixelConverter$ByteGray +sun/awt/image/PixelConverter$Rgba +sun/awt/image/PixelConverter$RgbaPre +sun/awt/image/PixelConverter$Rgbx +sun/awt/image/PixelConverter$Ushort4444Argb +sun/awt/image/PixelConverter$Ushort555Rgb +sun/awt/image/PixelConverter$Ushort555Rgbx +sun/awt/image/PixelConverter$Ushort565Rgb +sun/awt/image/PixelConverter$UshortGray +sun/awt/image/PixelConverter$Xbgr +sun/awt/image/PixelConverter$Xrgb +sun/awt/image/SunVolatileImage +sun/awt/image/SunWritableRaster +sun/awt/image/SunWritableRaster$DataStealer +sun/awt/image/SurfaceManager +sun/awt/image/SurfaceManager$FlushableCacheData +sun/awt/image/SurfaceManager$ImageAccessor +sun/awt/image/SurfaceManager$ProxiedGraphicsConfig +sun/awt/image/ToolkitImage +sun/awt/image/URLImageSource +sun/awt/image/VolatileSurfaceManager +sun/awt/resources/awt +sun/awt/util/IdentityArrayList +sun/awt/windows/ThemeReader +sun/awt/windows/WCanvasPeer +sun/awt/windows/WColor +sun/awt/windows/WComponentPeer +sun/awt/windows/WComponentPeer$2 +sun/awt/windows/WDesktopProperties +sun/awt/windows/WDesktopProperties$WinPlaySound +sun/awt/windows/WFontConfiguration +sun/awt/windows/WFontPeer +sun/awt/windows/WFramePeer +sun/awt/windows/WGlobalCursorManager +sun/awt/windows/WInputMethod +sun/awt/windows/WInputMethodDescriptor +sun/awt/windows/WKeyboardFocusManagerPeer +sun/awt/windows/WLabelPeer +sun/awt/windows/WObjectPeer +sun/awt/windows/WPanelPeer +sun/awt/windows/WToolkit +sun/awt/windows/WToolkit$1 +sun/awt/windows/WToolkit$2 +sun/awt/windows/WToolkit$3 +sun/awt/windows/WToolkit$3$1 +sun/awt/windows/WToolkit$ToolkitDisposer +sun/awt/windows/WWindowPeer +sun/awt/windows/WWindowPeer$ActiveWindowListener +sun/awt/windows/WWindowPeer$GuiDisposedListener +sun/awt/windows/WingDings +sun/awt/windows/WingDings$Encoder +sun/dc/DuctusRenderingEngine +sun/dc/path/PathConsumer +sun/dc/pr/PathDasher +sun/dc/pr/PathDasher$1 +sun/dc/pr/PathStroker +sun/dc/pr/PathStroker$1 +sun/font/AttributeValues +sun/font/CMap +sun/font/CMap$CMapFormat4 +sun/font/CMap$NullCMapClass +sun/font/CharToGlyphMapper +sun/font/CompositeFont +sun/font/CompositeFontDescriptor +sun/font/CompositeGlyphMapper +sun/font/CompositeStrike +sun/font/CoreMetrics +sun/font/EAttribute +sun/font/FileFont +sun/font/FileFontStrike +sun/font/Font2D +sun/font/Font2DHandle +sun/font/FontAccess +sun/font/FontDesignMetrics +sun/font/FontDesignMetrics$KeyReference +sun/font/FontDesignMetrics$MetricsKey +sun/font/FontFamily +sun/font/FontLineMetrics +sun/font/FontManager +sun/font/FontManagerFactory +sun/font/FontManagerFactory$1 +sun/font/FontManagerForSGE +sun/font/FontManagerNativeLibrary +sun/font/FontManagerNativeLibrary$1 +sun/font/FontScaler +sun/font/FontStrike +sun/font/FontStrikeDesc +sun/font/FontStrikeDisposer +sun/font/FontUtilities +sun/font/FontUtilities$1 +sun/font/GlyphList +sun/font/PhysicalFont +sun/font/PhysicalStrike +sun/font/StandardGlyphVector +sun/font/StandardGlyphVector$GlyphStrike +sun/font/StrikeCache +sun/font/StrikeCache$1 +sun/font/StrikeCache$DisposableStrike +sun/font/StrikeCache$SoftDisposerRef +sun/font/StrikeMetrics +sun/font/SunFontManager +sun/font/SunFontManager$1 +sun/font/SunFontManager$11 +sun/font/SunFontManager$12 +sun/font/SunFontManager$2 +sun/font/SunFontManager$3 +sun/font/SunFontManager$FamilyDescription +sun/font/SunFontManager$FontRegistrationInfo +sun/font/SunFontManager$T1Filter +sun/font/SunFontManager$TTFilter +sun/font/T2KFontScaler +sun/font/T2KFontScaler$1 +sun/font/TrueTypeFont +sun/font/TrueTypeFont$1 +sun/font/TrueTypeFont$DirectoryEntry +sun/font/TrueTypeFont$TTDisposerRecord +sun/font/TrueTypeGlyphMapper +sun/font/Type1Font +sun/io/Win32ErrorMode +sun/java2d/DefaultDisposerRecord +sun/java2d/DestSurfaceProvider +sun/java2d/Disposer +sun/java2d/Disposer$1 +sun/java2d/Disposer$2 +sun/java2d/Disposer$PollDisposable +sun/java2d/DisposerRecord +sun/java2d/DisposerTarget +sun/java2d/FontSupport +sun/java2d/InvalidPipeException +sun/java2d/NullSurfaceData +sun/java2d/ScreenUpdateManager +sun/java2d/StateTrackable +sun/java2d/StateTrackable$State +sun/java2d/StateTrackableDelegate +sun/java2d/StateTrackableDelegate$2 +sun/java2d/StateTracker +sun/java2d/StateTracker$1 +sun/java2d/StateTracker$2 +sun/java2d/SunGraphics2D +sun/java2d/SunGraphicsEnvironment +sun/java2d/SunGraphicsEnvironment$1 +sun/java2d/Surface +sun/java2d/SurfaceData +sun/java2d/SurfaceData$PixelToPgramLoopConverter +sun/java2d/SurfaceData$PixelToShapeLoopConverter +sun/java2d/SurfaceDataProxy +sun/java2d/SurfaceDataProxy$1 +sun/java2d/SurfaceManagerFactory +sun/java2d/WindowsSurfaceManagerFactory +sun/java2d/cmm/ProfileActivator +sun/java2d/cmm/ProfileDeferralInfo +sun/java2d/cmm/ProfileDeferralMgr +sun/java2d/d3d/D3DContext$D3DContextCaps +sun/java2d/d3d/D3DGraphicsConfig +sun/java2d/d3d/D3DGraphicsDevice +sun/java2d/d3d/D3DGraphicsDevice$1 +sun/java2d/d3d/D3DGraphicsDevice$1Result +sun/java2d/d3d/D3DRenderQueue +sun/java2d/d3d/D3DRenderQueue$1 +sun/java2d/d3d/D3DScreenUpdateManager +sun/java2d/d3d/D3DScreenUpdateManager$1 +sun/java2d/d3d/D3DScreenUpdateManager$1$1 +sun/java2d/d3d/D3DSurfaceData +sun/java2d/d3d/D3DSurfaceData$D3DWindowSurfaceData +sun/java2d/loops/Blit +sun/java2d/loops/BlitBg +sun/java2d/loops/CompositeType +sun/java2d/loops/CustomComponent +sun/java2d/loops/DrawGlyphList +sun/java2d/loops/DrawGlyphListAA +sun/java2d/loops/DrawGlyphListLCD +sun/java2d/loops/DrawLine +sun/java2d/loops/DrawParallelogram +sun/java2d/loops/DrawPath +sun/java2d/loops/DrawPolygons +sun/java2d/loops/DrawRect +sun/java2d/loops/FillParallelogram +sun/java2d/loops/FillPath +sun/java2d/loops/FillRect +sun/java2d/loops/FillSpans +sun/java2d/loops/FontInfo +sun/java2d/loops/GeneralRenderer +sun/java2d/loops/GraphicsPrimitive +sun/java2d/loops/GraphicsPrimitiveMgr +sun/java2d/loops/GraphicsPrimitiveMgr$1 +sun/java2d/loops/GraphicsPrimitiveMgr$2 +sun/java2d/loops/GraphicsPrimitiveMgr$PrimitiveSpec +sun/java2d/loops/GraphicsPrimitiveProxy +sun/java2d/loops/MaskBlit +sun/java2d/loops/MaskFill +sun/java2d/loops/RenderCache +sun/java2d/loops/RenderCache$Entry +sun/java2d/loops/RenderLoops +sun/java2d/loops/ScaledBlit +sun/java2d/loops/SurfaceType +sun/java2d/loops/TransformHelper +sun/java2d/loops/XORComposite +sun/java2d/opengl/OGLGraphicsConfig +sun/java2d/opengl/WGLGraphicsConfig +sun/java2d/pipe/AAShapePipe +sun/java2d/pipe/AATextRenderer +sun/java2d/pipe/AlphaColorPipe +sun/java2d/pipe/AlphaPaintPipe +sun/java2d/pipe/CompositePipe +sun/java2d/pipe/DrawImage +sun/java2d/pipe/DrawImagePipe +sun/java2d/pipe/GeneralCompositePipe +sun/java2d/pipe/GlyphListLoopPipe +sun/java2d/pipe/GlyphListPipe +sun/java2d/pipe/LCDTextRenderer +sun/java2d/pipe/LoopBasedPipe +sun/java2d/pipe/LoopPipe +sun/java2d/pipe/NullPipe +sun/java2d/pipe/OutlineTextRenderer +sun/java2d/pipe/ParallelogramPipe +sun/java2d/pipe/PixelDrawPipe +sun/java2d/pipe/PixelFillPipe +sun/java2d/pipe/PixelToParallelogramConverter +sun/java2d/pipe/PixelToShapeConverter +sun/java2d/pipe/Region +sun/java2d/pipe/Region$ImmutableRegion +sun/java2d/pipe/RegionIterator +sun/java2d/pipe/RenderBuffer +sun/java2d/pipe/RenderQueue +sun/java2d/pipe/RenderingEngine +sun/java2d/pipe/RenderingEngine$1 +sun/java2d/pipe/ShapeDrawPipe +sun/java2d/pipe/ShapeSpanIterator +sun/java2d/pipe/SolidTextRenderer +sun/java2d/pipe/SpanClipRenderer +sun/java2d/pipe/SpanIterator +sun/java2d/pipe/SpanShapeRenderer +sun/java2d/pipe/SpanShapeRenderer$Composite +sun/java2d/pipe/TextPipe +sun/java2d/pipe/TextRenderer +sun/java2d/pipe/ValidatePipe +sun/java2d/pipe/hw/AccelGraphicsConfig +sun/java2d/pipe/hw/AccelSurface +sun/java2d/pipe/hw/BufferedContextProvider +sun/java2d/pipe/hw/ContextCapabilities +sun/java2d/windows/GDIBlitLoops +sun/java2d/windows/GDIRenderer +sun/java2d/windows/GDIWindowSurfaceData +sun/java2d/windows/WindowsFlags +sun/java2d/windows/WindowsFlags$1 +sun/launcher/LauncherHelper +sun/launcher/LauncherHelper$FXHelper +sun/misc/ASCIICaseInsensitiveComparator +sun/misc/Cleaner +sun/misc/CompoundEnumeration +sun/misc/ExtensionDependency +sun/misc/FDBigInteger +sun/misc/FileURLMapper +sun/misc/FloatingDecimal +sun/misc/FloatingDecimal$1 +sun/misc/FloatingDecimal$ASCIIToBinaryBuffer +sun/misc/FloatingDecimal$ASCIIToBinaryConverter +sun/misc/FloatingDecimal$BinaryToASCIIBuffer +sun/misc/FloatingDecimal$BinaryToASCIIConverter +sun/misc/FloatingDecimal$ExceptionalBinaryToASCIIBuffer +sun/misc/FloatingDecimal$PreparedASCIIToBinaryBuffer +sun/misc/IOUtils +sun/misc/JarIndex +sun/misc/JavaAWTAccess +sun/misc/JavaIOFileDescriptorAccess +sun/misc/JavaLangAccess +sun/misc/JavaNetAccess +sun/misc/JavaNioAccess +sun/misc/JavaSecurityAccess +sun/misc/JavaSecurityProtectionDomainAccess +sun/misc/JavaUtilJarAccess +sun/misc/JavaUtilZipFileAccess +sun/misc/Launcher +sun/misc/Launcher$AppClassLoader +sun/misc/Launcher$AppClassLoader$1 +sun/misc/Launcher$BootClassPathHolder +sun/misc/Launcher$BootClassPathHolder$1 +sun/misc/Launcher$ExtClassLoader +sun/misc/Launcher$ExtClassLoader$1 +sun/misc/Launcher$Factory +sun/misc/MetaIndex +sun/misc/NativeSignalHandler +sun/misc/OSEnvironment +sun/misc/Perf +sun/misc/Perf$GetPerfAction +sun/misc/PerfCounter +sun/misc/PerfCounter$CoreCounters +sun/misc/PerfCounter$WindowsClientCounters +sun/misc/PerformanceLogger +sun/misc/PerformanceLogger$TimeData +sun/misc/PostVMInitHook +sun/misc/Resource +sun/misc/SharedSecrets +sun/misc/Signal +sun/misc/SignalHandler +sun/misc/SoftCache +sun/misc/SoftCache$ValueCell +sun/misc/URLClassPath +sun/misc/URLClassPath$1 +sun/misc/URLClassPath$2 +sun/misc/URLClassPath$3 +sun/misc/URLClassPath$FileLoader +sun/misc/URLClassPath$JarLoader +sun/misc/URLClassPath$JarLoader$1 +sun/misc/URLClassPath$JarLoader$2 +sun/misc/URLClassPath$Loader +sun/misc/Unsafe +sun/misc/VM +sun/misc/Version +sun/net/DefaultProgressMeteringPolicy +sun/net/InetAddressCachePolicy sun/net/InetAddressCachePolicy$1 -sun/security/action/GetIntegerAction sun/net/InetAddressCachePolicy$2 -java/net/InetAddress$CacheEntry -java/net/DatagramSocketImpl -java/text/Collator -java/text/spi/CollatorProvider -sun/text/resources/CollationData -sun/text/resources/CollationData_en -sun/util/EmptyListResourceBundle -java/text/RuleBasedCollator -java/text/CollationRules -java/text/RBCollationTables -java/text/RBTableBuilder -java/text/RBCollationTables$BuildAPI -sun/text/IntHashtable -sun/text/UCompactIntArray -sun/text/normalizer/NormalizerImpl -sun/text/normalizer/ICUData -sun/text/normalizer/NormalizerDataReader -sun/text/normalizer/ICUBinary$Authenticate -sun/text/normalizer/ICUBinary -sun/text/normalizer/NormalizerImpl$FCDTrieImpl -sun/text/normalizer/Trie$DataManipulate -sun/text/normalizer/NormalizerImpl$NormTrieImpl -sun/text/normalizer/NormalizerImpl$AuxTrieImpl -sun/text/normalizer/IntTrie -sun/text/normalizer/Trie -sun/text/normalizer/CharTrie -sun/text/normalizer/CharTrie$FriendAgent -sun/text/normalizer/UnicodeSet -sun/text/normalizer/UnicodeMatcher -sun/text/normalizer/NormalizerImpl$DecomposeArgs -java/text/MergeCollation -java/text/PatternEntry$Parser -java/text/PatternEntry -java/text/EntryPair -sun/text/ComposedCharIter -sun/text/normalizer/UTF16 +sun/net/NetHooks +sun/net/NetProperties +sun/net/NetProperties$1 +sun/net/ProgressMeteringPolicy +sun/net/ProgressMonitor +sun/net/ResourceManager +sun/net/spi/DefaultProxySelector +sun/net/spi/DefaultProxySelector$1 +sun/net/spi/DefaultProxySelector$3 +sun/net/spi/DefaultProxySelector$NonProxyInfo +sun/net/spi/nameservice/NameService +sun/net/util/IPAddressUtil +sun/net/util/URLUtil +sun/net/www/MessageHeader +sun/net/www/MimeEntry +sun/net/www/MimeTable +sun/net/www/MimeTable$1 +sun/net/www/MimeTable$DefaultInstanceHolder +sun/net/www/MimeTable$DefaultInstanceHolder$1 +sun/net/www/ParseUtil +sun/net/www/URLConnection +sun/net/www/protocol/file/FileURLConnection +sun/net/www/protocol/file/Handler sun/net/www/protocol/http/Handler -java/security/SignatureException -java/security/InvalidKeyException -java/security/KeyException -java/security/Signature -java/security/SignatureSpi -java/io/ObjectInputStream$BlockDataInputStream -java/io/ObjectInputStream$PeekInputStream -java/io/ObjectInputStream$HandleTable -java/io/ObjectInputStream$HandleTable$HandleList -java/io/ObjectInputStream$ValidationList -sun/security/provider/DSAPublicKey -java/security/interfaces/DSAPublicKey -java/security/interfaces/DSAKey -java/security/PublicKey -java/security/Key -sun/security/x509/X509Key -java/io/ObjectStreamClass$Caches -java/io/ObjectStreamClass$WeakClassKey -java/io/ObjectStreamClass$EntryFuture -java/io/ObjectStreamClass$2 -sun/security/x509/AlgorithmId -sun/security/util/DerEncoder -sun/security/util/BitArray +sun/net/www/protocol/jar/Handler +sun/net/www/protocol/jar/JarFileFactory +sun/net/www/protocol/jar/JarURLConnection +sun/net/www/protocol/jar/JarURLConnection$JarURLInputStream +sun/net/www/protocol/jar/URLJarFile +sun/net/www/protocol/jar/URLJarFile$URLJarFileCloseController +sun/net/www/protocol/jar/URLJarFile$URLJarFileEntry +sun/nio/ByteBuffered +sun/nio/ch/DirectBuffer +sun/nio/ch/FileChannelImpl +sun/nio/ch/FileDispatcher +sun/nio/ch/FileDispatcherImpl +sun/nio/ch/IOStatus +sun/nio/ch/IOUtil +sun/nio/ch/IOUtil$1 +sun/nio/ch/Interruptible +sun/nio/ch/NativeDispatcher +sun/nio/ch/NativeThread +sun/nio/ch/NativeThreadSet +sun/nio/ch/Util +sun/nio/ch/Util$1 +sun/nio/ch/Util$BufferCache +sun/nio/cs/ArrayDecoder +sun/nio/cs/ArrayEncoder +sun/nio/cs/FastCharsetProvider +sun/nio/cs/HistoricallyNamedCharset +sun/nio/cs/ISO_8859_1 +sun/nio/cs/MS1252 +sun/nio/cs/SingleByte +sun/nio/cs/SingleByte$Decoder +sun/nio/cs/SingleByte$Encoder +sun/nio/cs/StandardCharsets +sun/nio/cs/StandardCharsets$Aliases +sun/nio/cs/StandardCharsets$Cache +sun/nio/cs/StandardCharsets$Classes +sun/nio/cs/StreamDecoder +sun/nio/cs/StreamEncoder +sun/nio/cs/Surrogate +sun/nio/cs/Surrogate$Parser +sun/nio/cs/US_ASCII +sun/nio/cs/UTF_16 +sun/nio/cs/UTF_16$Decoder +sun/nio/cs/UTF_16BE +sun/nio/cs/UTF_16LE +sun/nio/cs/UTF_16LE$Decoder +sun/nio/cs/UTF_16LE$Encoder +sun/nio/cs/UTF_8 +sun/nio/cs/UTF_8$Decoder +sun/nio/cs/UTF_8$Encoder +sun/nio/cs/Unicode +sun/nio/cs/UnicodeDecoder +sun/nio/cs/UnicodeEncoder +sun/print/PrinterGraphicsConfig +sun/reflect/AccessorGenerator +sun/reflect/BootstrapConstructorAccessorImpl +sun/reflect/ByteVector +sun/reflect/ByteVectorFactory +sun/reflect/ByteVectorImpl +sun/reflect/CallerSensitive +sun/reflect/ClassDefiner +sun/reflect/ClassDefiner$1 +sun/reflect/ClassFileAssembler +sun/reflect/ClassFileConstants +sun/reflect/ConstantPool +sun/reflect/ConstructorAccessor +sun/reflect/ConstructorAccessorImpl +sun/reflect/DelegatingClassLoader +sun/reflect/DelegatingConstructorAccessorImpl +sun/reflect/DelegatingMethodAccessorImpl +sun/reflect/FieldAccessor +sun/reflect/FieldAccessorImpl +sun/reflect/Label +sun/reflect/Label$PatchInfo +sun/reflect/LangReflectAccess +sun/reflect/MagicAccessorImpl +sun/reflect/MethodAccessor +sun/reflect/MethodAccessorGenerator +sun/reflect/MethodAccessorGenerator$1 +sun/reflect/MethodAccessorImpl +sun/reflect/NativeConstructorAccessorImpl +sun/reflect/NativeMethodAccessorImpl +sun/reflect/Reflection +sun/reflect/ReflectionFactory +sun/reflect/ReflectionFactory$1 +sun/reflect/ReflectionFactory$GetReflectionFactoryAction +sun/reflect/SerializationConstructorAccessorImpl +sun/reflect/UTF8 +sun/reflect/UnsafeFieldAccessorFactory +sun/reflect/UnsafeFieldAccessorImpl +sun/reflect/UnsafeObjectFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticFieldAccessorImpl +sun/reflect/UnsafeQualifiedStaticIntegerFieldAccessorImpl sun/reflect/UnsafeQualifiedStaticLongFieldAccessorImpl -sun/security/util/DerOutputStream -sun/security/util/DerValue -java/io/ObjectStreamClass$FieldReflectorKey -java/io/ObjectStreamClass$FieldReflector -java/io/ObjectStreamClass$1 -java/io/DataOutputStream -java/io/ObjectStreamClass$MemberSignature -java/math/BigInteger -java/security/interfaces/DSAParams -java/io/ObjectStreamClass$ClassDataSlot -java/io/ObjectStreamClass$4 -java/io/ObjectStreamClass$5 -java/security/MessageDigest -java/security/MessageDigestSpi +sun/reflect/UnsafeQualifiedStaticObjectFieldAccessorImpl +sun/reflect/UnsafeStaticFieldAccessorImpl +sun/reflect/annotation/AnnotationType +sun/reflect/generics/repository/AbstractRepository +sun/reflect/generics/repository/ClassRepository +sun/reflect/generics/repository/GenericDeclRepository +sun/reflect/misc/MethodUtil +sun/reflect/misc/MethodUtil$1 +sun/reflect/misc/ReflectUtil +sun/security/action/GetBooleanAction +sun/security/action/GetIntegerAction +sun/security/action/GetPropertyAction sun/security/jca/GetInstance -sun/security/util/DerInputStream -sun/security/jca/Providers -sun/security/jca/ProviderList -sun/security/jca/ProviderConfig -sun/security/jca/ProviderList$3 -sun/security/jca/ProviderList$1 -sun/security/util/DerInputBuffer -sun/security/jca/ProviderList$2 -sun/security/jca/ProviderConfig$1 -sun/security/util/ObjectIdentifier -sun/security/jca/ProviderConfig$3 -java/security/Provider$Service -java/security/Provider$UString -java/security/AlgorithmParameters -java/security/AlgorithmParametersSpi -sun/security/provider/DSAParameters -sun/security/provider/SHA -sun/security/provider/DigestBase sun/security/jca/GetInstance$Instance -sun/security/util/ByteArrayLexOrder -sun/security/util/ByteArrayTagOrder -java/security/MessageDigest$Delegate -sun/security/provider/ByteArrayAccess -sun/security/util/DerIndefLenConverter -java/io/InvalidClassException -java/io/ObjectStreamException -java/io/ObjectInputStream$GetFieldImpl -java/io/ObjectInputStream$GetField -java/io/ObjectOutputStream$ReplaceTable -sun/security/jca/ServiceId +sun/security/jca/ProviderConfig +sun/security/jca/ProviderConfig$2 +sun/security/jca/ProviderList +sun/security/jca/ProviderList$1 +sun/security/jca/ProviderList$2 +sun/security/jca/ProviderList$3 sun/security/jca/ProviderList$ServiceList sun/security/jca/ProviderList$ServiceList$1 -java/security/Signature$Delegate -java/security/interfaces/DSAPrivateKey -sun/security/provider/DSA$SHA1withDSA +sun/security/jca/Providers +sun/security/jca/ServiceId +sun/security/provider/ByteArrayAccess sun/security/provider/DSA -java/security/spec/DSAParameterSpec -java/math/MutableBigInteger -java/math/SignedMutableBigInteger -java/awt/EventQueue$1AWTInvocationLock -java/awt/LightweightDispatcher$2 -java/awt/Component$FlipBufferStrategy -javax/swing/JTable$2 -javax/swing/JTable$Resizable3 -javax/swing/JTable$Resizable2 -javax/swing/JTable$5 -javax/swing/event/AncestorEvent -com/sun/java/swing/plaf/windows/WindowsLookAndFeel -com/sun/java/swing/plaf/windows/XPStyle -com/sun/java/swing/plaf/windows/XPStyle$SkinPainter -sun/swing/CachedPainter -sun/swing/ImageCache -com/sun/java/swing/plaf/windows/WindowsRootPaneUI -com/sun/java/swing/plaf/windows/WindowsRootPaneUI$AltProcessor -java/awt/SystemColor -com/sun/java/swing/plaf/windows/WindowsTreeUI$ExpandedIcon -com/sun/java/swing/plaf/windows/WindowsTreeUI$CollapsedIcon -com/sun/java/swing/plaf/windows/DesktopProperty -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$XPColorValue -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$XPValue -com/sun/java/swing/plaf/windows/TMSchema$Part -com/sun/java/swing/plaf/windows/TMSchema$Control -com/sun/java/swing/plaf/windows/TMSchema$Prop -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$XPColorValue$XPColorValueKey -com/sun/java/swing/plaf/windows/XPStyle$Skin -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$WindowsFontProperty -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$FontDesktopProperty -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$TriggerDesktopProperty -com/sun/java/swing/plaf/windows/DesktopProperty$WeakPCL -com/sun/java/swing/plaf/windows/WindowsClassicLookAndFeel -com/sun/java/swing/plaf/windows/TMSchema$State -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$LazyWindowsIcon -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$XPBorderValue -com/sun/java/swing/plaf/windows/WindowsIconFactory -com/sun/java/swing/plaf/windows/WindowsIconFactory$FrameButtonIcon -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$XPDLUValue -com/sun/java/swing/plaf/windows/WindowsLookAndFeel$ActiveWindowsIcon -sun/swing/SwingUtilities2$2$1 -sun/awt/image/ByteArrayImageSource -com/sun/java/swing/plaf/windows/resources/windows -com/sun/java/swing/plaf/windows/WindowsLabelUI -com/sun/java/swing/plaf/windows/WindowsButtonUI -sun/awt/windows/ThemeReader -java/util/EnumMap -com/sun/java/swing/plaf/windows/TMSchema$TypeEnum -com/sun/java/swing/plaf/windows/XPStyle$XPEmptyBorder -com/sun/java/swing/plaf/windows/WindowsToggleButtonUI -com/sun/java/swing/plaf/windows/XPStyle$XPFillBorder -com/sun/java/swing/plaf/windows/WindowsMenuBarUI -javax/swing/plaf/basic/BasicBorders$MenuBarBorder -com/sun/java/swing/plaf/windows/WindowsMenuBarUI$TakeFocus -javax/swing/plaf/basic/BasicMenuBarUI$Actions -com/sun/java/swing/plaf/windows/WindowsMenuUI -com/sun/java/swing/plaf/windows/WindowsIconFactory$MenuArrowIcon -javax/swing/plaf/basic/BasicIconFactory -javax/swing/plaf/basic/BasicIconFactory$MenuItemCheckIcon -com/sun/java/swing/plaf/windows/WindowsMenuUI$WindowsMouseInputHandler -javax/swing/plaf/basic/BasicMenuUI$MouseInputHandler -com/sun/java/swing/plaf/windows/WindowsMenuItemUI -com/sun/java/swing/plaf/windows/WindowsIconFactory$MenuItemArrowIcon -com/sun/java/swing/plaf/windows/WindowsIconFactory$MenuItemCheckIcon -com/sun/java/swing/plaf/windows/WindowsPopupMenuUI -javax/swing/Popup -com/sun/java/swing/plaf/windows/WindowsPopupMenuUI$MnemonicListener -com/sun/java/swing/plaf/windows/WindowsPopupMenuSeparatorUI -javax/swing/plaf/basic/BasicPopupMenuSeparatorUI -com/sun/java/swing/plaf/windows/WindowsScrollBarUI -com/sun/java/swing/plaf/windows/WindowsScrollBarUI$Grid -com/sun/java/swing/plaf/windows/WindowsScrollBarUI$WindowsArrowButton -com/sun/java/swing/plaf/windows/WindowsComboBoxUI -com/sun/java/swing/plaf/windows/WindowsComboBoxUI$1 -com/sun/java/swing/plaf/windows/WindowsComboBoxUI$2 -com/sun/java/swing/plaf/windows/XPStyle$XPStatefulFillBorder -com/sun/java/swing/plaf/windows/WindowsComboBoxUI$WindowsComboBoxEditor -com/sun/java/swing/plaf/windows/WindowsTextFieldUI -com/sun/java/swing/plaf/windows/WindowsTextFieldUI$WindowsFieldCaret -com/sun/java/swing/plaf/windows/WindowsComboBoxUI$XPComboBoxButton -com/sun/java/swing/plaf/windows/XPStyle$GlyphButton -com/sun/java/swing/plaf/windows/WindowsComboBoxUI$3 -com/sun/java/swing/plaf/windows/WindowsToolBarUI -com/sun/java/swing/plaf/windows/WindowsBorders -com/sun/java/swing/plaf/windows/WindowsBorders$ToolBarBorder -com/sun/java/swing/plaf/windows/WindowsToolBarSeparatorUI -com/sun/java/swing/plaf/windows/WindowsGraphicsUtils -sun/awt/image/BufferedImageGraphicsConfig -sun/reflect/SerializationConstructorAccessorImpl -java/io/ObjectStreamClass$3 -java/io/ObjectOutputStream$BlockDataOutputStream -java/io/ObjectOutputStream$HandleTable -java/security/PrivateKey -java/security/spec/AlgorithmParameterSpec -sun/applet/Main -sun/applet/AppletMessageHandler -sun/applet/resources/MsgAppletViewer -sun/applet/AppletSecurity -sun/awt/AWTSecurityManager -java/lang/SecurityManager -java/security/DomainCombiner -sun/applet/AppletSecurity$1 -java/lang/SecurityManager$1 -sun/net/InetAddressCachePolicy -java/security/SecurityPermission -java/util/PropertyPermission -sun/applet/AppletViewer -java/applet/AppletContext -java/awt/print/Printable -sun/security/util/SecurityConstants -java/awt/AWTPermission -java/net/NetPermission -java/net/SocketPermission -javax/security/auth/AuthPermission -java/lang/Thread$1 -java/util/logging/LogManager$5 -sun/applet/StdAppletViewerFactory -sun/applet/AppletViewerFactory -sun/applet/AppletViewer$UserActionListener -sun/applet/AppletViewerPanel -sun/applet/AppletPanel -java/applet/AppletStub -sun/misc/MessageUtils -sun/applet/AppletPanel$10 -java/security/Policy$1 -sun/security/provider/PolicyFile$1 -sun/security/provider/PolicyFile$3 -sun/security/util/PropertyExpander -sun/security/provider/PolicyParser -sun/security/util/PolicyUtil -java/io/StreamTokenizer -sun/security/provider/PolicyParser$GrantEntry -sun/security/provider/PolicyParser$PermissionEntry -sun/security/provider/PolicyFile$PolicyEntry -sun/security/provider/PolicyParser$ParsingException -sun/security/provider/PolicyFile$6 -sun/security/provider/PolicyFile$7 -java/net/SocketPermissionCollection -java/util/PropertyPermissionCollection -sun/applet/AppletPanel$9 -sun/applet/AppletClassLoader -sun/applet/AppletThreadGroup -sun/applet/AppContextCreator -sun/applet/AppletPanel$1 -sun/awt/AppContext$3 -sun/awt/windows/WMenuBarPeer -java/awt/peer/MenuBarPeer -java/awt/peer/MenuComponentPeer -sun/awt/windows/WMenuPeer -java/awt/peer/MenuPeer -java/awt/peer/MenuItemPeer -sun/awt/windows/WMenuItemPeer -sun/awt/windows/WMenuItemPeer$2 -sun/awt/windows/awtLocalization -sun/awt/windows/WFontMetrics -sun/applet/AppletViewer$1 -sun/applet/AppletViewer$1AppletEventListener -sun/applet/AppletListener -sun/applet/AppletEventMulticaster -sun/awt/CausedFocusEvent -sun/misc/Queue -sun/misc/QueueElement -sun/applet/AppletEvent -sun/applet/AppletClassLoader$1 -java/net/URLClassLoader$4 -sun/applet/AppletClassLoader$2 -javax/swing/JApplet -java/lang/ClassLoader$1 -sun/security/provider/PolicyFile$5 -java/security/PermissionsEnumerator -java/util/Collections$1 -sun/applet/AppletPanel$11 -javax/swing/SwingHeavyWeight -sun/applet/AppletPanel$8 -sun/applet/AppletPanel$2 -sun/applet/AppletPanel$3 -sun/applet/AppletPanel$6 -java/beans/PropertyVetoException -javax/swing/BufferStrategyPaintManager$BufferInfo -javax/swing/BufferStrategyPaintManager$1 -sun/java2d/opengl/WGLGraphicsConfig -# dabe0c65d3c79925 +sun/security/provider/DSA$LegacyDSA +sun/security/provider/DSA$SHA1withDSA +sun/security/provider/DSAParameters +sun/security/provider/DSAPublicKey +sun/security/provider/DigestBase +sun/security/provider/NativePRNG +sun/security/provider/NativePRNG$Blocking +sun/security/provider/NativePRNG$NonBlocking +sun/security/provider/SHA +sun/security/provider/Sun +sun/security/provider/SunEntries +sun/security/provider/SunEntries$1 +sun/security/util/ByteArrayLexOrder +sun/security/util/ByteArrayTagOrder +sun/security/util/Debug +sun/security/util/DerEncoder +sun/security/util/DerIndefLenConverter +sun/security/util/DerInputBuffer +sun/security/util/DerInputStream +sun/security/util/DerOutputStream +sun/security/util/DerValue +sun/security/util/ManifestEntryVerifier +sun/security/util/ObjectIdentifier +sun/security/util/SignatureFileVerifier +sun/security/x509/AlgorithmId +sun/security/x509/X509Key +sun/swing/DefaultLookup +sun/swing/ImageIconUIResource +sun/swing/JLightweightFrame +sun/swing/MenuItemLayoutHelper +sun/swing/MenuItemLayoutHelper$ColumnAlignment +sun/swing/MenuItemLayoutHelper$LayoutResult +sun/swing/MenuItemLayoutHelper$RectSize +sun/swing/PrintColorUIResource +sun/swing/StringUIClientPropertyKey +sun/swing/SwingAccessor +sun/swing/SwingAccessor$JTextComponentAccessor +sun/swing/SwingLazyValue +sun/swing/SwingLazyValue$1 +sun/swing/SwingUtilities2 +sun/swing/SwingUtilities2$2 +sun/swing/SwingUtilities2$AATextInfo +sun/swing/SwingUtilities2$LSBCacheEntry +sun/swing/UIAction +sun/swing/UIClientPropertyKey +sun/swing/table/DefaultTableCellHeaderRenderer +sun/swing/table/DefaultTableCellHeaderRenderer$EmptyIcon +sun/text/ComposedCharIter +sun/text/IntHashtable +sun/text/UCompactIntArray +sun/text/normalizer/CharTrie +sun/text/normalizer/CharTrie$FriendAgent +sun/text/normalizer/ICUBinary +sun/text/normalizer/ICUBinary$Authenticate +sun/text/normalizer/ICUData +sun/text/normalizer/IntTrie +sun/text/normalizer/NormalizerDataReader +sun/text/normalizer/NormalizerImpl +sun/text/normalizer/NormalizerImpl$AuxTrieImpl +sun/text/normalizer/NormalizerImpl$DecomposeArgs +sun/text/normalizer/NormalizerImpl$FCDTrieImpl +sun/text/normalizer/NormalizerImpl$NormTrieImpl +sun/text/normalizer/Trie +sun/text/normalizer/Trie$DataManipulate +sun/text/normalizer/UTF16 +sun/text/normalizer/UnicodeMatcher +sun/text/normalizer/UnicodeSet +sun/text/resources/CollationData +sun/text/resources/FormatData +sun/text/resources/en/FormatData_en +sun/text/resources/en/FormatData_en_US +sun/util/CoreResourceBundleControl +sun/util/PreHashedMap +sun/util/ResourceBundleEnumeration +sun/util/calendar/AbstractCalendar +sun/util/calendar/BaseCalendar +sun/util/calendar/BaseCalendar$Date +sun/util/calendar/CalendarDate +sun/util/calendar/CalendarSystem +sun/util/calendar/CalendarUtils +sun/util/calendar/Gregorian +sun/util/calendar/Gregorian$Date +sun/util/calendar/ZoneInfo +sun/util/calendar/ZoneInfoFile +sun/util/calendar/ZoneInfoFile$1 +sun/util/calendar/ZoneInfoFile$Checksum +sun/util/calendar/ZoneInfoFile$ZoneOffsetTransitionRule +sun/util/locale/BaseLocale +sun/util/locale/BaseLocale$Cache +sun/util/locale/BaseLocale$Key +sun/util/locale/InternalLocaleBuilder +sun/util/locale/InternalLocaleBuilder$CaseInsensitiveChar +sun/util/locale/LanguageTag +sun/util/locale/LocaleObjectCache +sun/util/locale/LocaleObjectCache$CacheEntry +sun/util/locale/LocaleUtils +sun/util/locale/ParseStatus +sun/util/locale/StringTokenIterator +sun/util/locale/provider/AuxLocaleProviderAdapter +sun/util/locale/provider/AuxLocaleProviderAdapter$NullProvider +sun/util/locale/provider/AvailableLanguageTags +sun/util/locale/provider/CalendarDataProviderImpl +sun/util/locale/provider/CalendarDataUtility +sun/util/locale/provider/CalendarDataUtility$CalendarWeekParameterGetter +sun/util/locale/provider/CalendarProviderImpl +sun/util/locale/provider/CollatorProviderImpl +sun/util/locale/provider/CurrencyNameProviderImpl +sun/util/locale/provider/DateFormatSymbolsProviderImpl +sun/util/locale/provider/DecimalFormatSymbolsProviderImpl +sun/util/locale/provider/JRELocaleProviderAdapter +sun/util/locale/provider/JRELocaleProviderAdapter$1 +sun/util/locale/provider/LocaleDataMetaInfo +sun/util/locale/provider/LocaleProviderAdapter +sun/util/locale/provider/LocaleProviderAdapter$1 +sun/util/locale/provider/LocaleProviderAdapter$Type +sun/util/locale/provider/LocaleResources +sun/util/locale/provider/LocaleResources$ResourceReference +sun/util/locale/provider/LocaleServiceProviderPool +sun/util/locale/provider/LocaleServiceProviderPool$LocalizedObjectGetter +sun/util/locale/provider/NumberFormatProviderImpl +sun/util/locale/provider/ResourceBundleBasedAdapter +sun/util/locale/provider/SPILocaleProviderAdapter +sun/util/locale/provider/SPILocaleProviderAdapter$1 +sun/util/locale/provider/TimeZoneNameProviderImpl +sun/util/locale/provider/TimeZoneNameUtility +sun/util/locale/provider/TimeZoneNameUtility$TimeZoneNameGetter +sun/util/logging/LoggingProxy +sun/util/logging/LoggingSupport +sun/util/logging/LoggingSupport$1 +sun/util/logging/LoggingSupport$2 +sun/util/logging/PlatformLogger +sun/util/logging/PlatformLogger$1 +sun/util/logging/PlatformLogger$DefaultLoggerProxy +sun/util/logging/PlatformLogger$JavaLoggerProxy +sun/util/logging/PlatformLogger$Level +sun/util/logging/PlatformLogger$LoggerProxy +sun/util/logging/resources/logging +sun/util/resources/CalendarData +sun/util/resources/CurrencyNames +sun/util/resources/LocaleData +sun/util/resources/LocaleData$1 +sun/util/resources/LocaleData$LocaleDataResourceBundleControl +sun/util/resources/LocaleNamesBundle +sun/util/resources/OpenListResourceBundle +sun/util/resources/ParallelListResourceBundle +sun/util/resources/ParallelListResourceBundle$KeySet +sun/util/resources/TimeZoneNames +sun/util/resources/TimeZoneNamesBundle +sun/util/resources/en/CalendarData_en +sun/util/resources/en/CurrencyNames_en_US +sun/util/resources/en/TimeZoneNames_en +sun/util/spi/CalendarProvider +# 729efa63b41fc759 diff --git a/jdk/makefiles/CompileDemos.gmk b/jdk/makefiles/CompileDemos.gmk index beef573275c..ef7ae5a4721 100644 --- a/jdk/makefiles/CompileDemos.gmk +++ b/jdk/makefiles/CompileDemos.gmk @@ -1,6 +1,6 @@ # -# Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved. # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. # # This code is free software; you can redistribute it and/or modify it @@ -56,25 +56,27 @@ define SetupAppletDemo BUILD_DEMOS += $$(BUILD_DEMO_APPLET_$1) endef -$(eval $(call SetupAppletDemo,ArcTest)) -$(eval $(call SetupAppletDemo,BarChart)) -$(eval $(call SetupAppletDemo,Blink)) -$(eval $(call SetupAppletDemo,CardTest)) -$(eval $(call SetupAppletDemo,Clock)) -$(eval $(call SetupAppletDemo,DitherTest)) -$(eval $(call SetupAppletDemo,DrawTest)) -$(eval $(call SetupAppletDemo,Fractal)) -$(eval $(call SetupAppletDemo,GraphicsTest)) -$(eval $(call SetupAppletDemo,NervousText)) -$(eval $(call SetupAppletDemo,SimpleGraph)) -$(eval $(call SetupAppletDemo,SortDemo)) -$(eval $(call SetupAppletDemo,SpreadSheet)) +ifneq ($(OPENJDK_TARGET_OS), solaris) + $(eval $(call SetupAppletDemo,ArcTest)) + $(eval $(call SetupAppletDemo,BarChart)) + $(eval $(call SetupAppletDemo,Blink)) + $(eval $(call SetupAppletDemo,CardTest)) + $(eval $(call SetupAppletDemo,Clock)) + $(eval $(call SetupAppletDemo,DitherTest)) + $(eval $(call SetupAppletDemo,DrawTest)) + $(eval $(call SetupAppletDemo,Fractal)) + $(eval $(call SetupAppletDemo,GraphicsTest)) + $(eval $(call SetupAppletDemo,NervousText)) + $(eval $(call SetupAppletDemo,SimpleGraph)) + $(eval $(call SetupAppletDemo,SortDemo)) + $(eval $(call SetupAppletDemo,SpreadSheet)) -ifndef OPENJDK - $(eval $(call SetupAppletDemo,Animator,,closed/)) - $(eval $(call SetupAppletDemo,GraphLayout,true,closed/)) - $(eval $(call SetupAppletDemo,JumpingBox,,closed/)) - $(eval $(call SetupAppletDemo,TicTacToe,,closed/)) + ifndef OPENJDK + $(eval $(call SetupAppletDemo,Animator,,closed/)) + $(eval $(call SetupAppletDemo,GraphLayout,true,closed/)) + $(eval $(call SetupAppletDemo,JumpingBox,,closed/)) + $(eval $(call SetupAppletDemo,TicTacToe,,closed/)) + endif endif ################################################################################################## @@ -157,14 +159,16 @@ $(JDK_OUTPUTDIR)/demo/jfc/CodePointIM/_the.services: \ BUILD_DEMOS += $(JDK_OUTPUTDIR)/demo/jfc/CodePointIM/_the.services -$(eval $(call SetupDemo,MoleculeViewer,applets,,XYZChemModel,,,example*.html *.java)) -$(eval $(call SetupDemo,WireFrame,applets,,ThreeD,,,example*.html *.java)) +ifneq ($(OPENJDK_TARGET_OS), solaris) + $(eval $(call SetupDemo,MoleculeViewer,applets,,XYZChemModel,,,example*.html *.java)) + $(eval $(call SetupDemo,WireFrame,applets,,ThreeD,,,example*.html *.java)) + $(eval $(call SetupDemo,SwingApplet,jfc,,SwingApplet,,,README* *.html)) +endif $(eval $(call SetupDemo,FileChooserDemo,jfc,,FileChooserDemo,,,README*)) $(eval $(call SetupDemo,Font2DTest,jfc,,Font2DTest,,,*.html *.txt)) $(eval $(call SetupDemo,Metalworks,jfc,,Metalworks,,,README*)) $(eval $(call SetupDemo,Notepad,jfc,,Notepad,,,README*)) $(eval $(call SetupDemo,SampleTree,jfc,,SampleTree,,,README*)) -$(eval $(call SetupDemo,SwingApplet,jfc,,SwingApplet,,,README* *.html)) $(eval $(call SetupDemo,TableExample,jfc,,TableExample,,,README*)) $(eval $(call SetupDemo,TransparentRuler,jfc,,transparentruler.Ruler,,,README*)) $(eval $(call SetupDemo,jconsole-plugin,scripting,,,,,*.xml *.txt,,,,Main-Class: \n)) @@ -180,7 +184,7 @@ ifndef OPENJDK $(eval $(call SetupDemo,Java2D,jfc,,java2d.Java2Demo,,closed/,*.html README*,Java2Demo)) $(eval $(call SetupDemo,Stylepad,jfc,,Stylepad, \ - $(JDK_TOPDIR)/src/share/demo/jfc/Notepad,closed/,*.txt,,$(JDK_TOPDIR)/src/share/demo/jfc/Notepad/README.txt)) + $(JDK_TOPDIR)/src/share/demo/jfc/Notepad,closed/,*.txt,,$(JDK_TOPDIR)/src/share/demo/jfc/Notepad/README.txt)) $(eval $(call SetupDemo,SwingSet2,jfc,,SwingSet2,,closed/,README* *.html,,,.java COPYRIGHT, \ SplashScreen-Image: resources/images/splash.png,true)) @@ -191,6 +195,9 @@ ifndef OPENJDK $(JDK_OUTPUTDIR)/demo/nbproject/%: $(JDK_TOPDIR)/src/closed/share/demo/nbproject/% $(call install-file) $(CHMOD) -f ug+w $@ + ifeq ($(OPENJDK_TARGET_OS), solaris) + $(RM) -r $(JDK_OUTPUTDIR)/demo/nbproject/jfc/SwingApplet + endif endif ################################################################################################## diff --git a/jdk/makefiles/lib/CoreLibraries.gmk b/jdk/makefiles/lib/CoreLibraries.gmk index 29c1d5fc08a..b773af13fda 100644 --- a/jdk/makefiles/lib/CoreLibraries.gmk +++ b/jdk/makefiles/lib/CoreLibraries.gmk @@ -115,7 +115,6 @@ BUILD_LIBRARIES += $(BUILD_LIBVERIFY) LIBJAVA_SRC_DIRS := $(JDK_TOPDIR)/src/$(OPENJDK_TARGET_OS_API_DIR)/native/java/lang \ $(JDK_TOPDIR)/src/share/native/java/lang \ - $(JDK_TOPDIR)/src/share/native/java/lang/ref \ $(JDK_TOPDIR)/src/share/native/java/lang/reflect \ $(JDK_TOPDIR)/src/share/native/java/io \ $(JDK_TOPDIR)/src/$(OPENJDK_TARGET_OS_API_DIR)/native/java/io \ diff --git a/jdk/makefiles/lib/ServiceabilityLibraries.gmk b/jdk/makefiles/lib/ServiceabilityLibraries.gmk index 0cc5ad96a88..d408eb36dea 100644 --- a/jdk/makefiles/lib/ServiceabilityLibraries.gmk +++ b/jdk/makefiles/lib/ServiceabilityLibraries.gmk @@ -275,19 +275,12 @@ BUILD_LIBRARIES += $(BUILD_LIBINSTRUMENT) ########################################################################################## BUILD_LIBMANAGEMENT_SRC := $(JDK_TOPDIR)/src/share/native/sun/management \ - $(JDK_TOPDIR)/src/$(OPENJDK_TARGET_OS_API_DIR)/native/sun/management \ - $(JDK_TOPDIR)/src/$(OPENJDK_TARGET_OS_API_DIR)/native/com/sun/management + $(JDK_TOPDIR)/src/$(OPENJDK_TARGET_OS_API_DIR)/native/sun/management BUILD_LIBMANAGEMENT_EXCLUDES := BUILD_LIBMANAGEMENT_CFLAGS := -I$(JDK_TOPDIR)/src/share/native/sun/management -ifneq ($(OPENJDK_TARGET_OS), windows) - BUILD_LIBMANAGEMENT_EXCLUDES += OperatingSystem_md.c -else - BUILD_LIBMANAGEMENT_EXCLUDES += UnixOperatingSystem_md.c -endif - ifneq ($(OPENJDK_TARGET_OS), solaris) BUILD_LIBMANAGEMENT_EXCLUDES += SolarisOperatingSystem.c endif diff --git a/jdk/makefiles/mapfiles/libjava/mapfile-vers b/jdk/makefiles/mapfiles/libjava/mapfile-vers index 7b4d5472b14..d2d8067395c 100644 --- a/jdk/makefiles/mapfiles/libjava/mapfile-vers +++ b/jdk/makefiles/mapfiles/libjava/mapfile-vers @@ -140,7 +140,6 @@ SUNWprivate_1.1 { Java_java_lang_Double_doubleToRawLongBits; Java_java_lang_reflect_Proxy_defineClass0; Java_java_lang_Shutdown_runAllFinalizers; - Java_java_lang_ref_Finalizer_invokeFinalizeMethod; Java_java_lang_Float_intBitsToFloat; Java_java_lang_Float_floatToRawIntBits; Java_java_lang_StrictMath_IEEEremainder; diff --git a/jdk/makefiles/mapfiles/libjava/reorder-sparc b/jdk/makefiles/mapfiles/libjava/reorder-sparc index 16573052576..4a5cbf45018 100644 --- a/jdk/makefiles/mapfiles/libjava/reorder-sparc +++ b/jdk/makefiles/mapfiles/libjava/reorder-sparc @@ -88,7 +88,6 @@ text: .text%Java_java_lang_Throwable_getStackTraceElement; text: .text%throwFileNotFoundException; text: .text%JNU_NotifyAll; # Test LoadFrame -text: .text%Java_java_lang_ref_Finalizer_invokeFinalizeMethod; text: .text%JNU_CallMethodByName; text: .text%JNU_CallMethodByNameV; text: .text%Java_java_io_UnixFileSystem_createDirectory; diff --git a/jdk/makefiles/mapfiles/libjava/reorder-sparcv9 b/jdk/makefiles/mapfiles/libjava/reorder-sparcv9 index fe80fca8b59..81cbfcb2410 100644 --- a/jdk/makefiles/mapfiles/libjava/reorder-sparcv9 +++ b/jdk/makefiles/mapfiles/libjava/reorder-sparcv9 @@ -78,7 +78,6 @@ text: .text%writeBytes; text: .text%Java_java_security_AccessController_doPrivileged__Ljava_security_PrivilegedAction_2Ljava_security_AccessControlContext_2; text: .text%JNU_GetEnv; text: .text%Java_java_io_UnixFileSystem_checkAccess; -text: .text%Java_java_lang_ref_Finalizer_invokeFinalizeMethod; text: .text%Java_java_lang_reflect_Array_newArray; text: .text%Java_java_lang_Throwable_getStackTraceDepth; text: .text%Java_java_lang_Throwable_getStackTraceElement; diff --git a/jdk/makefiles/mapfiles/libjava/reorder-x86 b/jdk/makefiles/mapfiles/libjava/reorder-x86 index 839ee50caa8..1c971b80eda 100644 --- a/jdk/makefiles/mapfiles/libjava/reorder-x86 +++ b/jdk/makefiles/mapfiles/libjava/reorder-x86 @@ -78,7 +78,6 @@ text: .text%Java_java_security_AccessController_doPrivileged__Ljava_security_Pri text: .text%JNU_GetEnv; text: .text%Java_java_io_UnixFileSystem_checkAccess; text: .text%Java_sun_reflect_NativeMethodAccessorImpl_invoke0; -text: .text%Java_java_lang_ref_Finalizer_invokeFinalizeMethod; text: .text%Java_java_io_FileInputStream_available; text: .text%Java_java_lang_reflect_Array_newArray; text: .text%Java_java_lang_Throwable_getStackTraceDepth; diff --git a/jdk/makefiles/mapfiles/libmanagement/mapfile-vers b/jdk/makefiles/mapfiles/libmanagement/mapfile-vers index 724f7bb7100..218dd3e3e71 100644 --- a/jdk/makefiles/mapfiles/libmanagement/mapfile-vers +++ b/jdk/makefiles/mapfiles/libmanagement/mapfile-vers @@ -27,17 +27,17 @@ SUNWprivate_1.1 { global: - Java_com_sun_management_UnixOperatingSystem_getCommittedVirtualMemorySize; - Java_com_sun_management_UnixOperatingSystem_getFreePhysicalMemorySize; - Java_com_sun_management_UnixOperatingSystem_getFreeSwapSpaceSize; - Java_com_sun_management_UnixOperatingSystem_getMaxFileDescriptorCount; - Java_com_sun_management_UnixOperatingSystem_getOpenFileDescriptorCount; - Java_com_sun_management_UnixOperatingSystem_getProcessCpuLoad; - Java_com_sun_management_UnixOperatingSystem_getProcessCpuTime; - Java_com_sun_management_UnixOperatingSystem_getSystemCpuLoad; - Java_com_sun_management_UnixOperatingSystem_getTotalPhysicalMemorySize; - Java_com_sun_management_UnixOperatingSystem_getTotalSwapSpaceSize; - Java_com_sun_management_UnixOperatingSystem_initialize; + Java_sun_management_OperatingSystemImpl_getCommittedVirtualMemorySize; + Java_sun_management_OperatingSystemImpl_getFreePhysicalMemorySize; + Java_sun_management_OperatingSystemImpl_getFreeSwapSpaceSize; + Java_sun_management_OperatingSystemImpl_getMaxFileDescriptorCount; + Java_sun_management_OperatingSystemImpl_getOpenFileDescriptorCount; + Java_sun_management_OperatingSystemImpl_getProcessCpuLoad; + Java_sun_management_OperatingSystemImpl_getProcessCpuTime; + Java_sun_management_OperatingSystemImpl_getSystemCpuLoad; + Java_sun_management_OperatingSystemImpl_getTotalPhysicalMemorySize; + Java_sun_management_OperatingSystemImpl_getTotalSwapSpaceSize; + Java_sun_management_OperatingSystemImpl_initialize; Java_sun_management_ClassLoadingImpl_setVerboseClass; Java_sun_management_DiagnosticCommandImpl_executeDiagnosticCommand; Java_sun_management_DiagnosticCommandImpl_getDiagnosticCommands; @@ -103,6 +103,7 @@ SUNWprivate_1.1 { Java_sun_management_VMManagementImpl_getSafepointCount; Java_sun_management_VMManagementImpl_getSafepointSyncTime; Java_sun_management_VMManagementImpl_getStartupTime; + Java_sun_management_VMManagementImpl_getUptime0; Java_sun_management_VMManagementImpl_getTotalApplicationNonStoppedTime; Java_sun_management_VMManagementImpl_getTotalClassCount; Java_sun_management_VMManagementImpl_getTotalCompileTime; diff --git a/jdk/src/bsd/doc/man/appletviewer.1 b/jdk/src/bsd/doc/man/appletviewer.1 index 88031b783df..71ccac3c664 100644 --- a/jdk/src/bsd/doc/man/appletviewer.1 +++ b/jdk/src/bsd/doc/man/appletviewer.1 @@ -1,66 +1,90 @@ -." Copyright (c) 1995, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH appletviewer 1 "10 May 2011" +'\" t +.\" Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: appletviewer.1 +.\" +.if n .pl 99999 +.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -appletviewer \- The Java Applet Viewer. -.LP -.LP -The \f3appletviewer\fP command allows you to run applets outside of a web browser. -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4appletviewer\fP \f2[\fP \f2options\fP \f2] \fP\f2urls\fP ... -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3appletviewer\fP command connects to the documents or resources designated by \f2urls\fP and displays each applet referenced by the documents in its own window. Note: if the documents referred to by \f2urls\fP do not reference any applets with the \f2OBJECT\fP, \f2EMBED\fP, or \f2APPLET\fP tag, then \f3appletviewer\fP does nothing. For details on the HTML tags that \f3appletviewer\fP supports, see -.na -\f2AppletViewer Tags\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/appletviewertags.html. -.LP -.LP -\f3Note:\fP The \f3appletviewer\fP requires encoded URLs according to the escaping mechanism defined in RFC2396. Only encoded URLs are supported. However, file names must be unencoded, as specified in RFC2396. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-debug -Starts the applet viewer in the Java debugger, jdb(1), thus allowing you to debug the applets in the document. -.TP 3 -\-encoding \ \ encoding name -Specify the input HTML file encoding name. -.TP 3 -\-Jjavaoption -Passes through the string \f2javaoption\fP as a single argument to the Java interpreter which runs the appletviewer. The argument should not contain spaces. Multiple argument words must all begin with the prefix \f3\-J\fP, which is stripped. This is useful for adjusting the compiler's execution environment or memory usage. -.RE - -.LP -.LP - -.LP +.SH NAME +appletviewer \- Runs applets outside of a web browser\&. +.SH SYNOPSIS +.sp +.nf +\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options separated by spaces\&. See Options\&. +.TP +\fIurl\fR +The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. +.SH DESCRIPTION +The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html +.PP +The \f3appletviewer\fR command requires encoded URLs according to the escaping mechanism defined in RFC2396\&. Only encoded URLs are supported\&. However, file names must be unencoded, as specified in RFC2396\&. +.PP +\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html +.SH OPTIONS +.TP +-debug +.br +Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. +.TP +-encoding \fIencoding-name\fR +.br +Specifies the input HTML file encoding name\&. +.TP +-J\fIjavaoption\fR +.br +Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. +.PP +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/extcheck.1 b/jdk/src/bsd/doc/man/extcheck.1 index 91a8fdce998..09599d3aa02 100644 --- a/jdk/src/bsd/doc/man/extcheck.1 +++ b/jdk/src/bsd/doc/man/extcheck.1 @@ -1,73 +1,91 @@ -." Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH extcheck 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: extcheck.1 +.\" +.if n .pl 99999 +.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -extcheck \- A utility to detect jar conflicts -.LP -.LP -\f3extcheck\fP detects version conflicts between a target jar file and currently installed extension jar files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -extcheck [ \-verbose ] targetfile.jar -.fl -\fP -.fi +.SH NAME +extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3extcheck\fP utility checks a specified Jar file for title and version conflicts with any extensions installed in the Java(TM) SDK. Before installing an extension, you can use this utility to see if the same or a more recent version of the extension is already installed. -.LP -.LP -The \f3extcheck\fP utility compares the \f2Specification\-title\fP and \f2Specification\-version\fP headers in the manifest of the \f2targetfile.jar\fP file against the corresponding headers in all Jar files currently installed in the extension directory. (The extension directory is \f2jre/lib/ext\fP by default.) The \f3extcheck\fP utility compares version numbers in the same way as the method \f2java.lang.Package.isCompatibleWith\fP. -.LP -.LP -If no conflict is detected, the return code is \f20\fP. -.LP -.LP -If the manifest of any jar file in the extensions directory has the same \f2Specification\-title\fP and the same or a newer \f2Specification\-version\fP number, a non\-zero error code is returned. A non\-zero error code is also returned if \f2targetfile.jar\fP does not have the \f2Specification\-title\fP or \f2Specification\-version\fP attributes in its manifest. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-verbose -Lists Jar files in the extension directory as they are checked. Additionally, manifest attributes of the target jar file and any conflicting jar files are also reported. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP +\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fItargetfile\&.jar\fR +The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. +.SH DESCRIPTION +The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. +.PP +The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. +.PP +If no conflict is detected, then the return code is 0\&. +.PP +If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. +.SH OPTIONS +.TP +-verbose +.br +Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. +.TP +-J\fIoption\fR +.br +Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu jar(1) -.LP - +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/idlj.1 b/jdk/src/bsd/doc/man/idlj.1 index 9b80d7b145d..01130581906 100644 --- a/jdk/src/bsd/doc/man/idlj.1 +++ b/jdk/src/bsd/doc/man/idlj.1 @@ -1,739 +1,568 @@ -." Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH idlj 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: idlj.1 +.\" +.if n .pl 99999 +.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -idlj \- The IDL\-to\-Java Compiler -.LP -\f3idlj\fP generates Java bindings from a given IDL file. -.SH "Synopsis" -.LP -.nf -\f3 -.fl -idlj [ \fP\f3options\fP\f3 ] \fP\f4idl\-file\fP\f3 -.fl -\fP -.fi +.SH NAME +idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -where \f2idl\-file\fP is the name of a file containing Interface Definition Language (IDL) definitions. \f2Options\fP may appear in any order, but must precede the \f2idl\-file\fP. -.LP -.SH "Description" -.LP -.LP -The IDL\-to\-Java Compiler generates the Java bindings for a given IDL file.\ For binding details, see the -.na -\f2OMG IDL to Java Language Language Mapping Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP. -.LP -.SS -Emitting Client and Server Bindings -.LP -.LP -To generate Java bindings for an IDL file named My.idl: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -This generates the client\-side bindings and is equivalent to: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient\fP My.idl -.fl -.fi - -.LP -.LP -The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fserver\fP My.idl -.fl -.fi - -.LP -.LP -Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient \-fserver\fP My.idl -.fl -idlj \f3\-fall\fP My.idl -.fl -.fi - -.LP -.LP -There are two possible server\-side models: the Inheritance Model and the Tie Delegation Model. -.LP -.LP -The default server\-side model is the \f2Portable Servant Inheritance Model\fP. Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2MyPOA.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2MyPOA\fP. -.LP -.LP -\f2MyPOA.java\fP is a stream\-based skeleton that extends -.na -\f2org.omg.PortableServer.Servant\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements. -.LP -.LP -The \f2PortableServer\fP module for the -.na -\f2Portable Object Adapter (POA)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. -.LP -.LP -Another option for the Inheritance Model is to use the \f2\-oldImplBase\fP flag in order to generate server\-side bindings that are compatible with versions of the Java programming language prior to J2SE 1.4. Note that using the \f2\-oldImplBase\fP flag is non\-standard: these APIs are being deprecated. You would use this flag ONLY for compatibility with existing servers written in J2SE 1.3. In that case, you would need to modify an existing MAKEFILE to add the \f2\-oldImplBase\fP flag to the \f2idlj\fP compiler, otherwise POA\-based server\-side mappings will be generated. To generate server\-side bindings that are backwards compatible: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient \-fserver\fP \f3\-oldImplBase\fP My.idl -.fl -idlj \f3\-fall\fP \f3\-oldImplBase\fP My.idl -.fl -.fi - -.LP -.LP -Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP. -.LP -.LP -The other server\-side model is called the Tie Model. This is a delegation model. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately. The following commands generate the bindings for the Tie Model: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fall\fP My.idl -.fl -idlj \f3\-fallTIE\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance: -.LP -.nf -\f3 -.fl - ORB orb = ORB.init(args, System.getProperties()); -.fl - -.fl - // Get reference to rootpoa & activate the POAManager -.fl - POA rootpoa = (POA)orb.resolve_initial_references("RootPOA"); -.fl - rootpoa.the_POAManager().activate(); -.fl - -.fl - // create servant and register it with the ORB -.fl - MyServant myDelegate = new MyServant(); -.fl - myDelegate.setORB(orb); -.fl - -.fl - // create a tie, with servant being the delegate. -.fl - MyPOATie tie = new MyPOATie(myDelegate, rootpoa); -.fl - -.fl - // obtain the objectRef for the tie -.fl - My ref = tie._this(orb); -.fl -\fP -.fi - -.LP -.LP -You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method. -.LP -.LP -To generate server\-side, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions prior to J2SE 1.4. -.LP -.nf -\f3 -.fl -idlj \fP\f3\-oldImplBase\fP \f3\-fall\fP My.idl -.fl -idlj \f3\-oldImplBase\fP \f3\-fallTIE\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructor to \f2My_Tie\fP takes a \f2impl\fP. You must provide the implementation for \f2impl\fP, but it does not have to inherit from any other class, only the interface \f2HelloOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2My_Tie\fP. For instance: -.LP -.nf -\f3 -.fl - ORB orb = ORB.init(args, System.getProperties()); -.fl - -.fl - // create servant and register it with the ORB -.fl - MyServant myDelegate = new MyServant(); -.fl - myDelegate.setORB(orb); -.fl - -.fl - // create a tie, with servant being the delegate. -.fl - MyPOATie tie = new MyPOATie(myDelegate); -.fl - -.fl - // obtain the objectRef for the tie -.fl - My ref = tie._this(orb); -.fl -\fP -.fi - -.LP -.SS -Specifying Alternate Locations for Emitted Files -.LP -.LP -If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-td /altdir\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, the bindings will be emitted to \f2/altdir/My.java\fP, etc., instead of \f2./My.java\fP. -.LP -.SS -Specifying Alternate Locations for Include Files -.LP -.LP -If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-i /includes\fP My.idl -.fl -.fi - -.LP -.LP -If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-i /includes \-i /moreIncludes\fP My.idl -.fl -.fi - -.LP -.LP -Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form: -.LP -.nf -\f3 -.fl -includes=/includes;/moreIncludes -.fl -\fP -.fi - -.LP -.LP -The compiler will find this file and read in the includes list. Note that in this example the separator character between the two directories is a semicolon (;). This separator character is platform dependent. On the Windows platform, use a semicolon, on the Unix platform, use a colon, etc. For more information on \f2includes\fP, see the -.na -\f2Setting the Classpath\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general. -.LP -.SS -Emitting Bindings for Include Files -.LP -.LP -By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files: -.LP - -.LP -.LP -\f4My.idl\fP -.LP -.nf -\f3 -.fl -#include -.fl -interface My -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4MyOther.idl\fP -.LP -.nf -\f3 -.fl -interface MyOther -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -The following command will only generate the java bindings for \f2My\fP: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-emitAll\fP My.idl -.fl -.fi - -.LP -.LP -There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example: -.LP - -.LP -.LP -\f4My.idl\fP -.LP -.nf -\f3 -.fl -#include -.fl -interface My -.fl -{ -.fl - #include -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4MyOther.idl\fP -.LP -.nf -\f3 -.fl -interface MyOther -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4Embedded.idl\fP -.LP -.nf -\f3 -.fl -enum E {one, two, three}; -.fl -\fP -.fi - -.LP - -.LP -.LP -Running the following command: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -will generate the following list of Java files: -.LP -.nf -\f3 -.fl -./MyHolder.java -.fl -./MyHelper.java -.fl -./_MyStub.java -.fl -./MyPackage -.fl -./MyPackage/EHolder.java -.fl -./MyPackage/EHelper.java -.fl -./MyPackage/E.java -.fl -./My.java -.fl -\fP -.fi - -.LP -.LP -Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP). -.LP -.LP -If the \f2\-emitAll\fP flag had been used in the previous example, then all types in all included files would be emitted. -.LP -.SS -Inserting Package Prefixes -.LP -.LP +\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. +.TP +\fIidlfile\fR +The name of a file that contains Interface Definition Language (IDL) definitions\&. +.SH DESCRIPTION +The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html +.PP +Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. +.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS +The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. +.sp +.nf +\f3idlj My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The previous syntax is equivalent to the following: +.sp +.nf +\f3idlj \-fclient My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. +.sp +.nf +\f3idlg \-fserver My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: +.sp +.nf +\f3idlj \-fclient \-fserver My\&.idl\fP +.fi +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. +.PP +\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: +.sp +.nf +\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP +.fi +.nf +\f3idlj \-fall \-oldImplBase My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. +.PP +\f3Tie Delegation Model\fR\&. The other server-side model is called the Tie Model\&. This is a delegation model\&. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately\&. The following commands generate the bindings for the Tie Model: +.sp +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// Get reference to rootpoa & activate the POAManager\fP +.fi +.nf +\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP +.fi +.nf +\f3rootpoa\&.the_POAManager()\&.activate();\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +You might want to use the Tie model instead of the typical Inheritance model when your implementation must inherit from some other implementation\&. Java allows any number of interface inheritance, but there is only one slot for class inheritance\&. If you use the inheritance model, then that slot is used up\&. With the Tie Model, that slot is freed up for your own use\&. The drawback is that it introduces a level of indirection: one extra method call occurs when a method is called\&. +.PP +For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. +.sp +.nf +\f3idlj \-oldImplBase \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES +If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. +.PP +For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES +If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Because this form of \f3include\fR can become long, another way to indicate to the compiler where to search for included files is provided\&. This technique is similar to the idea of an environment variable\&. Create a file named idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: +.sp +.nf +\f3includes=/includes;/moreIncludes\fP +.fi +.nf +\f3\fR +.fi +.sp +The compiler will find this file and read in the includes list\&. Note that in this example the separator character between the two directories is a semicolon (;)\&. This separator character is platform dependent\&. On the Windows platform, use a semicolon, on the Unix platform, use a colon, and so on\&. +.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES +By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR file on the command line have Java bindings generated for them\&. The types defined in included files are not generated\&. For example, assume the following two \f3idl\fR files: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include \fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include \fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 #include \fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3Embedded\&.idl\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3enum E {one, two, three};\fP +.fi +.nf +\f3\fR +.fi +.sp +Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. +.sp +.nf +\f3\&./MyHolder\&.java\fP +.fi +.nf +\f3\&./MyHelper\&.java\fP +.fi +.nf +\f3\&./_MyStub\&.java\fP +.fi +.nf +\f3\&./MyPackage\fP +.fi +.nf +\f3\&./MyPackage/EHolder\&.java\fP +.fi +.nf +\f3\&./MyPackage/EHelper\&.java\fP +.fi +.nf +\f3\&./MyPackage/E\&.java\fP +.fi +.nf +\f3\&./My\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS INSERT\ PACKAGE\ PREFIXES Suppose that you work for a company named ABC that has constructed the following IDL file: -.LP - -.LP -.LP -\f4Widgets.idl\fP -.LP -.nf -\f3 -.fl -module Widgets -.fl -{ -.fl - interface W1 {...}; -.fl - interface W2 {...}; -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-pkgPrefix Widgets com.abc\fP Widgets.idl -.fl -.fi - -.LP -.LP -If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package. -.LP -.LP -If you have a number of these packages that require prefixes, it might be easier to place them into the \f2idl.config\fP file described above. Each package prefix line should be of the form: -.LP -.nf -\f3 -.fl -PkgPrefix.= -.fl -\fP -.fi - -.LP -So the line for the above example would be: -.nf -\f3 -.fl -PkgPrefix.Widgets=com.abc -.fl -\fP -.fi - -.LP -.LP -The use of this option does not affect the Repository ID. -.LP -.SS -Defining Symbols Before Compilation -.LP -.LP -You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command -.LP -.nf -\f3 -.fl -idlj \fP\f3\-d\fP MYDEF My.idl -.fl -.fi - -.LP -.LP -is the equivalent of putting the line \f2#define MYDEF\fP inside \f2My.idl\fP. -.LP -.SS -Preserving Pre\-Existing Bindings -.LP -.LP -If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command -.LP -.nf -\f3 -.fl -idlj \fP\f3\-keep\fP My.idl -.fl -.fi - -.LP -.LP -emits all client\-side bindings that do not already exist. -.LP -.SS -Viewing Progress of Compilation -.LP -.LP -The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-v\fP My.idl -.fl -.fi - -.LP -.LP -By default the compiler does not operate in verbose mode. -.LP -.SS -Displaying Version Information -.LP -.LP -To display the build version of the IDL\-to\-Java compiler, specify the \f2\-version\fP option on the command\-line: -.LP -.nf -\f3 -.fl -idlj \-version -.fl -\fP -.fi - -.LP -.LP -Version information also appears within the bindings generated by the compiler. Any additional options appearing on the command\-line are ignored. -.LP -.SH "Options" -.LP -.RS 3 -.TP 3 -\-d symbol +.sp +.nf +\f3Widgets\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3module Widgets\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 interface W1 {\&.\&.\&.};\fP +.fi +.nf +\f3 interface W2 {\&.\&.\&.};\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: +.sp +.nf +\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. +.PP +If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.=\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. +.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION +You might need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings\&. The command \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. +.SS PRESERVE\ PREEXISTING\ BINDINGS +If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. +.SS VIEW\ COMPILATION\ PROGRESS +The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. +.PP +By default the compiler does not operate in verbose mode +.SS DISPLAY\ VERSION\ INFORMATION +To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. +.PP +Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. +.SH OPTIONS +.TP +-d \fIsymbol\fR +.br This is equivalent to the following line in an IDL file: -.nf -\f3 -.fl -#define \fP\f4symbol\fP\f3 -.fl -\fP -.fi -.TP 3 -\-emitAll -Emit all types, including those found in \f2#include\fP files. -.TP 3 -\-fside -Defines what bindings to emit. \f2side\fP is one of \f2client\fP, \f2server\fP, \f2serverTIE\fP, \f2all\fP, or \f2allTIE\fP. The \f2\-fserverTIE\fP and \f2\-fallTIE\fP options cause delegate model skeletons to be emitted. Assumes \f2\-fclient\fP if the flag is not specified. -.TP 3 -\-i include\-path -By default, the current directory is scanned for included files. This option adds another directory. -.TP 3 -\-keep -If a file to be generated already exists, do not overwrite it. By default it is overwritten. -.TP 3 -\-noWarn -Suppresses warning messages. -.TP 3 -\-oldImplBase -Generates skeletons compatible with pre\-1.4 JDK ORBs. By default, the POA Inheritance Model server\-side bindings are generated. This option provides backward\-compatibility with older versions of the Java programming language by generating server\-side bindings that are \f2ImplBase\fP Inheritance Model classes. -.TP 3 -\-pkgPrefix type prefix -Wherever \f2type\fP is encountered at file scope, prefix the generated Java package name with \f2prefix\fP for all files generated for that type. The \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module. -.TP 3 -\-pkgTranslate type package -Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly. +.sp +.nf +\f3#define \fIsymbol\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-demitAll .br +Emit all types, including those found in \f3#include\fR files\&. +.TP +-fside .br -If more than one translation matches an identifier, the longest match is chosen. For example, if the arguments include: -.nf -\f3 -.fl - \-pkgTranslate foo bar \-pkgTranslate foo.baz buzz.fizz -.fl -\fP -.fi -The following translations would occur: -.nf -\f3 -.fl -foo => bar -.fl -foo.boo => bar.boo -.fl -foo.baz => buzz.fizz -.fl -foo.baz.bar => buzz.fizz.bar -.fl -\fP -.fi -The following package names cannot be translated: -.RS 3 -.TP 2 -o -\f2org\fP -.TP 2 -o -\f2org.omg\fP or any subpackages of \f2org.omg\fP -.RE -Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error. -.TP 3 -\-skeletonName xxx%yyy -Use \f2xxx%yyy\fP as the pattern for naming the skeleton. The defaults are: -.RS 3 -.TP 2 -o -%POA for the \f2POA\fP base class (\f2\-fserver\fP or \f2\-fall\fP) -.TP 2 -o -_%ImplBase for the \f2oldImplBase\fP class (\f2\-oldImplBase\fP and (\f2\-fserver\fP or \f2\-fall\fP)) -.RE -.TP 3 -\-td dir -Use \f2dir\fP for the output directory instead of the current directory. -.TP 3 -\-tieName xxx%yyy -Name the tie according to the pattern. The defaults are: -.RS 3 -.TP 2 -o -%POATie for the \f2POA\fP tie base class (\f2\-fserverTie\fP or \f2\-fallTie\fP) -.TP 2 -o -%_Tie for the \f2oldImplBase\fP tie class (\f2\-oldImplBase\fP and (\f2\-fserverTie\fP or \f2\-fallTie\fP)) -.RE -.TP 3 -\-nowarn, \-verbose -Verbose mode. -.TP 3 -\-version -Display version information and terminate. -.RE +Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. +.TP +-i \fIinclude-path\fR +.br +By default, the current directory is scanned for included files\&. This option adds another directory\&. +.TP +-i \fIkeep\fR +.br +If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. +.TP +-noWarn +.br +Suppress warning messages\&. +.TP +-oldImplBase +.br +Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. +.TP +-pkgPrefix \fItype\fR\fIprefix\fR +.br +Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. +.TP +-pkgTranslate \fItype\fR\fIpackage\fR +.br +Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value is the simple name of either a top-level module, or an IDL type defined outside of any module and must match the full package name exactly\&. -.LP -.LP -See the Description section for more option information. -.LP -.SH "Restrictions:" -.LP -.RS 3 -.TP 2 -o -Escaped identifiers in the global scope may not have the same spelling as IDL primitive types, \f2Object\fP, or \f2ValueBase\fP. This is because the symbol table is pre\-loaded with these identifiers; allowing them to be redefined would overwrite their original definitions. (Possible permanent restriction). -.TP 2 -o -The \f2fixed\fP IDL type is not supported. -.RE +If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: -.LP -.SH "Known Problems:" -.LP -.RS 3 -.TP 2 -o -No import generated for global identifiers. If you invoke on an unexported local impl, you do get an exception, but it seems to be due to a \f2NullPointerException\fP in the \f2ServerDelegate\fP DSI code. -.RE +\fICommand\fR: +.sp +.nf +\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP +\fIResulting Translation\fR: +.sp +.nf +\f3type => pkg\fP +.fi +.nf +\f3type\&.ext => pkg\&.ext\fP +.fi +.nf +\f3type\&.baz => pkg2\&.fizz\fP +.fi +.nf +\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. +.TP +-skeletonName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. +.TP +-td \fIdir\fR +.br +Use \fIdir\fR for the output directory instead of the current directory\&. +.TP +-tieName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) +.TP +-nowarn, -verbose +.br +Displays release information and terminates\&. +.TP +-version +.br +Displays release information and terminates\&. +.SH RESTRICTIONS +Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. +.PP +The \f3fixed\fR IDL type is not supported\&. +.SH KNOWN\ PROBLEMS +No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jar.1 b/jdk/src/bsd/doc/man/jar.1 index bf6304d20c3..e559e47a160 100644 --- a/jdk/src/bsd/doc/man/jar.1 +++ b/jdk/src/bsd/doc/man/jar.1 @@ -1,579 +1,485 @@ -." Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jar 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jar.1 +.\" +.if n .pl 99999 +.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jar\-The Java Archive Tool -.LP -\f3jar\fP combines multiple files into a single JAR archive file. -.SH "SYNOPSIS" -.LP -.RS 3 -.TP 3 -Create jar file -\f4jar c\fP\f2[v0Mmfe] [\fP\f2manifest\fP\f2] [\fP\f2jarfile\fP\f2] [\fP\f2entrypoint\fP\f2] [\-C\fP \f2dir\fP\f2]\fP \f2inputfiles\fP \f2[\-J\fP\f2option\fP\f2]\fP -.TP 3 -Update jar file -\f4jar u\fP\f2[v0Mmfe] [\fP\f2manifest\fP\f2] [\fP\f2jarfile\fP\f2] [\fP\f2entrypoint\fP\f2] [\-C\fP \f2dir\fP\f2]\fP \f2inputfiles\fP \f2[\-J\fP\f2option\fP\f2]\fP -.TP 3 -Extract jar file -\f4jar x\fP\f2[vf] [\fP\f2jarfile\fP\f2] [\fP\f2inputfiles\fP\f2] [\-J\fP\f2option\fP\f2]\fP -.TP 3 -List table of contents of jar file -\f4jar t\fP\f2[vf] [\fP\f2jarfile\fP\f2] [\fP\f2inputfiles\fP\f2] [\-J\fP\f2option\fP\f2]\fP -.TP 3 -Add index to jar file -\f4jar i\fP \f2jarfile\fP \f2[\-J\fP\f2option\fP\f2]\fP -.RE +.SH NAME +jar \- Manipulates Java Archive (JAR) files\&. +.SH SYNOPSIS +Create JAR file +.sp +.nf -.LP -.LP -where: -.LP -.RS 3 -.TP 3 -cuxtiv0Mmfe -Options that control the \f2jar\fP command. -.TP 3 -jarfile -Jar file to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), or have its table of contents viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if either is present, they must both appear. Note that omitting \f2f\fP and \f2jarfile\fP accepts a "jar file" from standard input (for x and t) or sends the "jar file" to standard output (for c and u). -.TP 3 -inputfiles -Files or directories, separated by spaces, to be combined into \f2jarfile\fP (for c and u), or to be extracted (for x) or listed (for t) from \f2jarfile\fP. All directories are processed recursively. The files are compressed unless option \f20\fP (zero) is used. -.TP 3 -manifest -Pre\-existing manifest file whose \f2name\fP\f2:\fP \f2value\fP pairs are to be included in MANIFEST.MF in the jar file. The \f2\-m\fP option and filename \f2manifest\fP are a pair \-\- if either is present, they must both appear. The letters \f3m\fP, \f3f\fP and \f3e\fP must appear in the same order that \f2manifest\fP, \f2jarfile\fP, \f2entrypoint\fP appear. -.TP 3 -entrypoint -The name of the class that set as the application entry point for stand\-alone applications bundled into executable jar file. The \f2\-e\fP option and entrypoint are a pair \-\- if either is present, they must both appear. The letters \f3m\fP, \f3f\fP and \f3e\fP must appear in the same order that \f2manifest\fP, \f2jarfile\fP, \f2entrypoint\fP appear. -.TP 3 -\-C\ dir -Temporarily changes directories to \f2dir\fP while processing the following \f2inputfiles\fP argument. Multiple \f2\-C\ \fP\f2dir\fP \f2inputfiles\fP sets are allowed. -.TP 3 -\-Joption -Option to be passed into the Java runtime environment. (There must be no space between \f2\-J\fP and \f2option\fP). -.RE +\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -The \f3jar\fP tool combines multiple files into a single JAR archive file. \f3jar\fP is a general\-purpose archiving and compression tool, based on ZIP and the -.na -\f2ZLIB\fP @ -.fi -http://www.gzip.org/zlib/ compression format. However, \f3jar\fP was designed mainly package java applets or applications into a single archive. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a java agent (like a browser) in a single HTTP transaction, rather than requiring a new connection for each piece. This dramatically improves download times. \f3jar\fP also compresses files and so further improves download time. In addition, it allows individual entries in a file to be signed by the applet author so that their origin can be authenticated. The syntax for the jar tool is almost identical to the syntax for the \f2tar\fP command. A \f3jar\fP archive can be used as a class path entry, whether or not it is compressed. -.LP -Typical usage to combine files into a jar file is: -.LP -.nf -\f3 -.fl -% jar cf myFile.jar *.class -.fl -\fP -.fi +Update JAR file +.sp +.nf -.LP -In this example, all the class files in the current directory are placed into the file named \f2myFile.jar\fP. The jar tool automatically generates a manifest file entry named \f2META\-INF/MANIFEST.MF\fP. It is always the first entry in the jar file. The manifest file declares meta\-information about the archive, and stores that data as \f2name\ :\ value\fP pairs. Refer to the -.na -\f2JAR file specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR%20Manifest for details explaining how the jar tool stores meta\-information in the manifest file. -.LP -If a jar file should include \f2name\ :\ value\fP pairs contained in an existing manifest file, specify that file using the \f2\-m\fP option: -.LP -.nf -\f3 -.fl -% jar cmf myManifestFile myFile.jar *.class -.fl -\fP -.fi +\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -An existing manifest file must end with a new line character.\ \f3jar\fP does not parse the last line of a manifest file if it does not end with a new line character. -.br +Extract JAR file +.sp +.nf -.LP -.br +\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -\f3Note:\ \fP A jar command that specifies \f2cfm\fP on the command line instead of \f2cmf\fP (the order of the m and \-f options are reversed), the \f3jar\fP command line must specify the name of the jar archive first, followed by the name of the manifest file: -.nf -\f3 -.fl -% jar cfm myFile.jar myManifestFile *.class -.fl -\fP -.fi +List Contents of JAR file +.sp +.nf -.LP -The manifest is in a text format inspired by RFC822 ASCII format, so it is easy to view and process manifest\-file contents. -.LP -To extract the files from a jar file, use \f2x\fP: -.LP -.nf -\f3 -.fl -% jar xf myFile.jar -.fl -\fP -.fi +\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -.LP -To extract individual files from a jar file, supply their filenames: -.LP -.nf -\f3 -.fl -% jar xf myFile.jar foo bar -.fl -\fP -.fi +Add Index to JAR file +.sp +.nf -.LP -.LP -Beginning with version 1.3 of the JDK, the \f2jar\fP utility supports -.na -\f2JarIndex\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index, which allows application class loaders to load classes more efficiently from jar files. If an application or applet is bundled into multiple jar files,\ only the necessary jar files will be downloaded and opened to load classes. This performance optimization is enabled by running \f2jar\fP with the \f2\-i\fPoption. It will generate package location information for the specified main jar file and all the jar files it depends on, which need to be specified in the \f2Class\-Path\fP attribute of the main jar file's manifest. -.LP -.nf -\f3 -.fl -% jar i main.jar -.fl -\fP -.fi - -.LP -.LP -In this example, an \f2INDEX.LIST\fP file is inserted into the \f2META\-INF\fP directory of \f2main.jar\fP. -.br -.br -The application class loader uses the information stored in this file for efficient class loading.\ For details about how location information is stored in the index file, refer to the \f2JarIndex\fP specification. -.br -.br -To copy directories, first compress files in \f2dir1\fP to \f2stdout\fP, then extract from \f2stdin\fP to \f2dir2\fP (omitting the \f2\-f\fP option from both \f2jar\fP commands): -.LP -.nf -\f3 -.fl -% (cd dir1; jar c .) | (cd dir2; jar x) -.fl -\fP -.fi - -.LP -.LP -To review command samples which use \f2jar\fP to opeate on jar files and jar file manifests, see Examples, below. Also refer to the jar trail of the -.na -\f2Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 +\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp +.SH DESCRIPTION +The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to package Java applets or applications into a single archive\&. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a Java agent (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. +.PP +The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. +.SH OPERATION\ ARGUMENTS +When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. +.TP c -Creates a new archive file named \f2jarfile\fP (if \f2f\fP is specified) or to standard output (if \f2f\fP and \f2jarfile\fP are omitted). Add to it the files and directories specified by \f2inputfiles\fP. -.TP 3 -u -Updates an existing file \f2jarfile\fP (when \f2f\fP is specified) by adding to it files and directories specified by \f2inputfiles\fP. For example: -.nf -\f3 -.fl -jar uf foo.jar foo.class -.fl -\fP -.fi -would add the file \f2foo.class\fP to the existing jar file \f2foo.jar\fP. The \f2\-u\fP option can also update the manifest entry, as given by this example: -.nf -\f3 -.fl -jar umf manifest foo.jar -.fl -\fP -.fi -updates the \f2foo.jar\fP manifest with the \f2name : value\fP pairs in \f2manifest\fP. -.TP 3 -x -Extracts files and directories from \f2jarfile\fP (if \f2f\fP is specified) or standard input (if \f2f\fP and \f2jarfile\fP are omitted). If \f2inputfiles\fP is specified, only those specified files and directories are extracted. Otherwise, all files and directories are extracted. The time and date of the extracted files are those given in the archive. -.TP 3 -t -Lists the table of contents from \f2jarfile\fP (if \f2f\fP is specified) or standard input (if \f2f\fP and \f2jarfile\fP are omitted). If \f2inputfiles\fP is specified, only those specified files and directories are listed. Otherwise, all files and directories are listed. -.TP 3 +Create a new JAR archive\&. +.TP i -Generate index information for the specified \f2jarfile\fP and its dependent jar files. For example: -.nf -\f3 -.fl -jar i foo.jar -.fl -\fP -.fi -.LP -would generate an \f2INDEX.LIST\fP file in \f2foo.jar\fP which contains location information for each package in \f2foo.jar\fP and all the jar files specified in the \f2Class\-Path\fP attribute of \f2foo.jar\fP. See the index example. -.TP 3 -f -Specifies the file \f2jarfile\fP to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), indexed (\f2i\fP), or viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if present, they must both appear. Omitting \f2f\fP and \f2jarfile\fP accepts a jar file name from \f2stdin\fP(for x and t) or sends jar file to \f2stdout\fP (for c and u). -.TP 3 -v -Generates verbose output to standard output. Examples shown below. -.TP 3 -0 -(zero) Store without using ZIP compression. -.TP 3 -M -Do not create a manifest file entry (for c and u), or delete a manifest file entry if one exists (for u). -.TP 3 -m -Includes \f2name : value\fP attribute pairs from the specified manifest file \f2manifest\fP in the file at \f2META\-INF/MANIFEST.MF\fP. \f2jar\fP adds a \f2name\ :\ value\fP pair unless an entry already exists with the same name, in which case \f2jar\fP updates its value. -.br -.br -On the command line, the letters \f3m\fP and \f3f\fP must appear in the same order that \f2manifest\fP and \f2jarfile\fP appear. Example use: -.nf -\f3 -.fl -jar cmf myManifestFile myFile.jar *.class -.fl -\fP -.fi -You can add special\-purpose \f2name\ :\ value\fP attribute pairs to the manifest that aren't contained in the default manifest. For example, you can add attributes specifying vendor information, version information, package sealing, or to make JAR\-bundled applications executable. See the -.na -\f2JAR Files\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar/ trail in the Java Tutorial for examples of using the \f4\-m\fP option. -.TP 3 +Generate index information for a JAR archive\&. +.TP +t +List the contents of a JAR archive\&. +.TP +u +Update a JAR archive\&. +.TP +x +Extract files from a JAR archive\&. +.SH OPTIONS +Use the following options to customize how the JAR file is created, updated, extracted, or viewed: +.TP e -Sets \f2entrypoint\fP as the application entry point for stand\-alone applications bundled into executable jar file. The use of this option creates or overrides the \f2Main\-Class\fP attribute value in the manifest file. This option can be used during creation of jar file or while updating the jar file. This option specifies the application entry point without editing or creating the manifest file. +Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: +.sp +.nf +\f3jar cfe Main\&.jar Main Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The Java Runtime Environment (JRE) can directly call this application by running the following command: +.sp +.nf +\f3java \-jar Main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: +.sp +.nf +\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP +.fi +.nf +\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Note + +Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. +.TP +f +Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. +.TP +m +Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.TP +M +Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. +.TP +n +When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. +.TP +v +Generates verbose output to standard output\&. See Examples\&. +.TP +0 +(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. +.TP +-C \fIdir\fR .br -.br -.br -For example, this command creates \f2Main.jar\fP where the \f2Main\-Class\fP attribute value in the manifest is set to \f2Main\fP: -.nf -\f3 -.fl -jar cfe Main.jar Main Main.class -.fl -\fP -.fi -The java runtime can directly invoke this application by running the following command: -.nf -\f3 -.fl -java \-jar Main.jar -.fl -\fP -.fi -If the entrypoint class name is in a package it may use either a dot (".") or slash ("/") character as the delimiter. For example, if \f2Main.class\fP is in a package called \f2foo\fP the entry point can be specified in the following ways: -.nf -\f3 -.fl -jar \-cfe Main.jar foo/Main foo/Main.class -.fl -\fP -.fi -or -.nf -\f3 -.fl -jar \-cfe Main.jar foo.Main foo/Main.class -.fl -\fP -.fi -\f3Note:\ \fP specifying both \f2\-m\fP and \f2\-e\fP options together when the given manifest also contains the \f2Main\-Class\fP attribute results in an ambigous \f2Main.class\fP specification, leading to an error and the jar creation or update operation is aborted. -.TP 3 -\-C\ dir -Temporarily changes directories (\f2cd\fP\ \f2dir\fP) during execution of the \f2jar\fP command while processing the following \f2inputfiles\fP argument. Its operation is intended to be similar to the \f2\-C\fP option of the UNIX \f2tar\fP utility. -.br -.br -For example, this command changes to the \f2classes\fP directory and adds the \f2bar.class\fP from that directory to \f2foo.jar\fP: -.nf -\f3 -.fl -jar uf foo.jar \-C classes bar.class -.fl -\fP -.fi -This command changes to the \f2classes\fP directory and adds to \f2foo.jar\fP all files within the \f2classes\fP directory (without creating a classes directory in the jar file), then changes back to the original directory before changing to the \f2bin\fP directory to add \f2xyz.class\fP to \f2foo.jar\fP. -.nf -\f3 -.fl -jar uf foo.jar \-C classes . \-C bin xyz.class -.fl -\fP -.fi -If \f2classes\fP holds files \f2bar1\fP and \f2bar2\fP, then here's what the jar file will contain using \f2jar tf foo.jar\fP: -.nf -\f3 -.fl -META\-INF/ -.fl -META\-INF/MANIFEST.MF -.fl -bar1 -.fl -bar2 -.fl -xyz.class -.fl -\fP -.fi -.LP -.TP 3 -\-Joption -Pass \f2option\fP to the Java runtime environment, where \f2option\fP is one of the options described on the reference page for the java application launcher. For example, \f4\-J\-Xmx48M\fP sets the maximum memory to 48 megabytes. It is a common convention for \f2\-J\fP to pass options to the underlying runtime environment. -.RE +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: +.sp +.nf +\f3jar uf my\&.jar \-C classes Bar\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "COMMAND LINE ARGUMENT FILES" -.LP -To shorten or simplify the jar command line, you can specify one or more files that themselves contain arguments to the \f2jar\fP command (except \f2\-J\fP options). This enables you to create jar commands of any length, overcoming command line limits imposed by the operating system. -.LP -An argument file can include options and filenames. The arguments within a file can be space\-separated or newline\-separated. Filenames within an argument file are relative to the current directory, not relative to the location of the argument file. Wildcards (*) that might otherwise be expanded by the operating system shell are not expanded. Use of the \f2@\fP character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -.LP -When executing \f2jar\fP, pass in the path and name of each argument file with the \f2@\fP leading character. When \f2jar\fP encounters an argument beginning with the character \f2@\fP, it expands the contents of that file into the argument list. -.br -.br -The example below, \f2classes.list\fP holds the names of files output by a \f2find\fP command: -.LP -.nf -\f3 -.fl -% find \fP\f3.\fP \-name '*.class' \-print > classes.list -.fl -.fi -.LP -.LP -You can then execute the \f2jar\fP command on \f2Classes.list\fP by passing it to \f2jar\fP using argfile syntax: -.LP -.nf -\f3 -.fl -% jar cf my.jar @classes.list -.fl -\fP -.fi +The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. +.sp +.nf +\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -An argument file can specify a path, but any filenames inside the argument file that have relative paths are relative to the current working directory, not to the path passed in. Here is an example: -.nf -\f3 -.fl -% jar @path1/classes.list -.fl -\fP -.fi -.LP -.LP +If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: +.sp +.nf +\f3% \fIjar tf my\&.jar\fR\fP +.fi +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3bar1\fP +.fi +.nf +\f3bar2\fP +.fi +.nf +\f3Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "EXAMPLES" -.LP -To add all the files in a particular directory to an archive (overwriting contents if the archive already exists). Enumerating verbosely (with the \f2\-v\fP option) will tell you more information about the files in the archive, such as their size and last modified date. -.nf -\f3 -.fl -% ls -.fl -1.au Animator.class monkey.jpg -.fl -2.au Wave.class spacemusic.au -.fl -3.au at_work.gif -.fl +.TP +\fI\fR-J\fIoption\fR +Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH OPERANDS +The following operands are recognized by the \f3jar\fR command\&. +.TP +\fIfile\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. +.TP +\fIentrypoint\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. +.TP +\fIjarfile\fR +Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. -.fl -% jar cvf bundle.jar * -.fl -added manifest -.fl -adding: 1.au(in = 2324) (out= 67)(deflated 97%) -.fl -adding: 2.au(in = 6970) (out= 90)(deflated 98%) -.fl -adding: 3.au(in = 11616) (out= 108)(deflated 99%) -.fl -adding: Animator.class(in = 2266) (out= 66)(deflated 97%) -.fl -adding: Wave.class(in = 3778) (out= 81)(deflated 97%) -.fl -adding: at_work.gif(in = 6621) (out= 89)(deflated 98%) -.fl -adding: monkey.jpg(in = 7667) (out= 91)(deflated 98%) -.fl -adding: spacemusic.au(in = 3079) (out= 73)(deflated 97%) -.fl -\fP -.fi +When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. +.TP +\fImanifest\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. +.TP +\fI@arg-file\fR +To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. -.LP -If you already have separate subdirectories for images, audio files and classes, you can combine them into a single jar file: -.nf -\f3 -.fl -% ls \-F -.fl -audio/ classes/ images/ -.fl +An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. -.fl -% jar cvf bundle.jar audio classes images -.fl -added manifest -.fl -adding: audio/(in = 0) (out= 0)(stored 0%) -.fl -adding: audio/1.au(in = 2324) (out= 67)(deflated 97%) -.fl -adding: audio/2.au(in = 6970) (out= 90)(deflated 98%) -.fl -adding: audio/3.au(in = 11616) (out= 108)(deflated 99%) -.fl -adding: audio/spacemusic.au(in = 3079) (out= 73)(deflated 97%) -.fl -adding: classes/(in = 0) (out= 0)(stored 0%) -.fl -adding: classes/Animator.class(in = 2266) (out= 66)(deflated 97%) -.fl -adding: classes/Wave.class(in = 3778) (out= 81)(deflated 97%) -.fl -adding: images/(in = 0) (out= 0)(stored 0%) -.fl -adding: images/monkey.jpg(in = 7667) (out= 91)(deflated 98%) -.fl -adding: images/at_work.gif(in = 6621) (out= 89)(deflated 98%) -.fl +The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: +.sp +.nf +\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -% ls \-F -.fl -audio/ bundle.jar classes/ images/ -.fl -\fP -.fi -.LP -To see the entry names in the jarfile, use the \f2t\fP option: -.nf -\f3 -.fl -% jar tf bundle.jar -.fl -META\-INF/ -.fl -META\-INF/MANIFEST.MF -.fl -audio/1.au -.fl -audio/2.au -.fl -audio/3.au -.fl -audio/spacemusic.au -.fl -classes/Animator.class -.fl -classes/Wave.class -.fl -images/monkey.jpg -.fl -images/at_work.gif -.fl -\fP -.fi +You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: +.sp +.nf +\f3jar cf my\&.jar @classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -To add an index file to the jar file for speeding up class loading, use the \f2i\fP option. -.br -.br -Example: -.br -.LP -If you split the inter\-dependent classes for a stock trade application into three jar files: \f2main.jar\fP, \f2buy.jar\fP, and \f2sell.jar\fP. -.br - -.LP -.br - -.LP -If you specify the \f2Class\-path\fP attribute in the \f2main.jar\fP manifest as: -.nf -\f3 -.fl -Class\-Path: buy.jar sell.jar -.fl -\fP -.fi - -.LP -then you can use the \f2\-i\fP option to speed up the class loading time for your application: -.nf -\f3 -.fl -% jar i main.jar -.fl -\fP -.fi - -.LP -An \f2INDEX.LIST\fP file is inserted to the \f2META\-INF\fP directory. This enables the application class loader to download the specified jar files when it is searching for classes or resources. -.SH "SEE ALSO" -.LP -.LP -.na -\f2The Jar Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jarGuide.html -.LP -.LP -.na -\f2The Jar File Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html -.LP -.LP -.na -\f2The JarIndex Spec\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index -.LP -.LP -.na -\f2Jar Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar/index.html -.LP -.LP -pack200(1) -.LP +An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: +.sp +.nf +\f3jar @dir/classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH NOTES +The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: +.sp +.nf +\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXAMPLES +\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR +.sp +.nf +\f3% ls\fP +.fi +.nf +\f31\&.au Animator\&.class monkey\&.jpg\fP +.fi +.nf +\f32\&.au Wave\&.class spacemusic\&.au\fP +.fi +.nf +\f33\&.au at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% jar cvf bundle\&.jar *\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Adding Files From Subdirectories\fR +.sp +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ classes/ images/\fP +.fi +.nf +\f3% jar cvf bundle\&.jar audio classes images\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ bundle\&.jar classes/ images/\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Listing the Contents of JAR\fR +.sp +.nf +\f3% jar tf bundle\&.jar\fP +.fi +.sp +.sp +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3audio/1\&.au\fP +.fi +.nf +\f3audio/2\&.au\fP +.fi +.nf +\f3audio/3\&.au\fP +.fi +.nf +\f3audio/spacemusic\&.au\fP +.fi +.nf +\f3classes/Animator\&.class\fP +.fi +.nf +\f3classes/Wave\&.class\fP +.fi +.nf +\f3images/monkey\&.jpg\fP +.fi +.nf +\f3images/at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Adding an Index\fR +.PP +Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: +.sp +.nf +\f3Class\-Path: buy\&.jar sell\&.jar\fP +.fi +.nf +\f3jar i main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. +.PP +The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): +.sp +.nf +\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1)\&. +.TP 0.2i +\(bu +The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jarsigner.1 b/jdk/src/bsd/doc/man/jarsigner.1 index 57dd4ed1022..9394a1079a9 100644 --- a/jdk/src/bsd/doc/man/jarsigner.1 +++ b/jdk/src/bsd/doc/man/jarsigner.1 @@ -1,1567 +1,985 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jarsigner 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: jarsigner.1 +.\" +.if n .pl 99999 +.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jarsigner \- JAR Signing and Verification Tool -.LP -.LP -Generates signatures for Java ARchive (JAR) files, and verifies the signatures of signed JAR files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jarsigner\fP [ options ] jar\-file alias -.fl -\f3jarsigner\fP \-verify [ options ] jar\-file [alias...] -.fl -.fi +.SH NAME +jarsigner \- Signs and verifies Java Archive (JAR) files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -The jarsigner \-verify command can take zero or more keystore alias names after the jar filename. When specified, jarsigner will check that the certificate used to verify each signed entry in the jar file matches one of the keystore aliases. The aliases are defined in the keystore specified by \-keystore, or the default keystore. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jarsigner\fP tool is used for two purposes: -.LP -.RS 3 -.TP 3 -1. -to sign Java ARchive (JAR) files, and -.TP 3 -2. -to verify the signatures and integrity of signed JAR files. -.RE +\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR +.fi +.nf -.LP -.LP -The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution. A tool named jar(1) enables developers to produce JAR files. (Technically, any zip file can also be considered a JAR file, although when created by \f3jar\fP or processed by \f3jarsigner\fP, JAR files also contain a META\-INF/MANIFEST.MF file.) -.LP -.LP -A \f2digital signature\fP is a string of bits that is computed from some data (the data being "signed") and the private key of an entity (a person, company, etc.). Like a handwritten signature, a digital signature has many useful characteristics: -.LP -.RS 3 -.TP 2 -o -Its authenticity can be verified, via a computation that uses the public key corresponding to the private key used to generate the signature. -.TP 2 -o -It cannot be forged, assuming the private key is kept secret. -.TP 2 -o -It is a function of the data signed and thus can't be claimed to be the signature for other data as well. -.TP 2 -o -The signed data cannot be changed; if it is, the signature will no longer verify as being authentic. -.RE +\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +-verify +.br +The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks that the certificate used to verify each signed entry in the JAR file matches one of the keystore aliases\&. The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. -.LP -.LP -In order for an entity's signature to be generated for a file, the entity must first have a public/private key pair associated with it, and also one or more certificates authenticating its public key. A \f2certificate\fP is a digitally signed statement from one entity, saying that the public key of some other entity has a particular value. -.LP -.LP -\f3jarsigner\fP uses key and certificate information from a \f2keystore\fP to generate digital signatures for JAR files. A keystore is a database of private keys and their associated X.509 certificate chains authenticating the corresponding public keys. The keytool(1) utility is used to create and administer keystores. -.LP -.LP -\f3jarsigner\fP uses an entity's private key to generate a signature. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file. \f3jarsigner\fP can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file). -.LP -.LP -\f3jarsigner\fP can generate signatures that include a timestamp, thus enabling systems/deployer (including Java Plug\-in) to check whether the JAR file was signed while the signing certificate was still valid. In addition, APIs will allow applications to obtain the timestamp information. -.LP -.LP -At this time, \f3jarsigner\fP can only sign JAR files created by the SDK jar(1) tool or zip files. (JAR files are the same as zip files, except they also have a META\-INF/MANIFEST.MF file. Such a file will automatically be created when \f3jarsigner\fP signs a zip file.) -.LP -.LP -The default \f3jarsigner\fP behavior is to \f2sign\fP a JAR (or zip) file. Use the \f2\-verify\fP option to instead have it \f2verify\fP a signed JAR file. -.LP -.SS -Keystore Aliases -.LP -.LP -All keystore entities are accessed via unique \f2aliases\fP. -.LP -.LP -When using \f3jarsigner\fP to sign a JAR file, you must specify the alias for the keystore entry containing the private key needed to generate the signature. For example, the following will sign the JAR file named "MyJARFile.jar", using the private key associated with the alias "duke" in the keystore named "mystore" in the "working" directory. Since no output file is specified, it overwrites MyJARFile.jar with the signed JAR file. -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-storepass \fP\f4\fP\f3 -.fl - \-keypass \fP\f4\fP\f3 MyJARFile.jar duke -.fl -\fP -.fi +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. +.TP +\fIjar-file\fR +The JAR file to be signed\&. -.LP -.LP -Keystores are protected with a password, so the store password must be specified. You will be prompted for it if you don't specify it on the command line. Similarly, private keys are protected in a keystore with a password, so the private key's password must be specified, and you will be prompted for it if you don't specify it on the command line and it isn't the same as the store password. -.LP -.SS -Keystore Location -.LP -.LP -\f3jarsigner\fP has a \f2\-keystore\fP option for specifying the URL of the keystore to be used. The keystore is by default stored in a file named \f2.keystore\fP in the user's home directory, as determined by the \f2user.home\fP system property. On Solaris systems \f2user.home\fP defaults to the user's home directory. -.LP -.LP -Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based, for example, if it resides on a hardware token device. -.LP -.SS -Keystore Implementation -.LP -.LP -The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore. -.LP -.LP -Currently, there are two command\-line tools that make use of keystore implementations (\f3keytool\fP and \f3jarsigner\fP), and also a GUI\-based tool named \f3Policy Tool\fP. Since \f2KeyStore\fP is publicly available, Java 2 SDK users can write additional security applications that use it. -.LP -.LP -There is a built\-in default implementation, provided by Sun Microsystems. It implements the keystore as a file, utilizing a proprietary keystore type (format) named "JKS". It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password. -.LP -.LP -Keystore implementations are provider\-based. More specifically, the application interfaces supplied by \f2KeyStore\fP are implemented in terms of a "Service Provider Interface" (SPI). That is, there is a corresponding abstract \f2KeystoreSpi\fP class, also in the \f2java.security\fP package, which defines the Service Provider Interface methods that "providers" must implement. (The term "provider" refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API.) Thus, to provide a keystore implementation, clients must implement a provider and supply a KeystoreSpi subclass implementation, as described in -.na -\f2How to Implement a Provider for the Java Cryptography Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html. -.LP -.LP -Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible. -.LP -.LP -\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL. -.LP -.LP -For \f3jarsigner\fP and \f3keytool\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Change Keystore" command in the Edit menu. -.LP -.LP -If you don't explicitly specify a keystore type, the tools choose a keystore implementation based simply on the value of the \f2keystore.type\fP property specified in the security properties file. The security properties file is called \f2java.security\fP, and it resides in the SDK security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -.LP -Each tool gets the \f2keystore.type\fP value and then examines all the currently\-installed providers until it finds one that implements keystores of that type. It then uses the keystore implementation from that provider. -.LP -.LP -The \f2KeyStore\fP class defines a static method named \f2getDefaultType\fP that lets applications and applets retrieve the value of the \f2keystore.type\fP property. The following line of code creates an instance of the default keystore type (as specified in the \f2keystore.type\fP property): -.LP -.nf -\f3 -.fl - KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); -.fl -\fP -.fi +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. +.TP +\fIalias\fR +The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. +.SH DESCRIPTION +The \f3jarsigner\fR tool has two purposes: +.TP 0.2i +\(bu +To sign Java Archive (JAR) files\&. +.TP 0.2i +\(bu +To verify the signatures and integrity of signed JAR files\&. +.PP +The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) +.PP +A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: +.TP 0.2i +\(bu +Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. +.TP 0.2i +\(bu +It cannot be forged, assuming the private key is kept secret\&. +.TP 0.2i +\(bu +It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. +.TP 0.2i +\(bu +The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. +.PP +To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. +.PP +The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. +.PP +The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. +.PP +The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. +.PP +At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. +.PP +The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. +.PP +The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. +.SS KEYSTORE\ ALIASES +All keystore entities are accessed with unique aliases\&. +.PP +When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-storepass \fP +.fi +.nf +\f3 \-keypass MyJARFile\&.jar duke\fP +.fi +.nf +\f3\fR +.fi +.sp +Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not specify it on the command line\&. Similarly, private keys are protected in a keystore with a password, so the private key\&'s password must be specified, and you are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. +.SS KEYSTORE\ LOCATION +The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. +.PP +On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. +.PP +The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. +.SS KEYSTORE\ IMPLEMENTATION +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. +.PP +Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. +.PP +There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. +.PP +Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html +.PP +Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself\&. Keystore implementations of different types are not compatible\&. +.PP +The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. +.PP +For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. +.PP +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. +.PP +Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. +.PP +The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fR +.fi +.sp +The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fR +.fi +.sp +Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. +.PP +To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html +.SS SUPPORTED\ ALGORITHMS +By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: +.TP 0.2i +\(bu +Digital Signature Algorithm (DSA) with the SHA1 digest algorithm +.TP 0.2i +\(bu +RSA algorithm with the SHA256 digest algorithm +.TP 0.2i +\(bu +Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. +.PP +If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. +.PP +These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. +.SS THE\ SIGNED\ JAR\ FILE +When the \f3jarsigner\fR command is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META-INF directory: +.TP 0.2i +\(bu +A signature file with an \f3\&.SF\fR extension +.TP 0.2i +\(bu +A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension +.PP +The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR +.PP +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. +.PP +Signature File -.LP -.LP -The default keystore type is "jks" (the proprietary type of the keystore implementation provided by Sun). This is specified by the following line in the security properties file: -.LP -.nf -\f3 -.fl - keystore.type=jks -.fl -\fP -.fi +A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: +.TP 0.2i +\(bu +File name +.TP 0.2i +\(bu +Name of the digest algorithm (SHA) +.TP 0.2i +\(bu +SHA digest value +.PP +In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. +.PP +The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. +.PP +Signature Block File -.LP -.LP -Note: Case doesn't matter in keystore type designations. For example, "JKS" would be considered the same as "jks". -.LP -.LP -To have the tools utilize a keystore implementation other than the default, change that line to specify a different keystore type. For example, if you have a provider package that supplies a keystore implementation for a keystore type called "pkcs12", change the line to -.LP -.nf -\f3 -.fl - keystore.type=pkcs12 -.fl -\fP -.fi +The \f3\&.SF\fR file is signed and the signature is placed in the signature block file\&. This file also contains, encoded inside it, the certificate or certificate chain from the keystore that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. +.SS SIGNATURE\ TIME\ STAMP +The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. +.sp +.nf +\f3\-tsa \fIurl\fR\fP +.fi +.nf +\f3\-tsacert \fIalias\fR\fP +.fi +.nf +\f3\-altsigner \fIclass\fR\fP +.fi +.nf +\f3\-altsignerpath \fIclasspathlist\fR\fP +.fi +.nf +\f3\-tsapolicyid \fIpolicyid\fR\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS JAR\ FILE\ VERIFICATION +A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: +.TP 0.4i +1\&. +Verify the signature of the \f3\&.SF\fR file\&. -.LP -.LP -Note that if you us the PKCS#11 provider package, you should refer to the -.na -\f2KeyTool and JarSigner\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#KeyToolJarSigner section of the Java PKCS#11 Reference Guide for details. -.LP -.SS -Supported Algorithms -.LP -.LP -By default, \f3jarsigner\fP signs a JAR file using one of the following: -.LP -.RS 3 -.TP 2 -o -DSA (Digital Signature Algorithm) with the SHA1 digest algorithm -.TP 2 -o -RSA algorithm with the SHA256 digest algorithm. -.TP 2 -o -EC (Elliptic Curve) cryptography algorithm with the SHA256 with ECDSA (Elliptic Curve Digital Signature Algorithm). -.RE +The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. +.TP 0.4i +2\&. +Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. -.LP -.LP -That is, if the signer's public and private keys are DSA keys, \f3jarsigner\fP will sign the JAR file using the "SHA1withDSA" algorithm. If the signer's keys are RSA keys, \f3jarsigner\fP will attempt to sign the JAR file using the "SHA256withRSA" algorithm. If the signer's keys are EC keys, \f3jarsigner\fP will sign the JAR file using the "SHA256withECDSA" algorithm. -.LP -.LP -These default signature algorithms can be overridden using the \f2\-sigalg\fP option. -.LP -.SS -The Signed JAR File -.LP -.LP -When \f3jarsigner\fP is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META\-INF directory: -.LP -.RS 3 -.TP 2 -o -a signature file, with a .SF extension, and -.TP 2 -o -a signature block file, with a .DSA, .RSA, or .EC extension. -.RE +The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. -.LP -.LP -The base file names for these two files come from the value of the \f2\-sigFile\fP option. For example, if the option appears as -.LP -.nf -\f3 -.fl -\-sigFile MKSIGN -.fl -\fP -.fi +If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. -.LP -.LP -The files are named "MKSIGN.SF" and "MKSIGN.DSA". -.LP -.LP -If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not allowed in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. Legal characters include letters, digits, underscores, and hyphens. -.LP -\f3The Signature (.SF) File\fP -.LP -.LP -A signature file (the .SF file) looks similar to the manifest file that is always included in a JAR file when \f3jarsigner\fP is used to sign the file. That is, for each source file included in the JAR file, the .SF file has three lines, just as in the manifest file, listing the following: -.LP -.RS 3 -.TP 2 -o -the file name, -.TP 2 -o -the name of the digest algorithm used (SHA), and -.TP 2 -o -a SHA digest value. -.RE +One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. +.TP 0.4i +3\&. +Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. -.LP -.LP -In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file. In the .SF file, on the other hand, the digest value for a given source file is the hash of the three lines in the manifest file for the source file. -.LP -.LP -The signature file also, by default, includes a header containing a hash of the whole manifest file. The presence of the header enables verification optimization, as described in JAR File Verification. -.LP -\f3The Signature Block File\fP -.LP -The .SF file is signed and the signature is placed in the signature block file. This file also contains, encoded inside it, the certificate or certificate chain from the keystore which authenticates the public key corresponding to the private key used for signing. The file has the extension .DSA, .RSA, or .EC depending on the digest algorithm used. -.SS -Signature Timestamp -.LP -.LP -\f2jarsigner\fP tool can generate and store a signature timestamp when signing a JAR file. In addition, \f2jarsigner\fP supports alternative signing mechanisms. This behavior is optional and is controlled by the user at the time of signing through these options: -.LP -.RS 3 -.TP 2 -o -\f2\-tsa url\fP -.TP 2 -o -\f2\-tsacert alias\fP -.TP 2 -o -\f2\-altsigner class\fP -.TP 2 -o -\f2\-altsignerpath classpathlist\fP -.RE +If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. +.PP +\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. +.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE +A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: +.sp +.nf +\f3jarsigner myBundle\&.jar susan\fP +.fi +.nf +\f3jarsigner myBundle\&.jar kevin\fP +.fi +.nf +\f3\fR +.fi +.sp +When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: +.sp +.nf +\f3SUSAN\&.SF\fP +.fi +.nf +\f3SUSAN\&.DSA\fP +.fi +.nf +\f3KEVIN\&.SF\fP +.fi +.nf +\f3KEVIN\&.DSA\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1\&.1 by the \f3javakey\fR command and others by \f3jarsigner\fR\&. The \f3jarsigner\fR command can be used to sign JAR files that are already signed with the \f3javakey\fR command\&. +.SH OPTIONS +The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: +.TP 0.2i +\(bu +All option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options can be provided in any order\&. +.TP 0.2i +\(bu +Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. +.TP 0.2i +\(bu +The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. +.TP +-keystore \fIurl\fR +.br +Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. -.LP -.LP -Each of these options is detailed in the Options section below. -.LP -.SS -JAR File Verification -.LP -.LP -A successful JAR file verification occurs if the signature(s) are valid, and none of the files that were in the JAR file when the signatures were generated have been changed since then. JAR file verification involves the following steps: -.LP -.RS 3 -.TP 3 -1. -Verify the signature of the .SF file itself. -.br -.br -That is, the verification ensures that the signature stored in each signature block (.DSA) file was in fact generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the .DSA file. It also ensures that the signature is a valid signature of the corresponding signature (.SF) file, and thus the .SF file has not been tampered with. -.TP 3 -2. -Verify the digest listed in each entry in the .SF file with each corresponding section in the manifest. -.br -.br -The .SF file by default includes a header containing a hash of the entire manifest file. When the header is present, then the verification can check to see whether or not the hash in the header indeed matches the hash of the manifest file. If that is the case, verification proceeds to the next step. -.br -.br -If that is not the case, a less optimized verification is required to ensure that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file (see The Signature (.SF) File). -.br -.br -One reason the hash of the manifest file that is stored in the .SF file header may not equal the hash of the current manifest file would be because one or more files were added to the JAR file (using the \f2jar\fP tool) after the signature (and thus the .SF file) was generated. When the \f2jar\fP tool is used to add files, the manifest file is changed (sections are added to it for the new files), but the .SF file is not. A verification is still considered successful if none of the files that were in the JAR file when the signature was generated have been changed since then, which is the case if the hashes in the non\-header sections of the .SF file equal the hashes of the corresponding sections in the manifest file. -.TP 3 -3. -Read each file in the JAR file that has an entry in the .SF file. While reading, compute the file's digest, and then compare the result with the digest for this file in the manifest section. The digests should be the same, or verification fails. -.RE +A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. -.LP -.LP -If any serious verification failures occur during the verification process, the process is stopped and a security exception is thrown. It is caught and displayed by \f3jarsigner\fP. -.LP -.SS -Multiple Signatures for a JAR File -.LP -.LP -A JAR file can be signed by multiple people simply by running the \f3jarsigner\fP tool on the file multiple times, specifying the alias for a different person each time, as in: -.LP -.nf -\f3 -.fl - jarsigner myBundle.jar susan -.fl - jarsigner myBundle.jar kevin -.fl -\fP -.fi +A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. -.LP -.LP -When a JAR file is signed multiple times, there are multiple .SF and .DSA files in the resulting JAR file, one pair for each signature. Thus, in the example above, the output JAR file includes files with the following names: -.LP -.nf -\f3 -.fl - SUSAN.SF -.fl - SUSAN.DSA -.fl - KEVIN.SF -.fl - KEVIN.DSA -.fl -\fP -.fi +The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: +.sp +.nf +\f3\-keystore \fIfilePathAndName\fR\fP +.fi +.nf +\f3\-keystore file:\fIfilePathAndName\fR\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.LP -Note: It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1.1 \f3javakey\fP tool and others by \f3jarsigner\fP. That is, \f3jarsigner\fP can be used to sign JAR files already previously signed using \f3javakey\fP. -.LP -.SH "OPTIONS" -.LP -.LP -The various \f3jarsigner\fP options are listed and described below. Note: -.LP -.RS 3 -.TP 2 -o -All option names are preceded by a minus sign (\-). -.TP 2 -o -The options may be provided in any order. -.TP 2 -o -Items in italics (option values) represent the actual values that must be supplied. -.TP 2 -o -The \f2\-keystore\fP, \f2\-storepass\fP, \f2\-keypass\fP, \f2\-sigfile\fP, \f2\-sigalg\fP, \f2\-digestalg\fP, and \f2\-signedjar\fP options are only relevant when signing a JAR file, not when verifying a signed JAR file. Similarly, an alias is only specified on the command line when signing a JAR file. -.RE -.LP -.RS 3 -.TP 3 -\-keystore url -Specifies the URL that tells the keystore location. This defaults to the file \f2.keystore\fP in the user's home directory, as determined by the "user.home" system property. -.br -.br -A keystore is required when signing, so you must explicitly specify one if the default keystore does not exist (or you want to use one other than the default). -.br -.br -A keystore is \f2not\fP required when verifying, but if one is specified, or the default exists, and the \f2\-verbose\fP option was also specified, additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore. -.br -.br -Note: the \f2\-keystore\fP argument can actually be a file name (and path) specification rather than a URL, in which case it will be treated the same as a "file:" URL. That is, -.nf -\f3 -.fl - \-keystore \fP\f4filePathAndName\fP\f3 -.fl -\fP -.fi -is treated as equivalent to -.nf -\f3 -.fl - \-keystore file:\fP\f4filePathAndName\fP\f3 -.fl -\fP -.fi -If the Sun PKCS#11 provider has been configured in the \f2java.security\fP security properties file (located in the JRE's \f2$JAVA_HOME/lib/security\fP directory), then keytool and jarsigner can operate on the PKCS#11 token by specifying these options: -.RS 3 -.TP 2 -o -\f2\-keystore NONE\fP -.TP 2 -o -\f2\-storetype PKCS11\fP -.RE -For example, this command lists the contents of the configured PKCS#11 token: -.nf -\f3 -.fl - jarsigner \-keystore NONE \-storetype PKCS11 \-list -.fl -\fP -.fi -.TP 3 -\-storetype storetype -Specifies the type of keystore to be instantiated. The default keystore type is the one that is specified as the value of the "keystore.type" property in the security properties file, which is returned by the static \f2getDefaultType\fP method in \f2java.security.KeyStore\fP. -.br -.br -The PIN for a PCKS#11 token can also be specified using the \f2\-storepass\fP option. If none has been specified, keytool and jarsigner will prompt for the token PIN. If the token has a protected authentication path (such as a dedicated PIN\-pad or a biometric reader), then the \f2\-protected\fP option must be specified and no password options can be specified. -.TP 3 -\-storepass[:env | :file] argument -Specifies the password which is required to access the keystore. This is only needed when signing (not verifying) a JAR file. In that case, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for the password. -.br -.br -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. -.TP 3 -\-keypass[:env | :file] argument -Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line. The password is required when using \f3jarsigner\fP to sign a JAR file. If no password is provided on the command line, and the required password is different from the store password, the user is prompted for it. -.br -.br -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. -.TP 3 -\-sigfile file -Specifies the base file name to be used for the generated .SF and .DSA files. For example, if \f2file\fP is "DUKESIGN", the generated .SF and .DSA files will be named "DUKESIGN.SF" and "DUKESIGN.DSA", and will be placed in the "META\-INF" directory of the signed JAR file. -.br -.br -The characters in \f2file\fP must come from the set "a\-zA\-Z0\-9_\-". That is, only letters, numbers, underscore, and hyphen characters are allowed. Note: All lowercase characters will be converted to uppercase for the .SF and .DSA file names. -.br -.br -If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not legal in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. -.TP 3 -\-sigalg algorithm -Specifies the name of the signature algorithm to use to sign the JAR file. -.br -.br -See -.na -\f2Appendix A\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard signature algorithm names. This algorithm must be compatible with the private key used to sign the JAR file. If this option is not specified, SHA1withDSA, SHA256withRSA, or SHA256withECDSA will be used depending on the type of private key. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed. -.TP 3 -\-digestalg algorithm -Specifies the name of the message digest algorithm to use when digesting the entries of a jar file. -.br -.br -See -.na -\f2Appendix A\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard message digest algorithm names. If this option is not specified, SHA256 will be used. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed. -.TP 3 -\-signedjar file -Specifies the name to be used for the signed JAR file. -.br -.br -If no name is specified on the command line, the name used is the same as the input JAR file name (the name of the JAR file to be signed); in other words, that file is overwritten with the signed JAR file. -.TP 3 -\-verify -If this appears on the command line, the specified JAR file will be verified, not signed. If the verification is successful, "jar verified" will be displayed. If you try to verify an unsigned JAR file, or a JAR file signed with an unsupported algorithm (e.g., RSA when you don't have an RSA provider installed), the following is displayed: "jar is unsigned. (signatures missing or not parsable)" -.br -.br -It is possible to verify JAR files signed using either \f3jarsigner\fP or the JDK 1.1 \f3javakey\fP tool, or both. -.br -.br -For further information on verification, see JAR File Verification. -.TP 3 -\-certs -If this appears on the command line, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file. This information includes -.RS 3 -.TP 2 -o -the name of the type of certificate (stored in the .DSA file) that certifies the signer's public key -.TP 2 -o -if the certificate is an X.509 certificate (more specifically, an instance of \f2java.security.cert.X509Certificate\fP): the distinguished name of the signer -.RE -The keystore is also examined. If no keystore value is specified on the command line, the default keystore file (if any) will be checked. If the public key certificate for a signer matches an entry in the keystore, then the following information will also be displayed: -.RS 3 -.TP 2 -o -in parentheses, the alias name for the keystore entry for that signer. If the signer actually comes from a JDK 1.1 identity database instead of from a keystore, the alias name will appear in brackets instead of parentheses. -.RE -.TP 3 -\-certchain file -Specifies the certificate chain to be used, if the certificate chain associated with the private key of the keystore entry, addressed by the alias specified on the command line, is not complete. This may happen if the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain. The file can be a sequence of X.509 certificates concatenated together, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as BASE64 encoding) as defined by the Internet RFC 1421 standard. -.TP 3 -\-verbose -If this appears on the command line, it indicates "verbose" mode, which causes \f3jarsigner\fP to output extra information as to the progress of the JAR signing or verification. -.TP 3 -\-internalsf -In the past, the .DSA (signature block) file generated when a JAR file was signed used to include a complete encoded copy of the .SF file (signature file) also generated. This behavior has been changed. To reduce the overall size of the output JAR file, the .DSA file by default doesn't contain a copy of the .SF file anymore. But if \f2\-internalsf\fP appears on the command line, the old behavior is utilized. \f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP -.TP 3 -\-sectionsonly -If this appears on the command line, the .SF file (signature file) generated when a JAR file is signed does \f2not\fP include a header containing a hash of the whole manifest file. It just contains information and hashes related to each individual source file included in the JAR file, as described in The Signature (.SF) File . -.br -.br -By default, this header is added, as an optimization. When the header is present, then whenever the JAR file is verified, the verification can first check to see whether or not the hash in the header indeed matches the hash of the whole manifest file. If so, verification proceeds to the next step. If not, it is necessary to do a less optimized verification that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file. -.br -.br -For further information, see JAR File Verification. -.br -.br -\f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP -.TP 3 -\-protected -Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader. -.TP 3 -\-providerClass provider\-class\-name -Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file, \f2java.security\fP. -.br -.br -Used in conjunction with the \f2\-providerArg\fP \f2ConfigFilePath\fP option, keytool and jarsigner will install the provider dynamically (where \f2ConfigFilePath\fP is the path to the token configuration file). Here's an example of a command to list a PKCS#11 keystore when the Sun PKCS#11 provider has not been configured in the security properties file. -.nf -\f3 -.fl -jarsigner \-keystore NONE \-storetype PKCS11 \\ -.fl - \-providerClass sun.security.pkcs11.SunPKCS11 \\ -.fl - \-providerArg /foo/bar/token.config \\ -.fl - \-list -.fl -\fP -.fi -.TP 3 -\-providerName providerName -If more than one provider has been configured in the \f2java.security\fP security properties file, you can use the \f2\-providerName\fP option to target a specific provider instance. The argument to this option is the name of the provider. -.br -.br -For the Sun PKCS#11 provider, \f2providerName\fP is of the form \f2SunPKCS11\-\fP\f2TokenName\fP, where \f2TokenName\fP is the name suffix that the provider instance has been configured with, as detailed in the -.na -\f2configuration attributes table\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#ATTRS. For example, the following command lists the contents of the PKCS#11 keystore provider instance with name suffix \f2SmartCard\fP: -.nf -\f3 -.fl -jarsigner \-keystore NONE \-storetype PKCS11 \\ -.fl - \-providerName SunPKCS11\-SmartCard \\ -.fl - \-list -.fl -\fP -.fi -.TP 3 -\-Jjavaoption -Passes through the specified \f2javaoption\fP string directly to the Java interpreter. (\f3jarsigner\fP is actually a "wrapper" around the interpreter.) This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line. -.TP 3 -\-tsa url -If \f2"\-tsa http://example.tsa.url"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The URL, \f2http://example.tsa.url\fP, identifies the location of the Time Stamping Authority (TSA). It overrides any URL found via the \f2\-tsacert\fP option. The \f2\-tsa\fP option does not require the TSA's public key certificate to be present in the keystore. -.br -.br -To generate the timestamp, \f2jarsigner\fP communicates with the TSA using the Time\-Stamp Protocol (TSP) defined in -.na -\f2RFC 3161\fP @ -.fi -http://www.ietf.org/rfc/rfc3161.txt. If successful, the timestamp token returned by the TSA is stored along with the signature in the signature block file. -.TP 3 -\-tsacert alias -If \f2"\-tsacert alias"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The \f2alias\fP identifies the TSA's public key certificate in the keystore that is currently in effect. The entry's certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA. -.br -.br -The TSA's public key certificate must be present in the keystore when using \f2\-tsacert\fP. -.TP 3 -\-altsigner class -Specifies that an alternative signing mechanism be used. The fully\-qualified class name identifies a class file that extends the \f2com.sun.jarsigner.ContentSigner abstract class\fP. The path to this class file is defined by the \f2\-altsignerpath\fP option. If the \f2\-altsigner\fP option is used, \f2jarsigner\fP uses the signing mechanism provided by the specified class. Otherwise, \f2jarsigner\fP uses its default signing mechanism. -.br -.br -For example, to use the signing mechanism provided by a class named \f2com.sun.sun.jarsigner.AuthSigner\fP, use the \f2jarsigner\fP option \f2"\-altsigner com.sun.jarsigner.AuthSigner"\fP -.TP 3 -\-altsignerpath classpathlist -Specifies the path to the class file (the class file name is specified with the \f2\-altsigner\fP option described above) and any JAR files it depends on. If the class file is in a JAR file, then this specifies the path to that JAR file, as shown in the example below. -.br -.br -An absolute path or a path relative to the current directory may be specified. If \f2classpathlist\fP contains multiple paths or JAR files, they should be separated with a colon (\f2:\fP) on Solaris and a semi\-colon (\f2;\fP) on Windows. This option is not necessary if the class is already in the search path. -.br -.br -Example of specifying the path to a jar file that contains the class file: -.nf -\f3 -.fl -\-altsignerpath /home/user/lib/authsigner.jar -.fl -\fP -.fi -Note that the JAR file name is included. -.br -.br -Example of specifying the path to the jar file that contains the class file: -.nf -\f3 -.fl -\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/ -.fl -\fP -.fi -Note that the JAR file name is omitted. -.TP 3 -\-strict -During the signing or verifying process, some warning messages may be shown. If this option appears on the command line, the exit code of the tool will reflect the warning messages that are found. Read the "WARNINGS" section for details. -.TP 3 -\-verbose:sub\-options -For the verifying process, the \f2\-verbose\fP option takes sub\-options to determine how much information will be shown. If \f2\-certs\fP is also specified, the default mode (or sub\-option all) displays each entry as it is being processed and following that, the certificate information for each signer of the JAR file. If \f2\-certs\fP and the \f2\-verbose:grouped\fP sub\-option are specified, entries with the same signer info are grouped and displayed together along with their certificate information. If \f2\-certs\fP and the \f2\-verbose:summary\fP sub\-option are specified, then entries with the same signer info are grouped and displayed together along with their certificate information but details about each entry are summarized and displayed as "one entry (and more)". See the examples section for more information. -.RE +If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: +.sp +.nf +\f3\-keystore NONE\fP +.fi +.nf +\f3\-storetype PKCS11\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.SH "EXAMPLES" -.LP -.SS -Signing a JAR File -.LP -.LP -Suppose you have a JAR file named "bundle.jar" and you'd like to sign it using the private key of the user whose keystore alias is "jane" in the keystore named "mystore" in the "working" directory. You can use the following to sign the JAR file and name the signed JAR file "sbundle.jar": -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-storepass \fP\f4\fP\f3 -.fl - \-keypass \fP\f4\fP\f3 \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi -.LP -.LP -Note that there is no \f2\-sigfile\fP specified in the command above, so the generated .SF and .DSA files to be placed in the signed JAR file will have default names based on the alias name. That is, they will be named \f2JANE.SF\fP and \f2JANE.DSA\fP. -.LP -.LP -If you want to be prompted for the store password and the private key password, you could shorten the above command to -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore -.fl - \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi +For example, the following command lists the contents of the configured PKCS#11 token: +.sp +.nf +\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.LP -If the keystore to be used is the default keystore (the one named ".keystore" in your home directory), you don't need to specify a keystore, as in: -.LP -.nf -\f3 -.fl - jarsigner \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi - -.LP -.LP -Finally, if you want the signed JAR file to simply overwrite the input JAR file (\f2bundle.jar\fP), you don't need to specify a \f2\-signedjar\fP option: -.LP -.nf -\f3 -.fl - jarsigner bundle.jar jane -.fl -\fP -.fi - -.LP -.SS -Verifying a Signed JAR File -.LP -.LP -To verify a signed JAR file, that is, to verify that the signature is valid and the JAR file has not been tampered with, use a command such as the following: -.LP -.nf -\f3 -.fl - jarsigner \-verify sbundle.jar -.fl -\fP -.fi - -.LP -.LP -If the verification is successful, -.LP -.nf -\f3 -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -is displayed. Otherwise, an error message appears. -.LP -.LP -You can get more information if you use the \f2\-verbose\fP option. A sample use of \f3jarsigner\fP with the \f2\-verbose\fP option is shown below, along with sample output: -.LP -.nf -\f3 -.fl - jarsigner \-verify \-verbose sbundle.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx.class -.fl - smk 849 Fri Sep 26 16:12:46 PDT 1997 test.class -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.SS -Verification with Certificate Information -.LP -.LP -If you specify the \f2\-certs\fP option when verifying, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file, including the certificate type, the signer distinguished name information (if and only if it's an X.509 certificate), and, in parentheses, the keystore alias for the signer if the public key certificate in the JAR file matches that in a keystore entry. For example, -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST.SF -.fl - 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST.DSA -.fl - smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst.class -.fl - -.fl - X.509, CN=Test Group, OU=Java Software, O=Sun Microsystems, L=CUP, S=CA, C=US (javatest) -.fl - X.509, CN=Jane Smith, OU=Java Software, O=Sun, L=cup, S=ca, C=us (jane) -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -If the certificate for a signer is not an X.509 certificate, there is no distinguished name information. In that case, just the certificate type and the alias are shown. For example, if the certificate is a PGP certificate, and the alias is "bob", you'd get -.LP -.nf -\f3 -.fl - PGP, (bob) -.fl -\fP -.fi - -.LP -.SS -Verification of a JAR File that Includes Identity Database Signers -.LP -.LP -If a JAR file has been signed using the JDK 1.1 \f3javakey\fP tool, and thus the signer is an alias in an identity database, the verification output includes an "i" symbol. If the JAR file has been signed by both an alias in an identity database and an alias in a keystore, both "k" and "i" appear. -.LP -.LP -When the \f2\-certs\fP option is used, any identity database aliases are shown in square brackets rather than the parentheses used for keystore aliases. For example: -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-verify \-verbose \-certs writeFile.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - 199 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE.SF -.fl - 1013 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE.DSA -.fl - smki 2752 Fri Sep 26 16:12:30 PDT 1997 writeFile.html -.fl - -.fl - X.509, CN=Jane Smith, OU=Java Software, O=Sun, L=cup, S=ca, C=us (jane) -.fl - X.509, CN=Duke, OU=Java Software, O=Sun, L=cup, S=ca, C=us [duke] -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - i = at least one certificate was found in identity scope -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -Note that the alias "duke" is in brackets to denote that it is an identity database alias, not a keystore alias. -.LP -.SH "WARNINGS" -.LP -During the signing/verifying process, jarsigner may display various warnings. These warning codes are defined as follows: -.nf -\f3 -.fl - hasExpiringCert 2 -.fl - This jar contains entries whose signer certificate will expire within six months -.fl - -.fl - hasExpiredCert 4 -.fl - This jar contains entries whose signer certificate has expired. -.fl - -.fl - notYetValidCert 4 -.fl - This jar contains entries whose signer certificate is not yet valid. -.fl - -.fl - chainNotValidated 4 -.fl - This jar contains entries whose certificate chain cannot be correctly validated. -.fl - -.fl - badKeyUsage 8 -.fl - This jar contains entries whose signer certificate's KeyUsage extension doesn't allow code signing. -.fl - -.fl - badExtendedKeyUsage 8 -.fl - This jar contains entries whose signer certificate's ExtendedKeyUsage extension -.fl - doesn't allow code signing. -.fl - -.fl - badNetscapeCertType 8 -.fl - This jar contains entries whose signer certificate's NetscapeCertType extension -.fl - doesn't allow code signing. -.fl - -.fl - hasUnsignedEntry 16 -.fl - This jar contains unsigned entries which have not been integrity\-checked. -.fl - -.fl - notSignedByAlias 32 -.fl - This jar contains signed entries which are not signed by the specified alias(es) -.fl - -.fl - aliasNotInStore 32 -.fl - This jar contains signed entries that are not signed by alias in this keystore -.fl - -.fl -\fP -.fi - -.LP -.LP -When the \f2\-strict\fP option is provided, an OR\-value of warnings detected will be returned as the exit code of the tool. For example, if a certificate used to sign an entry is expired and has a keyUsage extension that does not allow it to sign a file, an exit code 12 (=4+8) will be returned. -.LP -.LP -\f3Note\fP: Exit codes are reused because only 0\-255 is legal for Unix. In any case, if the signing/verifying process fails, the following exit code will be returned: -.LP -.nf -\f3 -.fl -failure 1 -.fl -\fP -.fi - -.LP -.SS -Compatibility with JDK 1.1 -.LP -.LP -The \f3keytool\fP and \f3jarsigner\fP tools completely replace the \f3javakey\fP tool provided in JDK 1.1. These new tools provide more features than \f3javakey\fP, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them. -.LP -.LP -The new keystore architecture replaces the identity database that \f3javakey\fP created and managed. There is no backwards compatibility between the keystore format and the database format used by \f3javakey\fP in 1.1. However, -.LP -.RS 3 -.TP 2 -o -It is possible to import the information from an identity database into a keystore, via the \f3keytool\fP \f2\-identitydb\fP command. -.TP 2 -o -\f3jarsigner\fP can sign JAR files also previously signed using \f3javakey\fP. -.TP 2 -o -\f3jarsigner\fP can verify JAR files signed using \f3javakey\fP. Thus, it recognizes and can work with signer aliases that are from a JDK 1.1 identity database rather than a Java 2 SDK keystore. -.RE - -.LP -.LP -The following table explains how JAR files that were signed in JDK 1.1.x are treated in the Java 2 platform. -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 83 84 -.nr 34 \n(.lu -.eo -.am 82 +.TP +-storetype \fIstoretype\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f3Trusted Identity imported into Java 2 Platform keystore from 1.1 database (4)\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 83 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(83 .ll \n(83u -.in 0 -\f3Policy File grants privileges to Identity/Alias\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. (3) -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. (1,3) -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code plus privileges granted in policy file. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code plus privileges granted in policy file. (2) -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3JAR File Type\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wUnsigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Identity in 1.1 database\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Untrusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Untrusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 82 0 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.82 -.rm 82 -.nr 38 \n(a- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 83 0 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.83 -.rm 83 -.nr 38 \n(b- -.if \n(83<\n(38 .nr 83 \n(38 -.nr 84 0 -.nr 38 \w\f3Privileges Granted\fP -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges (1) -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges (1) -.if \n(84<\n(38 .nr 84 \n(38 -.84 -.rm 84 -.nr 38 \n(c- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(d- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(e- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(f- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(g- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(h- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(i- -.if \n(84<\n(38 .nr 84 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr 43 \n(82+(3*\n(38) -.nr 83 +\n(43 -.nr 44 \n(83+(3*\n(38) -.nr 84 +\n(44 -.nr TW \n(84 -.if t .if \n(TW>\n(.li .tm Table at line 1082 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.ne \n(b|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3JAR File Type\fP\h'|\n(41u'\f3Identity in 1.1 database\fP\h'|\n(42u'\h'|\n(43u'\h'|\n(44u'\f3Privileges Granted\fP -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(43u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Unsigned JAR\h'|\n(41u'NO\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'YES\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Untrusted\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Untrusted\h'|\n(42u'NO\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'YES\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'YES\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u'All privileges -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'YES\h'|\n(43u'NO\h'|\n(44u'All privileges (1) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'NO\h'|\n(43u'YES\h'|\n(44u'All privileges (1) -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-42 +Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. -.LP -.LP -Notes: -.LP -.RS 3 -.TP 3 -1. -If an identity/alias is mentioned in the policy file, it must be imported into the keystore for the policy file to have any effect on privileges granted. -.TP 3 -2. -The policy file/keystore combination has precedence over a trusted identity in the identity database. -.TP 3 -3. -Untrusted identities are ignored in the Java 2 platform. -.TP 3 -4. -Only trusted identities can be imported into Java 2 SDK keystores. -.RE +The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands prompt for the token PIN\&. If the token has a protected authentication path (such as a dedicated PIN-pad or a biometric reader), then the \f3-protected\fR option must be specified and no password options can be specified\&. +.TP +-storepass[:env | :file] \fIargument\fR +.br +Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jar(1) tool documentation -.TP 2 -o -keytool(1) tool documentation -.TP 2 -o -the -.na -\f4Security\fP @ -.fi -http://download.oracle.com/javase/tutorial/security/index.html trail of the -.na -\f4Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/index.html for examples of the use of the \f3jarsigner\fP tool -.RE +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE -.LP +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-keypass [:env | :file] \fIargument\fR +.br +Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line\&. The password is required when using \f3jarsigner\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-sigfile \fIfile\fR +.br +Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. + +The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. + +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to upper case\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. +.TP +-sigalg \fIalgorithm\fR +.br +Specifies the name of the signature algorithm to use to sign the JAR file\&. + +For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are used depending on the type of private key\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-digestalg \fIalgorithm\fR +.br +Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. + +For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-certs +.br +If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. + +The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. If the signer comes from a JDK 1\&.1 identity database instead of from a keystore, then the alias name displays in brackets instead of parentheses\&. +.TP +-certchain \fIfile\fR +.br +Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. +.TP +-verbose +.br +When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. +.TP +-internalsf +.br +In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. +.TP +-sectionsonly +.br +If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. + +By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. + +The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. +.TP +-protected +.br +Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. +.TP +-providerClass \fIprovider-class-name\fR +.br +Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. + +Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP +.fi +.nf +\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-providerName \fIproviderName\fR +.br +If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. + +For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerName SunPKCS11\-SmartCard \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-J\fIjavaoption\fR +.br +Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is a wrapper around the interpreter\&. This option should not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.TP +-tsa \fIurl\fR +.br +If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. + +To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. +.TP +-tsacert \fIalias\fR +.br +When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. + +The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. +.TP +-tsapolicyid \fIpolicyid\fR +.br +Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. + +Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. +.TP +-altsigner \fIclass\fR +.br +This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. + +For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. +.TP +-altsignerpath \fIclasspathlist\fR +.br +Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. + +An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. + +The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. +.sp +.nf +\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. +.sp +.nf +\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-strict +.br +During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. +.TP +-verbose \fIsuboptions\fR +.br +For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. +.SH ERRORS\ AND\ WARNINGS +During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. +.PP +If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. +.PP +For example, if a certificate used to sign an entry is expired and has a KeyUsage extension that does not allow it to sign a file, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. +.PP +\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. +.PP +The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. +.SS FAILURE +Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. +.TP +failure +Code 1\&. The signing or verifying fails\&. +.SS SEVERE\ WARNINGS +\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. +.PP +Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. +.TP +hasExpiredCert +Code 4\&. This jar contains entries whose signer certificate has expired\&. +.TP +notYetValidCert +Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. +.TP +chainNotValidated +Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. +.TP +badKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. +.TP +badExtendedKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. +.TP +badNetscapeCertType +Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. +.TP +hasUnsignedEntry +Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. +.TP +notSignedByAlias +Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. +.TP +aliasNotInStore +Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. +.SS INFORMATIONAL\ WARNINGS +Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. +.TP +hasExpiringCert +This jar contains entries whose signer certificate will expire within six months\&. +.TP +noTimestamp +This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. +.SH EXAMPLES +.SS SIGN\ A\ JAR\ FILE +Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-storepass \fP +.fi +.nf +\f3 \-keypass \fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. +.PP +If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: +.sp +.nf +\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: +.sp +.nf +\f3jarsigner bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFY\ A\ SIGNED\ JAR\ FILE +To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: +.sp +.nf +\f3jarsigner \-verify sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp +When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: +.sp +.nf +\f3jarsigner \-verify \-verbose sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP +.fi +.nf +\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION +If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP +.fi +.nf +\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. +.SS VERIFICATION\ THAT\ INCLUDES\ IDENTITY\ DATABASE\ SIGNERS +If a JAR file was signed with the JDK 1\&.1 \f3javakey\fR tool, and the signer is an alias in an identity database, then the verification output includes an \f3i\fR\&. If the JAR file was signed by both an alias in an identity database and an alias in a keystore, then both \f3k\fR and \f3i\fR appear\&. +.PP +When the \f3-certs\fR option is used, any identity database aliases are shown in brackets rather than the parentheses used for keystore aliases, for example: +.sp +.nf +\f3 jarsigner \-keystore /working/mystore \-verify \-verbose \-certs writeFile\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 199 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE\&.DSA\fP +.fi +.nf +\f3 smki 2752 Fri Sep 26 16:12:30 PDT 1997 writeFile\&.html\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3 X\&.509, CN=Duke, OU=Java Software, O=Oracle, L=cup, S=ca, C=us [duke]\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3 i = at least one certificate was found in identity scope\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR The alias \f3duke\fR is in brackets to denote that it is an identity database alias, and not a keystore alias\&. +.SH JDK\ 1\&.1\ COMPATIBILITY +The \f3keytool\fR and \f3jarsigner\fR tools replace the \f3javakey\fR tool in JDK 1\&.1\&. These new tools provide more features than \f3javakey\fR, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them\&. +.PP +The new keystore architecture replaces the identity database that \f3javakey\fR created and managed\&. There is no backward compatibility between the keystore format and the database format used by \f3javakey\fR in JDK 1\&.1\&. However, be aware of the following: +.TP 0.2i +\(bu +It is possible to import the information from an identity database into a keystore through the \f3keytool -identitydb\fR command\&. +.TP 0.2i +\(bu +The \f3jarsigner\fR command can sign JAR files that were signed with the \f3javakey\fR command\&. +.TP 0.2i +\(bu +The \f3jarsigner\fR command can verify JAR files signed with \f3javakey\fR\&. The \f3jarsigner\fR command recognizes and can work with signer aliases that are from a JDK 1\&.1 identity database rather than a JDK keystore\&. +.SS UNSIGNED\ JARS +Unsigned JARs have the default privileges that are granted to all code\&. +.SS SIGNED\ JARS +Signed JARs have the privilege configurations based on their JDK 1\&.1\&.\fIn\fR identity and policy file status as described\&. Only trusted identities can be imported into the JDK keystore\&. +.PP +Default Privileges Granted to All Code + +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: Yes/Untrusted +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.br +See 3 in Notes Regarding Privileges of Signed JARs\&. +.PP + +.PP +Identity in 1\&.1 database: Yes/Untrusted +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 1 and 3 in Notes Regarding Privileges of Signed JARs\&. +.PP +Default Privileges and Policy File Privileges Granted + +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.PP + +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 2 in Notes Regarding Privileges of Signed JARs\&. +.PP +All Privileges Granted + +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.br +See 1 in Notes Regarding Privileges of Signed JARs\&. +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 1 in Notes Regarding Privileges of Signed JARs\&. +.PP +Notes Regarding Privileges of Signed JARs +.TP 0.4i +1\&. +If an identity or alias is mentioned in the policy file, then it must be imported into the keystore for the policy file to have any effect on privileges granted\&. +.TP 0.4i +2\&. +The policy file/keystore combination has precedence over a trusted identity in the identity database\&. +.TP 0.4i +3\&. +Untrusted identities are ignored in the Java platform\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +keytool(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/java.1 b/jdk/src/bsd/doc/man/java.1 index 4995d6147f3..250396d33c4 100644 --- a/jdk/src/bsd/doc/man/java.1 +++ b/jdk/src/bsd/doc/man/java.1 @@ -1,517 +1,1991 @@ -." Copyright (c) 1994, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH java 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: java.1 +.\" +.if n .pl 99999 +.TH java 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -java \- the Java application launcher -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl - \fP\f3java\fP [ options ] class [ argument ... ] -.fl - \f3java\fP [ options ] \f3\-jar\fP file.jar [ argument ... ] -.fl -.fi +.SH NAME +java \- Launches a Java application\&. +.SH SYNOPSIS +.sp +.nf -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -class -Name of the class to be invoked. -.TP 3 -file.jar -Name of the jar file to be invoked. Used only with \f2\-jar\fP. -.TP 3 -argument -Argument passed to the \f3main\fP function. -.RE +\fBjava\fR [\fIoptions\fR] \fIclassname\fR [\fIargs\fR] +.fi +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3java\fP tool launches a Java application. It does this by starting a Java runtime environment, loading a specified class, and invoking that class's \f3main\fP method. -.LP -.LP -The method must be declared public and static, it must not return any value, and it must accept a \f2String\fP array as a parameter. The method declaration must look like the following: -.LP -.nf -\f3 -.fl -public static void main(String args[]) -.fl -\fP -.fi +\fBjava\fR [\fIoptions\fR] \fB\-jar\fR \fIfilename\fR [\fIargs\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options separated by spaces\&. See Options\&. +.TP +\fIclassname\fR +The name of the class to be launched\&. +.TP +\fIfilename\fR +The name of the Java Archive (JAR) file to be called\&. Used only with the \f3-jar\fR option\&. +.TP +\fIargs\fR +The arguments passed to the \f3main()\fR method separated by spaces\&. +.SH DESCRIPTION +The \f3java\fR command starts a Java application\&. It does this by starting the Java Runtime Environment (JRE), loading the specified class, and calling that class\&'s \f3main()\fR method\&. The method must be declared \fIpublic\fR and \fIstatic\fR, it must not return any value, and it must accept a \f3String\fR array as a parameter\&. The method declaration has the following form: +.sp +.nf +\f3public static void main(String[] args)\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3java\fR command can be used to launch a JavaFX application by loading a class that either has a \f3main()\fR method or that extends \f3javafx\&.application\&.Application\fR\&. In the latter case, the launcher constructs an instance of the \f3Application\fR class, calls its \f3init()\fR method, and then calls the \f3start(javafx\&.stage\&.Stage)\fR method\&. +.PP +By default, the first argument that is not an option of the \f3java\fR command is the fully qualified name of the class to be called\&. If the \f3-jar\fR option is specified, its argument is the name of the JAR file containing class and resource files for the application\&. The startup class must be indicated by the \f3Main-Class\fR manifest header in its source code\&. +.PP +The JRE searches for the startup class (and other classes used by the application) in three sets of locations: the bootstrap class path, the installed extensions, and the user\(cqs class path\&. +.PP +Arguments after the class file name or the JAR file name are passed to the \f3main()\fR method\&. +.SH OPTIONS +The \f3java\fR command supports a wide range of options that can be divided into the following categories: +.TP 0.2i +\(bu +Standard Options +.TP 0.2i +\(bu +Non-Standard Options +.TP 0.2i +\(bu +Advanced Runtime Options +.TP 0.2i +\(bu +Advanced JIT Compiler Options +.TP 0.2i +\(bu +Advanced Serviceability Options +.TP 0.2i +\(bu +Advanced Garbage Collection Options +.PP +Standard options are guaranteed to be supported by all implementations of the Java Virtual Machine (JVM)\&. They are used for common actions, such as checking the version of the JRE, setting the class path, enabling verbose output, and so on\&. +.PP +Non-standard options are general purpose options that are specific to the Java HotSpot Virtual Machine, so they are not guaranteed to be supported by all JVM implementations, and are subject to change\&. These options start with \f3-X\fR\&. +.PP +Advanced options are not recommended for casual use\&. These are developer options used for tuning specific areas of the Java HotSpot Virtual Machine operation that often have specific system requirements and may require privileged access to system configuration parameters\&. They are also not guaranteed to be supported by all JVM implementations, and are subject to change\&. Advanced options start with \f3-XX\fR\&. +.PP +To keep track of the options that were deprecated or removed in the latest release, there is a section named Deprecated and Removed Options at the end of the document\&. +.PP +Boolean options are used to either enable a feature that is disabled by default or disable a feature that is enabled by default\&. Such options do not require a parameter\&. Boolean \f3-XX\fR options are enabled using the plus sign (\f3-XX:+\fR\fIOptionName\fR) and disabled using the minus sign (\f3-XX:-\fR\fIOptionName\fR)\&. +.PP +For options that require an argument, the argument may be separated from the option name by a space, a colon (:), or an equal sign (=), or the argument may directly follow the option (the exact syntax differs for each option)\&. If you are expected to specify the size in bytes, you can use no suffix, or use the suffix \f3k\fR or \f3K\fR for kilobytes (KB), \f3m\fR or \f3M\fR for megabytes (MB), \f3g\fR or \f3G\fR for gigabytes (GB)\&. For example, to set the size to 8 GB, you can specify either \f38g\fR, \f38192m\fR, \f38388608k\fR, or \f38589934592\fR as the argument\&. If you are expected to specify the percentage, use a number from 0 to 1 (for example, specify \f30\&.25\fR for 25%)\&. +.SS STANDARD\ OPTIONS +These are the most commonly used options that are supported by all implementations of the JVM\&. +.TP +-agentlib:\fIlibname\fR[=\fIoptions\fR] +.br +Loads the specified native agent library\&. After the library name, a comma-separated list of options specific to the library can be used\&. -.LP -.LP -By default, the first non\-option argument is the name of the class to be invoked. A fully\-qualified class name should be used. If the \f3\-jar\fP option is specified, the first non\-option argument is the name of a \f3JAR\fP archive containing class and resource files for the application, with the startup class indicated by the \f3Main\-Class\fP manifest header. -.LP -.LP -The Java runtime searches for the startup class, and other classes used, in three sets of locations: the bootstrap class path, the installed extensions, and the user class path. -.LP -.LP -Non\-option arguments after the class name or JAR file name are passed to the \f3main\fP function. -.LP -.SH "OPTIONS" -.LP -.LP -The launcher has a set of standard options that are supported on the current runtime environment and will be supported in future releases. In addition, the current implementations of the virtual machines support a set of non\-standard options that are subject to change in future releases. -.LP -.SH "Standard Options" -.LP -.RS 3 -.TP 3 -\-client -Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM. -.br -.br -For default VM selection, see -.na -\f2Server\-Class Machine Detection\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html -.TP 3 -\-server -Select the Java HotSpot Server VM. On a 64\-bit capable jdk only the Java Hotspot Server VM is supported so the \-server option is implicit. -.br -.br -For default VM selection, see -.na -\f2Server\-Class Machine Detection\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html -.TP 3 -\-agentlib:libname[=options] -Load native agent library \f2libname\fP, e.g. -.br -.br -\-agentlib:hprof -.br -.br -\-agentlib:jdwp=help -.br -.br -\-agentlib:hprof=help -.br -.br -For more information, see -.na -\f2JVMTI Agent Command Line Options\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting. -.TP 3 -\-agentpath:pathname[=options] -Load a native agent library by full pathname. For more information, see -.na -\f2JVMTI Agent Command Line Options\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting. -.TP 3 -\-classpath classpath -.TP 3 -\-cp classpath -Specify a list of directories, JAR archives, and ZIP archives to search for class files. Class path entries are separated by colons (\f3:\fP). Specifying \f3\-classpath\fP or \f3\-cp\fP overrides any setting of the \f3CLASSPATH\fP environment variable. -.br -.br -If \f3\-classpath\fP and \f3\-cp\fP are not used and \f3CLASSPATH\fP is not set, the user class path consists of the current directory (\f4.\fP). -.br -.br -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations). -.br -.br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.br -.br -For more information on class paths, see -.na -\f2Setting the Class Path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath. -.TP 3 -\-Dproperty=value -Set a system property value. -.TP 3 -\-d32 -.TP 3 -\-d64 -Request that the program to be run in a 32\-bit or 64\-bit environment, respectively. If the requested environment is not installed or is not supported, an error is reported. -.br -.br -Currently only the Java HotSpot Server VM supports 64\-bit operation, and the "\-server" option is implicit with the use of \-d64. And the "\-client" option is ignored with the use of \-d64. This is subject to change in a future release. -.br -.br -If neither \f3\-d32\fP nor \f3\-d64\fP is specified, the default is to run in a 32\-bit environment, except for 64\-bit only systems. This is subject to change in a future release. -.TP 3 -\-enableassertions[:"..." | : ] -.TP 3 -\-ea[:"..." | : ] -Enable assertions. Assertions are disabled by default. -.br -.br -With no arguments, \f3enableassertions\fP or \f3\-ea\fP enables assertions. With one argument ending in \f2"..."\fP, the switch enables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch enables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch enables assertions in the specified class. -.br -.br -If a single command line contains multiple instances of these switches, they are processed in order before loading any classes. So, for example, to run a program with assertions enabled only in package \f2com.wombat.fruitbat\fP (and any subpackages), the following command could be used: -.nf -\f3 -.fl -java \-ea:com.wombat.fruitbat...
-.fl -\fP -.fi -The \f3\-enableassertions\fP and \f3\-ea\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-enablesystemassertions\fP below. -.TP 3 -\-disableassertions[:"..." | : ] -.TP 3 -\-da[:"..." | : ] -Disable assertions. This is the default. -.br -.br -With no arguments, \f3disableassertions\fP or \f3\-da\fP disables assertions. With one argument ending in \f2"..."\fP, the switch disables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch disables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch disables assertions in the specified class. -.br -.br -To run a program with assertions enabled in package \f2com.wombat.fruitbat\fP but disabled in class \f2com.wombat.fruitbat.Brickbat\fP, the following command could be used: -.nf -\f3 -.fl -java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat \fP\f4
\fP\f3 -.fl -\fP -.fi -The \f3\-disableassertions\fP and \f3\-da\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-disablesystemassertions\fP below. -.TP 3 -\-enablesystemassertions -.TP 3 -\-esa -Enable asserts in all system classes (sets the \f2default assertion status\fP for system classes to \f2true\fP). -.TP 3 -\-disablesystemassertions -.TP 3 -\-dsa -Disables asserts in all system classes. -.TP 3 -\-jar -Execute a program encapsulated in a JAR file. The first argument is the name of a JAR file instead of a startup class name. In order for this option to work, the manifest of the JAR file must contain a line of the form \f3Main\-Class: \fP\f4classname\fP. Here, \f2classname\fP identifies the class having the \f2public\ static\ void\ main(String[]\ args)\fP method that serves as your application's starting point. See the jar(1) and the Jar trail of the -.na -\f2Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar for information about working with Jar files and Jar\-file manifests. -.br -.br -When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored. -.br -.br -Note that JAR files that can be run with the "java \-jar" option can have their execute permissions set so they can be run without using "java \-jar". Refer to -.na -\f2Java Archive (JAR) Files\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/index.html. -.TP 3 -\-javaagent:jarpath[=options] -Load a Java programming language agent, see -.na -\f2java.lang.instrument\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/lang/instrument/package\-summary.html. -.TP 3 -\-jre\-restrict\-search -Include user\-private JREs in the version search. -.TP 3 -\-no\-jre\-restrict\-search -Exclude user\-private JREs in the version search. -.TP 3 -\-verbose -.TP 3 -\-verbose:class -Display information about each class loaded. -.TP 3 -\-verbose:gc -Report on each garbage collection event. -.TP 3 -\-verbose:jni -Report information about use of native methods and other Java Native Interface activity. -.TP 3 -\-version -Display version information and exit. -.TP 3 -\-version:release -Specifies that the version specified by \f2release\fP is required by the class or jar file specified on the command line. If the version of the java command invoked does not meet this specification and an appropriate implementation is found on the system, the appropriate implementation will be used. -.br -.br -\f2release\fP not only can specify an exact version, but can also specify a list of versions called a version string. A version string is an ordered list of version ranges separated by spaces. A version range is either a version\-id, a version\-id followed by a star (*), a version\-id followed by a plus sign (+) , or two version\-ranges combined using an ampersand (&). The star means prefix match, the plus sign means this version or greater, and the ampersand means the logical anding of the two version\-ranges. For example: -.nf -\f3 -.fl -\-version:"1.6.0_13 1.6*&1.6.0_10+" -.fl -\fP -.fi -The meaning of the above is that the class or jar file requires either version 1.6.0_13, or a version with 1.6 as a version\-id prefix and that is not less than 1.6.0_10.. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56). -.br -.br -For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line. -.br -.br -See the following NOTES section for important policy information on the use of this option. -.TP 3 -\-showversion -Display version information and continue. -.TP 3 -\-? -.TP 3 -\-help -Display usage information and exit. -.TP 3 -\-splash:imagepath -Show splash screen with image specified by \f2imagepath\fP. -.TP 3 -\-X -Display information about non\-standard options and exit. -.RE +If the option \f3-agentlib:foo\fR is specified, then the JVM attempts to load the library named \f3libfoo\&.so\fR in the location specified by the \f3LD_LIBRARY_PATH\fR system variable (on OS X this variable is \f3DYLD_LIBRARY_PATH\fR)\&. -.LP -.SS -Non\-Standard Options -.LP -.RS 3 -.TP 3 -\-Xint -Operate in interpreted\-only mode. Compilation to native code is disabled, and all bytecodes are executed by the interpreter. The performance benefits offered by the Java HotSpot VMs' adaptive compiler will not be present in this mode. -.TP 3 -\-Xbatch -Disable background compilation. Normally the VM will compile the method as a background task, running the method in interpreter mode until the background compilation is finished. The \f2\-Xbatch\fP flag disables background compilation so that compilation of all methods proceeds as a foreground task until completed. -.TP 3 -\-Xbootclasspath:bootclasspath -Specify a colon\-separated list of directories, JAR archives, and ZIP archives to search for boot class files. These are used in place of the boot class files included in the Java platform JDK. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java Runtime Environment binary code license.\fP -.TP 3 -\-Xbootclasspath/a:path -Specify a colon\-separated path of directires, JAR archives, and ZIP archives to append to the default bootstrap class path. -.TP 3 -\-Xbootclasspath/p:path -Specify a colon\-separated path of directires, JAR archives, and ZIP archives to prepend in front of the default bootstrap class path. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java Runtime Environment binary code license.\fP -.TP 3 -\-Xcheck:jni -Perform additional checks for Java Native Interface (JNI) functions. Specifically, the Java Virtual Machine validates the parameters passed to the JNI function as well as the runtime environment data before processing the JNI request. Any invalid data encountered indicates a problem in the native code, and the Java Virtual Machine will terminate with a fatal error in such cases. Expect a performance degradation when this option is used. -.TP 3 -\-Xfuture -Perform strict class\-file format checks. For purposes of backwards compatibility, the default format checks performed by the JDK's virtual machine are no stricter than the checks performed by 1.1.x versions of the JDK software. The \f3\-Xfuture\fP flag turns on stricter class\-file format checks that enforce closer conformance to the class\-file format specification. Developers are encouraged to use this flag when developing new code because the stricter checks will become the default in future releases of the Java application launcher. -.TP 3 -\-Xnoclassgc -Disable class garbage collection. Use of this option will prevent memory recovery from loaded classes thus increasing overall memory usage. This could cause OutOfMemoryError to be thrown in some applications. -.TP 3 -\-Xincgc -Enable the incremental garbage collector. The incremental garbage collector, which is off by default, will reduce the occasional long garbage\-collection pauses during program execution. The incremental garbage collector will at times execute concurrently with the program and during such times will reduce the processor capacity available to the program. -.TP 3 -\-Xloggc:file -Report on each garbage collection event, as with \-verbose:gc, but log this data to \f2file\fP. In addition to the information \f2\-verbose:gc\fP gives, each reported event will be preceeded by the time (in seconds) since the first garbage\-collection event. -.br -.br -Always use a local file system for storage of this file to avoid stalling the JVM due to network latency. The file may be truncated in the case of a full file system and logging will continue on the truncated file. This option overrides \f2\-verbose:gc\fP if both are given on the command line. -.TP 3 -\-Xmsn -Specify the initial size, in bytes, of the memory allocation pool. This value must be a multiple of 1024 greater than 1MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see -.na -\f2HotSpot Ergonomics\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html -.br -.br -Examples: -.nf -\f3 -.fl - \-Xms6291456 -.fl - \-Xms6144k -.fl - \-Xms6m -.fl +The following example shows how to load the heap profiling tool (HPROF) library and get sample CPU information every 20 ms, with a stack depth of 3: +.sp +.nf +\f3\-agentlib:hprof=cpu=samples,interval=20,depth=3\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -\fP -.fi -.TP 3 -\-Xmxn -Specify the maximum size, in bytes, of the memory allocation pool. This value must a multiple of 1024 greater than 2MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see -.na -\f2HotSpot Ergonomics\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html -.br -.br -Examples: -.nf -\f3 -.fl - \-Xmx83886080 -.fl - \-Xmx81920k -.fl - \-Xmx80m -.fl -.fl -\fP -.fi -On Solaris 7 and Solaris 8 SPARC platforms, the upper limit for this value is approximately 4000m minus overhead amounts. On Solaris 2.6 and x86 platforms, the upper limit is approximately 2000m minus overhead amounts. On Bsd platforms, the upper limit is approximately 2000m minus overhead amounts. -.TP 3 -\-Xprof -Profiles the running program, and sends profiling data to standard output. This option is provided as a utility that is useful in program development and is not intended to be used in production systems. -.TP 3 -\-Xrs -Reduces use of operating\-system signals by the Java virtual machine (JVM). -.br -.br -In a previous release, the Shutdown Hooks facility was added to allow orderly shutdown of a Java application. The intent was to allow user cleanup code (such as closing database connections) to run at shutdown, even if the JVM terminates abruptly. -.br -.br -Sun's JVM catches signals to implement shutdown hooks for abnormal JVM termination. The JVM uses SIGHUP, SIGINT, and SIGTERM to initiate the running of shutdown hooks. -.br -.br -The JVM uses a similar mechanism to implement the pre\-1.2 feature of dumping thread stacks for debugging purposes. Sun's JVM uses SIGQUIT to perform thread dumps. -.br -.br -Applications embedding the JVM frequently need to trap signals like SIGINT or SIGTERM, which can lead to interference with the JVM's own signal handlers. The \f3\-Xrs\fP command\-line option is available to address this issue. When \f3\-Xrs\fP is used on Sun's JVM, the signal masks for SIGINT, SIGTERM, SIGHUP, and SIGQUIT are not changed by the JVM, and signal handlers for these signals are not installed. -.br -.br -There are two consequences of specifying \f3\-Xrs\fP: -.RS 3 -.TP 2 -o -SIGQUIT thread dumps are not available. -.TP 2 -o -User code is responsible for causing shutdown hooks to run, for example by calling System.exit() when the JVM is to be terminated. -.RE -.TP 3 -\-Xssn -Set thread stack size. -.TP 3 -\-XX:+UseAltSigs -The VM uses \f2SIGUSR1\fP and \f2SIGUSR2\fP by default, which can sometimes conflict with applications that signal\-chain \f2SIGUSR1\fP and \f2SIGUSR2\fP. The \f2\-XX:+UseAltSigs\fP option will cause the VM to use signals other than \f2SIGUSR1\fP and \f2SIGUSR2\fP as the default. -.RE +The following example shows how to load the Java Debug Wire Protocol (JDWP) library and listen for the socket connection on port 8000, suspending the JVM before the main class loads: +.sp +.nf +\f3\-agentlib:jdwp=transport=dt_socket,server=y,address=8000\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "NOTES" -.LP -.LP -The \f3\-version:\fP\f2release\fP command line option places no restrictions on the complexity of the release specification. However, only a restricted subset of the possible release specifications represent sound policy and only these are fully supported. These policies are: -.LP -.RS 3 -.TP 3 -1. -Any version, represented by not using this option. -.TP 3 -2. -Any version greater than an arbitrarily precise version\-id. For example: -.nf -\f3 -.fl -"1.6.0_10+" -.fl -\fP -.fi -This would utilize any version greater than \f21.6.0_10\fP. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified. -.TP 3 -3. -A version greater than an arbitrarily precise version\-id, bounded by the upper bound of that release family. For example: -.nf -\f3 -.fl -"1.6.0_10+&1.6*" -.fl -\fP -.fi -.TP 3 -4. -"Or" expressions of items 2. or 3. above. For example: -.nf -\f3 -.fl -"1.6.0_10+&1.6* 1.7+" -.fl -\fP -.fi -Similar to item 2. this is useful when a change was introduced in a release (1.7) but also made available in updates to previous releases. -.RE -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are generally returned by the launcher, typically when the launcher is called with the wrong arguments, serious errors, or exceptions thrown from the Java Virtual Machine. However, a Java application may choose to return any value using the API call \f2System.exit(exitValue)\fP. -.LP -.RS 3 -.TP 2 -o -\f20\fP: Successful completion -.TP 2 -o -\f2>0\fP: An error occurred -.RE +For more information about the native agent libraries, refer to the following: +.RS +.TP 0.2i +\(bu +The \f3java\&.lang\&.instrument\fR package description at http://docs\&.oracle\&.com/javase/8/docs/api/java/lang/instrument/package-summary\&.html +.TP 0.2i +\(bu +Agent Command Line Options in the JVM Tools Interface guide at http://docs\&.oracle\&.com/javase/8/docs/platform/jvmti/jvmti\&.html#starting +.RE -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -javac(1) -.TP 2 -o -jdb(1) -.TP 2 -o -javah(1) -.TP 2 -o +.TP +-agentpath:\fIpathname\fR[=\fIoptions\fR] +.br +Loads the native agent library specified by the absolute path name\&. This option is equivalent to \f3-agentlib\fR but uses the full path and file name of the library\&. +.TP +-client +.br +Selects the Java HotSpot Client VM\&. The 64-bit version of the Java SE Development Kit (JDK) currently ignores this option and instead uses the Server JVM\&. + +For default JVM selection, see Server-Class Machine Detection at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/server-class\&.html +.TP +-D\fIproperty\fR=\fIvalue\fR +.br +Sets a system property value\&. The \fIproperty\fR variable is a string with no spaces that represents the name of the property\&. The \fIvalue\fR variable is a string that represents the value of the property\&. If \fIvalue\fR is a string with spaces, then enclose it in quotation marks (for example \f3-Dfoo="foo bar"\fR)\&. +.TP +-d32 +.br +Runs the application in a 32-bit environment\&. If a 32-bit environment is not installed or is not supported, then an error will be reported\&. By default, the application is run in a 32-bit environment unless a 64-bit system is used\&. +.TP +-d64 +.br +Runs the application in a 64-bit environment\&. If a 64-bit environment is not installed or is not supported, then an error will be reported\&. By default, the application is run in a 32-bit environment unless a 64-bit system is used\&. + +Currently only the Java HotSpot Server VM supports 64-bit operation, and the \f3-server\fR option is implicit with the use of \f3-d64\fR\&. The \f3-client\fR option is ignored with the use of \f3-d64\fR\&. This is subject to change in a future release\&. +.TP +.nf +-disableassertions[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR], -da[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR] +.br +.fi +Disables assertions\&. By default, assertions are disabled in all packages and classes\&. + +With no arguments, \f3-disableassertions\fR (\f3-da\fR) disables assertions in all packages and classes\&. With the \fIpackagename\fR argument ending in \f3\&.\&.\&.\fR, the switch disables assertions in the specified package and any subpackages\&. If the argument is simply \f3\&.\&.\&.\fR, then the switch disables assertions in the unnamed package in the current working directory\&. With the \fIclassname\fR argument\f3\fR, the switch disables assertions in the specified class\&. + +The \f3-disableassertions\fR (\f3-da\fR) option applies to all class loaders and to system classes (which do not have a class loader)\&. There is one exception to this rule: if the option is provided with no arguments, then it does not apply to system classes\&. This makes it easy to disable assertions in all classes except for system classes\&. The \f3-disablesystemassertions\fR option enables you to disable assertions in all system classes\&. + +To explicitly enable assertions in specific packages or classes, use the \f3-enableassertions\fR (\f3-ea\fR) option\&. Both options can be used at the same time\&. For example, to run the \f3MyClass\fR application with assertions enabled in package \f3com\&.wombat\&.fruitbat\fR (and any subpackages) but disabled in class \f3com\&.wombat\&.fruitbat\&.Brickbat\fR, use the following command: +.sp +.nf +\f3java \-ea:com\&.wombat\&.fruitbat\&.\&.\&. \-da:com\&.wombat\&.fruitbat\&.Brickbat MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-disablesystemassertions, -dsa +.br +Disables assertions in all system classes\&. +.TP +.nf +-enableassertions[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR], -ea[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR] +.br +.fi +Enables assertions\&. By default, assertions are disabled in all packages and classes\&. + +With no arguments, \f3-enableassertions\fR (\f3-ea\fR) enables assertions in all packages and classes\&. With the \fIpackagename\fR argument ending in \f3\&.\&.\&.\fR, the switch enables assertions in the specified package and any subpackages\&. If the argument is simply \f3\&.\&.\&.\fR, then the switch enables assertions in the unnamed package in the current working directory\&. With the \fIclassname\fR argument\f3\fR, the switch enables assertions in the specified class\&. + +The \f3-enableassertions\fR (\f3-ea\fR) option applies to all class loaders and to system classes (which do not have a class loader)\&. There is one exception to this rule: if the option is provided with no arguments, then it does not apply to system classes\&. This makes it easy to enable assertions in all classes except for system classes\&. The \f3-enablesystemassertions\fR option provides a separate switch to enable assertions in all system classes\&. + +To explicitly disable assertions in specific packages or classes, use the \f3-disableassertions\fR (\f3-da\fR) option\&. If a single command contains multiple instances of these switches, then they are processed in order before loading any classes\&. For example, to run the \f3MyClass\fR application with assertions enabled only in package \f3com\&.wombat\&.fruitbat\fR (and any subpackages) but disabled in class \f3com\&.wombat\&.fruitbat\&.Brickbat\fR, use the following command: +.sp +.nf +\f3java \-ea:com\&.wombat\&.fruitbat\&.\&.\&. \-da:com\&.wombat\&.fruitbat\&.Brickbat MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-enablesystemassertions, -esa +.br +Enables assertions in all system classes\&. +.TP +-help, -? +.br +Displays usage information for the \f3java\fR command without actually running the JVM\&. +.TP +-jar \fIfilename\fR +.br +Executes a program encapsulated in a JAR file\&. The \fIfilename\fR argument is the name of a JAR file with a manifest that contains a line in the form \f3Main-Class:\fR\fIclassname\fR that defines the class with the \f3public static void main(String[] args)\fR method that serves as your application\&'s starting point\&. + +When you use the \f3-jar\fR option, the specified JAR file is the source of all user classes, and other class path settings are ignored\&. + +For more information about JAR files, see the following resources: +.RS +.TP 0.2i +\(bu jar(1) -.TP 2 -o -.na -\f2The Java Extensions Framework\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html -.TP 2 -o -.na -\f2Security Features\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/index.html. -.TP 2 -o -.na -\f2HotSpot VM Specific Options\fP @ -.fi -http://java.sun.com/docs/hotspot/VMOptions.html. +.TP 0.2i +\(bu +The Java Archive (JAR) Files guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jar/index\&.html +.TP 0.2i +\(bu +Lesson: Packaging Programs in JAR Files at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE + +.TP +-javaagent:\fIjarpath\fR[=\fIoptions\fR] +.br +Loads the specified Java programming language agent\&. For more information about instrumenting Java applications, see the \f3java\&.lang\&.instrument\fR package description in the Java API documentation at http://docs\&.oracle\&.com/javase/8/docs/api/java/lang/instrument/package-summary\&.html +.TP +-jre-restrict-search +.br +Includes user-private JREs in the version search\&. +.TP +-no-jre-restrict-search +.br +Excludes user-private JREs from the version search\&. +.TP +-server +.br +Selects the Java HotSpot Server VM\&. The 64-bit version of the JDK supports only the Server VM, so in that case the option is implicit\&. + +For default JVM selection, see Server-Class Machine Detection at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/server-class\&.html +.TP +-showversion +.br +Displays version information and continues execution of the application\&. This option is equivalent to the \f3-version\fR option except that the latter instructs the JVM to exit after displaying version information\&. +.TP +-splash:\fIimgname\fR +.br +Shows the splash screen with the image specified by \fIimgname\fR\&. For example, to show the \f3splash\&.gif\fR file from the \f3images\fR directory when starting your application, use the following option: +.sp +.nf +\f3\-splash:images/splash\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-verbose:class +.br +Displays information about each loaded class\&. +.TP +-verbose:gc +.br +Displays information about each garbage collection (GC) event\&. +.TP +-verbose:jni +.br +Displays information about the use of native methods and other Java Native Interface (JNI) activity\&. +.TP +-version +.br +Displays version information and then exits\&. This option is equivalent to the \f3-showversion\fR option except that the latter does not instruct the JVM to exit after displaying version information\&. +.TP +-version:\fIrelease\fR +.br +Specifies the release version to be used for running the application\&. If the version of the \f3java\fR command called does not meet this specification and an appropriate implementation is found on the system, then the appropriate implementation will be used\&. + +The \fIrelease\fR argument specifies either the exact version string, or a list of version strings and ranges separated by spaces\&. A \fIversion string\fR is the developer designation of the version number in the following form: \f31\&.\fR\fIx\fR\f3\&.0_\fR\fIu\fR (where \fIx\fR is the major version number, and \fIu\fR is the update version number)\&. A \fIversion range\fR is made up of a version string followed by a plus sign (\f3+\fR) to designate this version or later, or a part of a version string followed by an asterisk (\f3*\fR) to designate any version string with a matching prefix\&. Version strings and ranges can be combined using a space for a logical \fIOR\fR combination, or an ampersand (\f3&\fR) for a logical \fIAND\fR combination of two version strings/ranges\&. For example, if running the class or JAR file requires either JRE 6u13 (1\&.6\&.0_13), or any JRE 6 starting from 6u10 (1\&.6\&.0_10), specify the following: +.sp +.nf +\f3\-version:"1\&.6\&.0_13 1\&.6* & 1\&.6\&.0_10+"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Quotation marks are necessary only if there are spaces in the \fIrelease\fR parameter\&. + +For JAR files, the preference is to specify version requirements in the JAR file manifest rather than on the command line\&. +.SS NON-STANDARD\ OPTIONS +These options are general purpose options that are specific to the Java HotSpot Virtual Machine\&. +.TP +-X +.br +Displays help for all available \f3-X\fR options\&. +.TP +-Xbatch +.br +Disables background compilation\&. By default, the JVM compiles the method as a background task, running the method in interpreter mode until the background compilation is finished\&. The \f3-Xbatch\fR flag disables background compilation so that compilation of all methods proceeds as a foreground task until completed\&. + +This option is equivalent to \f3-XX:-BackgroundCompilation\fR\&. +.TP +-Xbootclasspath:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to search for boot class files\&. These are used in place of the boot class files included in the JDK\&. + +\fI\fRDo not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to append to the end of the default bootstrap class path\&. + +Do not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to prepend to the front of the default bootstrap class path\&. + +Do not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xboundthreads +.br +Binds user-level threads to kernel threads\&. +.TP +-Xcheck:jni +.br +Performs additional checks for Java Native Interface (JNI) functions\&. Specifically, it validates the parameters passed to the JNI function and the runtime environment data before processing the JNI request\&. Any invalid data encountered indicates a problem in the native code, and the JVM will terminate with an irrecoverable error in such cases\&. Expect a performance degradation when this option is used\&. +.TP +-Xcomp +.br +Disables interpretation of Java code and compile methods on first invocation\&. By default, the JIT compiler performs 10,000 interpreted method invocations to gather information for efficient compilation\&. To increase compilation performance at the expense of efficiency, use the \f3-Xcomp\fR flag to disable interpreted method invocations\&. + +You can also change the number of interpreted method invocations before compilation using the \f3-XX:CompileThreshold\fR option\&. +.TP +-Xdebug +.br +Does nothing\&. Provided for backward compatibility\&. +.TP +-Xdiag +.br +Shows additional diagnostic messages\&. +.TP +-Xfuture +.br +Enables strict class-file format checks that enforce close conformance to the class-file format specification\&. Developers are encouraged to use this flag when developing new code because the stricter checks will become the default in future releases\&. +.TP +-Xincgc +.br +Enables incremental GC\&. +.TP +-Xint +.br +Runs the application in interpreted-only mode\&. Compilation to native code is disabled, and all bytecode is executed by the interpreter\&. The performance benefits offered by the just in time (JIT) compiler are not present in this mode\&. +.TP +-Xinternalversion +.br +Displays more detailed JVM version information than the \f3-version\fR option, and then exits\&. +.TP +-Xloggc:\fIfilename\fR +.br +Sets the file to which verbose GC events information should be redirected for logging\&. The information written to this file is similar to the output of \f3-verbose:gc\fR with the time elapsed since the first GC event preceding each logged event\&. The \f3-Xloggc\fR option overrides \f3-verbose:gc\fR if both are given with the same \f3java\fR command\&. + +Example: +.sp +.nf +\f3\-Xloggc:garbage\-collection\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xmaxjitcodesize=\fIsize\fR +.br +Specifies the maximum code cache size (in bytes) for JIT-compiled code\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the value is set to 48 MB: +.sp +.nf +\f3\-Xmaxjitcodesize=48m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This option is equivalent to \f3-XX:ReservedCodeCacheSize\fR\&. +.TP +-Xmixed +.br +Executes all bytecode by the interpreter except for hot methods, which are compiled to native code\&. +.TP +-Xmn\fIsize\fR +.br +Sets the initial and maximum size (in bytes) of the heap for the young generation (nursery)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The young generation region of the heap is used for new objects\&. GC is performed in this region more often than in other regions\&. If the size for the young generation is too small, then a lot of minor garbage collections will be performed\&. If the size is too large, then only full garbage collections will be performed, which can take a long time to complete\&. Oracle recommends that you keep the size for the young generation between a half and a quarter of the overall heap size\&. + +The following examples show how to set the initial and maximum size of young generation to 256 MB using various units: +.sp +.nf +\f3\-Xmn256m\fP +.fi +.nf +\f3\-Xmn262144k\fP +.fi +.nf +\f3\-Xmn268435456\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Instead of the \f3-Xmn\fR option to set both the initial and maximum size of the heap for the young generation, you can use \f3-XX:NewSize\fR to set the initial size and \f3-XX:MaxNewSize\fR to set the maximum size\&. +.TP +-Xms\fIsize\fR +.br +Sets the initial size (in bytes) of the heap\&. This value must be a multiple of 1024 and greater than 1 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The following examples show how to set the size of allocated memory to 6 MB using various units: +.sp +.nf +\f3\-Xms6291456\fP +.fi +.nf +\f3\-Xms6144k\fP +.fi +.nf +\f3\-Xms6m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If you do not set this option, then the initial size will be set as the sum of the sizes allocated for the old generation and the young generation\&. The initial size of the heap for the young generation can be set using the \f3-Xmn\fR option or the \f3-XX:NewSize\fR option\&. +.TP +-Xmx\fIsize\fR +.br +Specifies the maximum size (in bytes) of the memory allocation pool in bytes\&. This value must be a multiple of 1024 and greater than 2 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For server deployments, \f3-Xms\fR and \f3-Xmx\fR are often set to the same value\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the maximum allowed size of allocated memory to 80 MB using various units: +.sp +.nf +\f3\-Xmx83886080\fP +.fi +.nf +\f3\-Xmx81920k\fP +.fi +.nf +\f3\-Xmx80m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The \f3-Xmx\fR option is equivalent to \f3-XX:MaxHeapSize\fR\&. +.TP +-Xnoclassgc +.br +Disables garbage collection (GC) of classes\&. This can save some GC time, which shortens interruptions during the application run\&. + +When you specify \f3-Xnoclassgc\fR at startup, the class objects in the application will be left untouched during GC and will always be considered live\&. This can result in more memory being permanently occupied which, if not used carefully, will throw an out of memory exception\&. +.TP +-Xprof +.br +Profiles the running program and sends profiling data to standard output\&. This option is provided as a utility that is useful in program development and is not intended to be used in production systems\&. +.TP +-Xrs +.br +Reduces the use of operating system signals by the JVM\&. + +Shutdown hooks enable orderly shutdown of a Java application by running user cleanup code (such as closing database connections) at shutdown, even if the JVM terminates abruptly\&. + +The JVM catches signals to implement shutdown hooks for unexpected termination\&. The JVM uses \f3SIGHUP\fR, \f3SIGINT\fR, and \f3SIGTERM\fR to initiate the running of shutdown hooks\&. + +The JVM uses a similar mechanism to implement the feature of dumping thread stacks for debugging purposes\&. The JVM uses \f3SIGQUIT\fR to perform thread dumps\&. + +Applications embedding the JVM frequently need to trap signals such as \f3SIGINT\fR or \f3SIGTERM\fR, which can lead to interference with the JVM signal handlers\&. The \f3-Xrs\fR option is available to address this issue\&. When \f3-Xrs\fR is used, the signal masks for \f3SIGINT\fR, \f3SIGTERM\fR, \f3SIGHUP\fR, and \f3SIGQUIT\fR are not changed by the JVM, and signal handlers for these signals are not installed\&. + +There are two consequences of specifying \f3-Xrs\fR: +.RS +.TP 0.2i +\(bu +\f3SIGQUIT\fR thread dumps are not available\&. +.TP 0.2i +\(bu +User code is responsible for causing shutdown hooks to run, for example, by calling \f3System\&.exit()\fR when the JVM is to be terminated\&. +.RE + +.TP +-Xshare:\fImode\fR +.br +Sets the class data sharing mode\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +auto +Use shared class data if possible\&. This is the default value for Java HotSpot 32-Bit Client VM\&. +.TP +on +Require the use of class data sharing\&. Print an error message and exit if class data sharing cannot be used\&. +.TP +off +Do not use shared class data\&. This is the default value for Java HotSpot 32-Bit Server VM, Java HotSpot 64-Bit Client VM, and Java HotSpot 64-Bit Server VM\&. +.TP +dump +Manually generate the class data sharing archive\&. +.RE + +.TP +-XshowSettings:\fIcategory\fR +.br +Shows settings and continues\&. Possible \fIcategory\fR arguments for this option include the following: +.RS +.TP +all +Shows all categories of settings\&. This is the default value\&. +.TP +locale +Shows settings related to locale\&. +.TP +properties +Shows settings related to system properties\&. +.TP +vm +Shows the settings of the JVM\&. +.RE + +.TP +-Xss\fIsize\fR +.br +Sets the thread stack size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate KB, \f3m\fR or \f3M\fR to indicate MB, \f3g\fR or \f3G\fR to indicate GB\&. The default value depends on the platform: +.RS +.TP 0.2i +\(bu +Linux/ARM (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +OS X (64-bit): 1024 KB +.TP 0.2i +\(bu +Oracle Solaris/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Oracle Solaris/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +Windows: depends on virtual memory .RE +.RS +The following examples set the thread stack size to 1024 KB in different units: +.sp +.nf +\f3\-Xss1m\fP +.fi +.nf +\f3\-Xss1024k\fP +.fi +.nf +\f3\-Xss1048576\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP +This option is equivalent to \f3-XX:ThreadStackSize\fR\&. + +.RE +.TP +-Xusealtsigs +.br +Use alternative signals instead of \f3SIGUSR1\fR and \f3SIGUSR2\fR for JVM internal signals\&. This option is equivalent to \f3-XX:+UseAltSigs\fR\&. +.TP +-Xverify:\fImode\fR +.br +Sets the mode of the bytecode verifier\&. Bytecode verification helps to troubleshoot some problems, but it also adds overhead to the running application\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +none +Do not verify the bytecode\&. This reduces startup time and also reduces the protection provided by Java\&. +.TP +remote +Verify only those classes that are loaded remotely over the network\&. This is the default behavior if you do not specify the \f3-Xverify\fR option\&. +.TP +all +Verify all classes\&. +.RE + +.SS ADVANCED\ RUNTIME\ OPTIONS +These options control the runtime behavior of the Java HotSpot VM\&. +.TP +-XX:+DisableAttachMechanism +.br +Enables the option that disables the mechanism that lets tools attach to the JVM\&. By default, this option is disabled, meaning that the attach mechanism is enabled and you can use tools such as \f3jcmd\fR, \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR\&. +.TP +-XX:ErrorFile=\fIfilename\fR +.br +Specifies the path and file name to which error data is written when an irrecoverable error occurs\&. By default, this file is created in the current working directory and named \f3hs_err_pid\fR\fIpid\fR\f3\&.log\fR where \fIpid\fR is the identifier of the process that caused the error\&. The following example shows how to set the default log file (note that the identifier of the process is specified as \f3%p\fR): +.sp +.nf +\f3\-XX:ErrorFile=\&./hs_err_pid%p\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example shows how to set the error log to \f3/var/log/java/java_error\&.log\fR: +.sp +.nf +\f3\-XX:ErrorFile=/var/log/java/java_error\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the file cannot be created in the specified directory (due to insufficient space, permission problem, or another issue), then the file is created in the temporary directory for the operating system\&. The temporary directory is \f3/tmp\fR\&. +.TP +-XX:LargePageSizeInBytes=\fIsize\fR +.br +Sets the maximum size (in bytes) for large pages used for Java heap\&. The \fIsize\fR argument must be a power of 2 (2, 4, 8, 16, \&.\&.\&.)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the size is set to 0, meaning that the JVM chooses the size for large pages automatically\&. + +The following example illustrates how to set the large page size to 4 megabytes (MB): +.sp +.nf +\f3\-XX:LargePageSizeInBytes=4m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxDirectMemorySize=\fIsize\fR +.br +Sets the maximum total size (in bytes) of the New I/O (the \f3java\&.nio\fR package) direct-buffer allocations\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the size is set to 0, meaning that the JVM chooses the size for NIO direct-buffer allocations automatically\&. + +The following examples illustrate how to set the NIO size to 1024 KB in different units: +.sp +.nf +\f3\-XX:MaxDirectMemorySize=1m\fP +.fi +.nf +\f3\-XX:MaxDirectMemorySize=1024k\fP +.fi +.nf +\f3\-XX:MaxDirectMemorySize=1048576\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NativeMemoryTracking=\fImode\fR +.br +Specifies the mode for tracking JVM native memory usage\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +off +Do not track JVM native memory usage\&. This is the default behavior if you do not specify the \f3-XX:NativeMemoryTracking\fR option\&. +.TP +summary +Only track memory usage by JVM subsystems, such as Java heap, class, code, and thread\&. +.TP +detail +In addition to tracking memory usage by JVM subsystems, track memory usage by individual \f3CallSite\fR, individual virtual memory region and its committed regions\&. +.RE + +.TP +-XX:OnError=\fIstring\fR +.br +Sets a custom command or a series of semicolon-separated commands to run when an irrecoverable error occurs\&. If the string contains spaces, then it must be enclosed in quotation marks\&. + +\fI\fRThe following example shows how the \f3-XX:OnError\fR option can be used to run the \f3gcore\fR command to create the core image, and the debugger is started to attach to the process in case of an irrecoverable error (the \f3%p\fR designates the current process): +.sp +.nf +\f3\-XX:OnError="gcore %p;dbx \- %p"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:OnOutOfMemoryError=\fIstring\fR +.br +Sets a custom command or a series of semicolon-separated commands to run when an \f3OutOfMemoryError\fR exception is first thrown\&. If the string contains spaces, then it must be enclosed in quotation marks\&. For an example of a command string, see the description of the \f3-XX:OnError\fR option\&. +.TP +-XX:+PrintCommandLineFlags +.br +Enables printing of ergonomically selected JVM flags that appeared on the command line\&. It can be useful to know the ergonomic values set by the JVM, such as the heap space size and the selected garbage collector\&. By default, this option is disabled and flags are not printed\&. +.TP +-XX:+PrintNMTStatistics +.br +Enables printing of collected native memory tracking data at JVM exit when native memory tracking is enabled (see \f3-XX:NativeMemoryTracking\fR)\&. By default, this option is disabled and native memory tracking data is not printed\&. +.TP +-XX:+ShowMessageBoxOnError +.br +Enables displaying of a dialog box when the JVM experiences an irrecoverable error\&. This prevents the JVM from exiting and keeps the process active so that you can attach a debugger to it to investigate the cause of the error\&. By default, this option is disabled\&. +.TP +-XX:ThreadStackSize=\fIsize\fR +.br +Sets the thread stack size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value depends on the platform: +.RS +.TP 0.2i +\(bu +Linux/ARM (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +OS X (64-bit): 1024 KB +.TP 0.2i +\(bu +Oracle Solaris/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Oracle Solaris/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +Windows: depends on virtual memory +.RE +.RS +The following examples show how to set the thread stack size to 1024 KB in different units: +.sp +.nf +\f3\-XX:ThreadStackSize=1m\fP +.fi +.nf +\f3\-XX:ThreadStackSize=1024k\fP +.fi +.nf +\f3\-XX:ThreadStackSize=1048576\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This option is equivalent to \f3-Xss\fR\&. + +.RE +.TP +-XX:+TraceClassLoading +.br +Enables tracing of classes as they are loaded\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceClassLoadingPreorder +.br +Enables tracing of all loaded classes in the order in which they are referenced\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceClassResolution +.br +Enables tracing of constant pool resolutions\&. By default, this option is disabled and constant pool resolutions are not traced\&. +.TP +-XX:+TraceClassUnloading +.br +Enables tracing of classes as they are unloaded\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceLoaderConstraints +.br +Enables tracing of the loader constraints recording\&. By default, this option is disabled and loader constraints recoding is not traced\&. +.TP +-XX:+UseAltSigs +.br +Enables the use of alternative signals instead of \f3SIGUSR1\fR and \f3SIGUSR2\fR for JVM internal signals\&. By default, this option is disabled and alternative signals are not used\&. This option is equivalent to \f3-Xusealtsigs\fR\&. +.TP +-XX:+UseBiasedLocking +.br +Enables the use of biased locking\&. Some applications with significant amounts of uncontended synchronization may attain significant speedups with this flag enabled, whereas applications with certain patterns of locking may see slowdowns\&. For more information about the biased locking technique, see the example in Java Tuning White Paper at http://www\&.oracle\&.com/technetwork/java/tuning-139912\&.html#section4\&.2\&.5 + +By default, this option is disabled and biased locking is not used\&. +.TP +-XX:+UseCompressedOops +.br +Enables the use of compressed pointers\&. When this option is enabled, object references are represented as 32-bit offsets instead of 64-bit pointers, which typically increases performance when running the application with Java heap sizes less than 32 GB\&. This option works only for 64-bit JVMs\&. + +By default, this option is disabled and compressed pointers are not used\&. +.TP +-XX:+UseLargePages +.br +Enables the use of large page memory\&. This option is enabled by default\&. To disable the use of large page memory, specify \f3-XX:-UseLargePages\fR\&. + +For more information, see Java Support for Large Memory Pages at http://www\&.oracle\&.com/technetwork/java/javase/tech/largememory-jsp-137182\&.html +.TP +-XX:+UseMembar +.br +Enables issuing of membars on thread state transitions\&. This option is disabled by default on all platforms except Power PC and ARM servers, where it is enabled\&. To disable issuing of membars on thread state transitions for Power PC and ARM, specify \f3-XX:-UseMembar\fR\&. +.TP +-XX:+UsePerfData +.br +Enables the \f3perfdata\fR feature\&. This option is enabled by default to allow JVM monitoring and performance testing\&. Disabling it suppresses the creation of the \f3hsperfdata_userid\fR directories\&. To disable the \f3perfdata\fR feature, specify \f3-XX:-UsePerfData\fR\&. +.TP +-XX:+AllowUserSignalHandlers +.br +Enables installation of signal handlers by the application\&. By default, this option is disabled and the application is not allowed to install signal handlers\&. +.SS ADVANCED\ JIT\ COMPILER\ OPTIONS +These options control the dynamic just-in-time (JIT) compilation performed by the Java HotSpot VM\&. +.TP +-XX:+AggressiveOpts +.br +Enables the use of aggressive performance optimization features, which are expected to become default in upcoming releases\&. By default, this option is disabled and experimental performance features are not used\&. +.TP +-XX:AllocateInstancePrefetchLines=\fIlines\fR +.br +Sets the number of lines to prefetch ahead of the instance allocation pointer\&. By default, the number of lines to prefetch is set to 1: +.sp +.nf +\f3\-XX:AllocateInstancePrefetchLines=1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchInstr=\fIinstruction\fR +.br +Sets the prefetch instruction to prefetch ahead of the allocation pointer\&. Possible values are from 0 to 3\&. The actual instructions behind the values depend on the platform\&. By default, the prefetch instruction is set to 0: +.sp +.nf +\f3\-XX:AllocatePrefetchInstr=0\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchStepSize=\fIsize\fR +.br +Sets the step size (in bytes) for sequential prefetch instructions\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the step size is set to 16 bytes: +.sp +.nf +\f3\-XX:AllocatePrefetchStepSize=16\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+BackgroundCompilation +.br +Enables background compilation\&. This option is enabled by default\&. To disable background compilation, specify \f3-XX:-BackgroundCompilation\fR (this is equivalent to specifying \f3-Xbatch\fR)\&. +.TP +-XX:CICompilerCount=\fIthreads\fR +.br +Sets the number of compiler threads to use for compilation\&. By default, the number of threads is set to 2 for the server JVM, to 1 for the client JVM, and it scales to the number of cores if tiered compilation is used\&. The following example shows how to set the number of threads to 2: +.sp +.nf +\f3\-XX:CICompilerCount=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CodeCacheMinimumFreeSpace=\fIsize\fR +.br +Sets the minimum free space (in bytes) required for compilation\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. When less than the minimum free space remains, compiling stops\&. By default, this option is set to 500 KB\&. The following example shows how to set the minimum free space to 1024 MB: +.sp +.nf +\f3\-XX:CodeCacheMinimumFreeSpace=1024m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +.nf +-XX:CompileCommand=\fIcommand\fR,\fIclass\fR\&.\fImethod\fR[,\fIoption\fR] +.br +.fi +Attaches a line to the \f3\&.hotspot_compiler\fR file with the command for the specific method of the class\&. For example, to exclude the \f3indexOf()\fR method of the \f3String\fR class from being compiled, use the following: +.sp +.nf +\f3\-XX:CompileCommand=exclude,java/lang/String\&.indexOf\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Note that you must specify the full class name, including all packages and subpackages separated by a slash (\f3/\fR)\&. + +To add several commands, either specify this option multiple times, or separate each argument with the newline separator (\f3\en\fR)\&. To better understand the syntax of the JVM compiler commands, refer to the description of the \f3-XX:CompileCommandFile\fR option, which enables you to specify the file from which to read compiler commands\&. Notice how the syntax of the command file differs rom the syntax of the argument for the \f3-XX:CompileCommand\fR option\&. The commas and periods in the argument are aliases for spaces in the command file, making it easier to pass compiler commands through a shell\&. To pass arguments to \f3-XX:CompileCommand\fR with the same syntax as that used in the command file, you can enclose the argument in quotation marks: +.sp +.nf +\f3\-XX:CompileCommand="exclude java/lang/String indexOf"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +For easier cut and paste operations, it is also possible to use the method name format produced by the \f3-XX:+PrintCompilation\fR and \f3-XX:+LogCompilation\fR options: +.sp +.nf +\f3\-XX:CompileCommand="exclude java\&.lang\&.String::indexOf"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands are available: +.RS +.TP +break +Set a breakpoint when debugging the JVM to stop at the beginning of compilation of the specified method\&. +.TP +compileonly +Exclude all methods from compilation except for the specified method\&. +.TP +dontinline +Prevent inlining of the specified method\&. +.TP +exclude +Exclude the specified method from compilation\&. +.TP +help +Print a help message for the \f3-XX:CompileCommand\fR option\&. +.TP +inline +Attempt to inline the specified method\&. +.TP +log +Exclude compilation logging (with the \f3-XX:+LogCompilation\fR option) for all methods except for the specified method\&. By default, logging is performed for all compiled methods\&. +.TP +print +Print generated assembler code after compilation of the specified method\&. +.TP +quiet +Do not print the compile commands\&. By default, the commands that you specify with the -\f3XX:CompileCommand\fR option are printed; for example, if you exclude from compilation the \f3indexOf()\fR method of the \f3String\fR class, then the following will be printed to standard output: +.sp +.nf +\f3CompilerOracle: exclude java/lang/String\&.indexOf\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can suppress this by specifying the \f3-XX:CompileCommand=quiet\fR option before other \f3-XX:CompileCommand\fR options\&. +.RE + + +.RS +The optional last argument (\fIoption\fR) can be used to pass a JIT compilation option to the specified method\&. The compilation option is set at the end, after the method name\&. For example, to enable the \f3BlockLayoutByFrequency\fR option for the \f3append()\fR method of the \f3StringBuffer\fR class, use the following: +.sp +.nf +\f3\-XX:CompileCommand=option,java/lang/StringBuffer\&.append,BlockLayoutByFrequency\fP +.fi +.nf +\f3\fP +.fi +.sp + + +.RE +.TP +-XX:CompileCommandFile=\fIfilename\fR +.br +Sets the file from which compiler commands are read\&. By default, the \f3\&.hotspot_compiler\fR file is used to store commands performed by the JVM compiler\&. + +Each line in the command file represents a command, a class name, and a method name for which the command is used (all three parts are separated by spaces)\&. For example, this line prints assembly code for the \f3toString()\fR method of the \f3String\fR class: +.sp +.nf +\f3print java/lang/String toString\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To add commands to the beginning of the \f3\&.hotspot_compiler\fR file, use the \f3-XX:CompileCommand\fR option\&. Note how the syntax of the command file is different from the syntax of the argument for the \f3-XX:CompileCommand\fR option\&. The commas and periods in the argument are aliases for spaces in the command file, making it easier to pass compiler commands through a shell\&. Although it is possible to pass arguments to \f3-XX:CompileCommand\fR with the same syntax as that used in the command file, you would have to enclose the string argument in quotation marks\&. +.TP +-XX:CompileOnly=\fImethods\fR +.br +Sets the list of methods (separated by commas) to which compilation should be restricted\&. Only the specified methods will be compiled\&. Specify each method with the full class name (including the packages and subpackages)\&. For example, to compile only the \f3length()\fR method of the \f3String\fR class and the \f3size()\fR method of the \f3List\fR class, use the following: +.sp +.nf +\f3\-XX:CompileOnly=java/lang/String\&.length,java/util/List\&.size\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CompileThreshold=\fIinvocations\fR +.br +Sets the number of interpreted method invocations before compilation\&. By default, in the server JVM, the JIT compiler performs 10,000 interpreted method invocations to gather information for efficient compilation\&. For the client JVM, the default setting is 1,500 invocations\&. The following example shows how to set the number of interpreted method invocations to 5,000: +.sp +.nf +\f3\-XX:CompileThreshold=5000\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can completely disable interpretation of Java methods before compilation by specifying the \f3-Xcomp\fR option\&. +.TP +-XX:+DoEscapeAnalysis +.br +Enables the use of escape analysis\&. This option is enabled by default\&. To disable the use of escape analysis, specify \f3-XX:-DoEscapeAnalysis\fR\&. +.TP +-XX:+FailOverToOldVerifier +.br +Enables automatic failover to the old verifier when the new type checker fails\&. By default, this option is disabled and it is ignored (that is, treated as disabled) for classes with a recent bytecode version\&. You can enable it for classes with older versions of the bytecode\&. +.TP +-XX:InitialCodeCacheSize=\fIsize\fR +.br +Sets the initial code cache size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is set to 500 KB\&. The following example shows how to set the initial code cache size to 32 KB: +.sp +.nf +\f3\-XX:InitialCodeCacheSize=32k\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+Inline +.br +Enables method inlining\&. This option is enabled by default to increase performance\&. To disable method inlining, specify \f3-XX:-Inline\fR\&. +.TP +-XX:InlineSmallCode=\fIsize\fR +.br +Sets the maximum code size (in bytes) for compiled methods that should be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. Only compiled methods with the size smaller than the specified size will be inlined\&. By default, the maximum code size is set to 1000 bytes: +.sp +.nf +\f3\-XX:InlineSmallCode=1000\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+LogCompilation +.br +Enables logging of compilation activity to a file named \f3hotspot\&.log\fR in the current working directory\&. You can specify a different log file path and name using the \f3-XX:LogFile\fR option\&. + +By default, this option is disabled and compilation activity is not logged\&. The \f3-XX:+LogCompilation\fR option has to be used together with the \f3-XX:UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. + +You can enable verbose diagnostic output with a message printed to the console every time a method is compiled by using the \f3-XX:+PrintCompilation\fR option\&. +.TP +-XX:MaxInlineSize=\fIsize\fR +.br +Sets the maximum bytecode size (in bytes) of a method to be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the maximum bytecode size is set to 35 bytes: +.sp +.nf +\f3\-XX:MaxInlineSize=35\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxNodeLimit=\fInodes\fR +.br +Sets the maximum number of nodes to be used during single method compilation\&. By default, the maximum number of nodes is set to 65,000: +.sp +.nf +\f3\-XX:MaxNodeLimit=65000\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxTrivialSize=\fIsize\fR +.br +Sets the maximum bytecode size (in bytes) of a trivial method to be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the maximum bytecode size of a trivial method is set to 6 bytes: +.sp +.nf +\f3\-XX:MaxTrivialSize=6\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+OptimizeStringConcat +.br +Enables the optimization of \f3String\fR concatenation operations\&. This option is enabled by default\&. To disable the optimization of \f3String\fR concatenation operations, specify \f3-XX:-OptimizeStringConcat\fR\&. +.TP +-XX:+PrintAssembly +.br +Enables printing of assembly code for bytecoded and native methods by using the external \f3disassembler\&.so\fR library\&. This enables you to see the generated code, which may help you to diagnose performance issues\&. + +By default, this option is disabled and assembly code is not printed\&. The \f3-XX:+PrintAssembly\fR option has to be used together with the \f3-XX:UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. +.TP +-XX:+PrintCompilation +.br +Enables verbose diagnostic output from the JVM by printing a message to the console every time a method is compiled\&. This enables you to see which methods actually get compiled\&. By default, this option is disabled and diagnostic output is not printed\&. + +You can also log compilation activity to a file by using the \f3-XX:+LogCompilation\fR option\&. +.TP +-XX:+PrintInlining +.br +Enables printing of inlining decisions\&. This enables you to see which methods are getting inlined\&. + +By default, this option is disabled and inlining information is not printed\&. The \f3-XX:+PrintInlining\fR option has to be used together with the \f3-XX:+UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. +.TP +-XX:+RelaxAccessControlCheck +.br +Decreases the amount of access control checks in the verifier\&. By default, this option is disabled, and it is ignored (that is, treated as disabled) for classes with a recent bytecode version\&. You can enable it for classes with older versions of the bytecode\&. +.TP +-XX:ReservedCodeCacheSize=\fIsize\fR +.br +Sets the maximum code cache size (in bytes) for JIT-compiled code\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. This option is equivalent to \f3-Xmaxjitcodesize\fR\&. +.TP +-XX:+TieredCompilation +.br +Enables the use of tiered compilation\&. By default, this option is disabled and tiered compilation is not used\&. +.TP +-XX:+UseCodeCacheFlushing +.br +Enables flushing of the code cache before shutting down the compiler\&. This option is enabled by default\&. To disable flushing of the code cache before shutting down the compiler, specify \f3-XX:-UseCodeCacheFlushing\fR\&. +.TP +-XX:+UseCondCardMark +.br +Enables checking of whether the card is already marked before updating the card table\&. This option is disabled by default and should only be used on machines with multiple sockets, where it will increase performance of Java applications that rely heavily on concurrent operations\&. +.TP +-XX:+UseSuperWord +.br +Enables the transformation of scalar operations into superword operations\&. This option is enabled by default\&. To disable the transformation of scalar operations into superword operations, specify \f3-XX:-UseSuperWord\fR\&. +.SS ADVANCED\ SERVICEABILITY\ OPTIONS +These options provide the ability to gather system information and perform extensive debugging\&. +.TP +-XX:+ExtendedDTraceProbes +.br +Enables additional \f3dtrace\fR tool probes that impact the performance\&. By default, this option is disabled and \f3dtrace\fR performs only standard probes\&. +.TP +-XX:+HeapDumpOnOutOfMemory +.br +Enables the dumping of the Java heap to a file in the current directory by using the heap profiler (HPROF) when a \f3java\&.lang\&.OutOfMemoryError\fR exception is thrown\&. You can explicitly set the heap dump file path and name using the \f3-XX:HeapDumpPath\fR option\&. By default, this option is disabled and the heap is not dumped when an \f3OutOfMemoryError\fR exception is thrown\&. +.TP +-XX:HeapDumpPath=\fIpath\fR +.br +Sets the path and file name for writing the heap dump provided by the heap profiler (HPROF) when the \f3-XX:+HeapDumpOnOutOfMemoryError\fR option is set\&. By default, the file is created in the current working directory, and it is named \f3java_pid\fR\fIpid\fR\f3\&.hprof\fR where \fIpid\fR is the identifier of the process that caused the error\&. The following example shows how to set the default file explicitly (\f3%p\fR represents the current process identificator): +.sp +.nf +\f3\-XX:HeapDumpPath=\&./java_pid%p\&.hprof\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fI\fRThe following example shows how to set the heap dump file to \f3/var/log/java/java_heapdump\&.hprof\fR: +.sp +.nf +\f3\-XX:HeapDumpPath=/var/log/java/java_heapdump\&.hprof\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:LogFile=\fIpath\fR +.br +Sets the path and file name where log data is written\&. By default, the file is created in the current working directory, and it is named \f3hotspot\&.log\fR\&. + +\fI\fRThe following example shows how to set the log file to \f3/var/log/java/hotspot\&.log\fR: +.sp +.nf +\f3\-XX:LogFile=/var/log/java/hotspot\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+PrintClassHistogram +.br +\fI\fREnables printing of a class instance histogram after a \f3Control+C\fR event (\f3SIGTERM\fR)\&. By default, this option is disabled\&. + +Setting this option is equivalent to running the \f3jmap -histo\fR command, or the \f3jcmd\fR\fIpid\fR\f3GC\&.class_histogram\fR command, where \fIpid\fR is the current Java process identifier\&. +.TP +-XX:+PrintConcurrentLocks + + +Enables printing of j\f3ava\&.util\&.concurrent\fR locks after a \f3Control+C\fR event (\f3SIGTERM\fR)\&. By default, this option is disabled\&. + +Setting this option is equivalent to running the \f3jstack -l\fR command or the \f3jcmd\fR\fIpid\fR\f3Thread\&.print -l\fR command, where \fIpid\fR is the current Java process identifier\&. +.TP +-XX:+UnlockDiagnosticVMOptions +.br +Unlocks the options intended for diagnosing the JVM\&. By default, this option is disabled and diagnostic options are not available\&. +.SS ADVANCED\ GARBAGE\ COLLECTION\ OPTIONS +These options control how garbage collection (GC) is performed by the Java HotSpot VM\&. +.TP +-XX:+AggressiveHeap +.br +Enables Java heap optimization\&. This sets various parameters to be optimal for long-running jobs with intensive memory allocation, based on the configuration of the computer (RAM and CPU)\&. By default, the option is disabled and the heap is not optimized\&. +.TP +-XX:AllocatePrefetchDistance=\fIsize\fR +.br +Sets the size (in bytes) of the prefetch distance for object allocation\&. Memory about to be written with the value of new objects is prefetched up to this distance starting from the address of the last allocated object\&. Each Java thread has its own allocation point\&. + +Negative values denote that prefetch distance is chosen based on the platform\&. Positive values are bytes to prefetch\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is set to -1\&. + +The following example shows how to set the prefetch distance to 1024 bytes: +.sp +.nf +\f3\-XX:AllocatePrefetchDistance=1024\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchLines=\fIlines\fR +.br +Sets the number of cache lines to load after the last object allocation by using the prefetch instructions generated in compiled code\&. The default value is 1 if the last allocated object was an instance, and 3 if it was an array\&. + +The following example shows how to set the number of loaded cache lines to 5: +.sp +.nf +\f3\-XX:AllocatePrefetchLines=5\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchStyle=\fIstyle\fR +.br +Sets the generated code style for prefetch instructions\&. The \fIstyle\fR argument is an integer from 0 to 3: +.RS +.TP +0 +Do not generate prefetch instructions\&. +.TP +1 +Execute prefetch instructions after each allocation\&. This is the default parameter\&. +.TP +2 +Use the thread-local allocation block (TLAB) watermark pointer to determine when prefetch instructions are executed\&. +.TP +3 +Use BIS instruction on SPARC for allocation prefetch\&. +.RE + +.TP +-XX:+AlwaysPreTouch +.br +Enables touching of every page on the Java heap during JVM initialization\&. This gets all pages into the memory before entering the \f3main()\fR method\&. The option can be used in testing to simulate a long-running system with all virtual memory mapped to physical memory\&. By default, this option is disabled and all pages are committed as JVM heap space fills\&. +.TP +-XX:+CMSClassUnloadingEnabled +.br +Enables class unloading when using the concurrent mark-sweep (CMS) garbage collector\&. This option is enabled by default\&. To disable class unloading for the CMS garbage collector, specify \f3-XX:-CMSClassUnloadingEnabled\fR\&. +.TP +-XX:CMSExpAvgFactor=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) used to weight the current sample when computing exponential averages for the concurrent collection statistics\&. By default, the exponential averages factor is set to 25%\&. The following example shows how to set the factor to 15%: +.sp +.nf +\f3\-XX:CMSExpAvgFactor=15\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSIncrementalDutyCycle=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) between minor collections that the concurrent collector is allowed to run\&. When \f3-XX:+CMSIncrementalPacing\fR is enabled, the duty cycle is set automatically, and this option sets only the initial value\&. + +By default, the duty cycle is set to 10%\&. The following example shows how to set the duty cycle to 20%: +.sp +.nf +\f3\-XX:CMSIncrementalDutyCycle=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSIncrementalDutyCycleMin=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) between minor collections that is the lower bound for the duty cycle when \f3-XX:+CMSIncrementalPacing\fR is enabled\&. By default, the lower bound for the duty cycle is set to 0%\&. The following example shows how to set the lower bound to 10%: +.sp +.nf +\f3\-XX:CMSIncrementalDutyCycleMin=10\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSIncrementalMode +.br +Enables the incremental mode for the CMS collector\&. This option is disabled by default and should only be enabled for configurations with no more than two GC threads\&. All options that start with \f3CMSIncremental\fR apply only when this option is enabled\&. +.TP +-XX:CMSIncrementalOffset=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) by which the incremental mode duty cycle is shifted to the right within the period between minor collections\&. By default, the offset is set to 0%\&. The following example shows how to set the duty cycle offset to 25%: +.sp +.nf +\f3\-XX:CMSIncrementalOffset=25\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSIncrementalPacing +.br +Enables automatic adjustment of the incremental mode duty cycle based on statistics collected while the JVM is running\&. This option is enabled by default\&. To disable automatic adjustment of the incremental mode duty cycle, specify \f3-XX:-CMSIncrementalPacing\fR\&. +.TP +-XX:CMSIncrementalSafetyFactor=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) used to add conservatism when computing the duty cycle\&. By default, the safety factor is set to 10%\&. The example below shows how to set the safety factor to 5%: +.sp +.nf +\f3\-XX:CMSIncrementalSafetyFactor=5\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSInitiatingOccupancyFraction=\fIpercent\fR +.br +Sets the percentage of the old generation occupancy (0 to 100) at which to start a CMS collection cycle\&. The default value is set to -1\&. Any negative value (including the default) implies that \f3-XX:CMSTriggerRatio\fR is used to define the value of the initiating occupancy fraction\&. + +The following example shows how to set the occupancy fraction to 20%: +.sp +.nf +\f3\-XX:CMSInitiatingOccupancyFraction=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSScavengeBeforeRemark +.br +Enables scavenging attempts before the CMS remark step\&. By default, this option is disabled\&. +.TP +-XX:CMSTriggerRatio=\fIpercent\fR +.br +Sets the percentage (0 to 100) of the value specified by \f3-XX:MinHeapFreeRatio\fR that is allocated before a CMS collection cycle commences\&. The default value is set to 80%\&. + +The following example shows how to set the occupancy fraction to 75%: +.sp +.nf +\f3\-XX:CMSTriggerRatio=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:ConcGCThreads=\fIthreads\fR +.br +Sets the number of threads used for concurrent GC\&. The default value depends on the number of CPUs available to the JVM\&. + +For example, to set the number of threads for concurrent GC to 2, specify the following option: +.sp +.nf +\f3\-XX:ConcGCThreads=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+DisableExplicitGC +.br +Enables the option that disables processing of calls to \f3System\&.gc()\fR\&. This option is disabled by default, meaning that calls to \f3System\&.gc()\fR are processed\&. If processing of calls to \f3System\&.gc()\fR is disabled, the JVM still performs GC when necessary\&. +.TP +-XX:+ExplicitGCInvokesConcurrent +.br +Enables invoking of concurrent GC by using the \f3System\&.gc()\fR request\&. This option is disabled by default and can be enabled only together with the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:+ExplicitGCInvokesConcurrentAndUnloadsClasses +.br +Enables invoking of concurrent GC by using the \f3System\&.gc()\fR request and unloading of classes during the concurrent GC cycle\&. This option is disabled by default and can be enabled only together with the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:G1HeapRegionSize=\fIsize\fR +.br +Sets the size of the regions into which the Java heap is subdivided when using the garbage-first (G1) collector\&. The value can be between 1 MB and 32 MB\&. The default region size is determined ergonomically based on the heap size\&. + +The following example shows how to set the size of the subdivisions to 16 MB: +.sp +.nf +\f3\-XX:G1HeapRegionSize=16m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+G1PrintHeapRegions +.br +Enables the printing of information about which regions are allocated and which are reclaimed by the G1 collector\&. By default, this option is disabled\&. +.TP +-XX:G1ReservePercent=\fIpercent\fR +.br +Sets the percentage of the heap (0 to 50) that is reserved as a false ceiling to reduce the possibility of promotion failure for the G1 collector\&. By default, this option is set to 10%\&. + +The following example shows how to set the reserved heap to 20%: +.sp +.nf +\f3\-XX:G1ReservePercent=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:InitialHeapSize=\fIsize\fR +.br +Sets the initial size (in bytes) of the memory allocation pool\&. This value must be either 0, or a multiple of 1024 and greater than 1 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the size of allocated memory to 6 MB using various units: +.sp +.nf +\f3\-XX:InitialHeapSize=6291456\fP +.fi +.nf +\f3\-XX:InitialHeapSize=6144k\fP +.fi +.nf +\f3\-XX:InitialHeapSize=6m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If you set this option to 0, then the initial size will be set as the sum of the sizes allocated for the old generation and the young generation\&. The size of the heap for the young generation can be set using the \f3-XX:NewSize\fR option\&. +.TP +-XX:InitialSurvivorRatio=\fIratio\fR +.br +Sets the initial survivor space ratio used by the throughput garbage collector (which is enabled by the \f3-XX:+UseParallelGC\fR and/or -\f3XX:+UseParallelOldGC\fR options)\&. Adaptive sizing is enabled by default with the throughput garbage collector by using the \f3-XX:+UseParallelGC\fR and \f3-XX:+UseParallelOldGC\fR options, and survivor space is resized according to the application behavior, starting with the initial value\&. If adaptive sizing is disabled (using the \f3-XX:-UseAdaptiveSizePolicy\fR option), then the \f3-XX:SurvivorRatio\fR option should be used to set the size of the survivor space for the entire execution of the application\&. + +The following formula can be used to calculate the initial size of survivor space (S) based on the size of the young generation (Y), and the initial survivor space ratio (R): +.sp +.nf +\f3S=Y/(R+2)\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The 2 in the equation denotes two survivor spaces\&. The larger the value specified as the initial survivor space ratio, the smaller the initial survivor space size\&. + +By default, the initial survivor space ratio is set to 8\&. If the default value for the young generation space size is used (2 MB), the initial size of the survivor space will be 0\&.2 MB\&. + +The following example shows how to set the initial survivor space ratio to 4: +.sp +.nf +\f3\-XX:InitialSurvivorRatio=4\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:InitiatingHeapOccupancyPercent=\fIpercent\fR +.br +Sets the percentage of the heap occupancy (0 to 100) at which to start a concurrent GC cycle\&. It is used by garbage collectors that trigger a concurrent GC cycle based on the occupancy of the entire heap, not just one of the generations (for example, the G1 garbage collector)\&. + +By default, the initiating value is set to 45%\&. A value of 0 implies nonstop GC cycles\&. The following example shows how to set the initiating heap occupancy to 75%: +.sp +.nf +\f3\-XX:InitiatingHeapOccupancyPercent=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxGCPauseMillis=\fItime\fR +.br +Sets a target for the maximum GC pause time (in milliseconds)\&. This is a soft goal, and the JVM will make its best effort to achieve it\&. By default, there is no maximum pause time value\&. + +The following example shows how to set the maximum target pause time to 500 ms: +.sp +.nf +\f3\-XX:MaxGCPauseMillis=500\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxHeapSize=\fIsize\fR +.br +Sets the maximum size (in byes) of the memory allocation pool\&. This value must be a multiple of 1024 and greater than 2 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For server deployments, \f3-XX:InitialHeapSize\fR and \f3-XX:MaxHeapSize\fR are often set to the same value\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the maximum allowed size of allocated memory to 80 MB using various units: +.sp +.nf +\f3\-XX:MaxHeapSize=83886080\fP +.fi +.nf +\f3\-XX:MaxHeapSize=81920k\fP +.fi +.nf +\f3\-XX:MaxHeapSize=80m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +On Oracle Solaris 7 and Oracle Solaris 8 SPARC platforms, the upper limit for this value is approximately 4,000 MB minus overhead amounts\&. On Oracle Solaris 2\&.6 and x86 platforms, the upper limit is approximately 2,000 MB minus overhead amounts\&. On Linux platforms, the upper limit is approximately 2,000 MB minus overhead amounts\&. + +The \f3-XX:MaxHeapSize\fR option is equivalent to \f3-Xmx\fR\&. +.TP +-XX:MaxHeapFreeRatio=\fIpercent\fR +.br +Sets the maximum allowed percentage of free heap space (0 to 100) after a GC event\&. If free heap space expands above this value, then the heap will be shrunk\&. By default, this value is set to 70%\&. + +The following example shows how to set the maximum free heap ratio to 75%: +.sp +.nf +\f3\-XX:MaxHeapFreeRatio=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxMetaspaceSize=\fIsize\fR +.br +Sets the maximum amount of native memory that can be allocated for class metadata\&. By default, the size is not limited\&. The amount of metadata for an application depends on the application itself, other running applications, and the amount of memory available on the system\&. + +The following example shows how to set the maximum class metadata size to 256 MB: +.sp +.nf +\f3\-XX:MaxMetaspaceSize=256m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxNewSize=\fIsize\fR +.br +Sets the maximum size (in bytes) of the heap for the young generation (nursery)\&. The default value is set ergonomically\&. +.TP +-XX:MaxTenuringThreshold=\fIthreshold\fR +.br +Sets the maximum tenuring threshold for use in adaptive GC sizing\&. The largest value is 15\&. The default value is 15 for the parallel (throughput) collector, and 6 for the CMS collector\&. + +The following example shows how to set the maximum tenuring threshold to 10: +.sp +.nf +\f3\-XX:MaxTenuringThreshold=10\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MetaspaceSize=\fIsize\fR +.br +Sets the size of the allocated class metadata space that will trigger a garbage collection the first time it is exceeded\&. This threshold for a garbage collection is increased or decreased depending on the amount of metadata used\&. The default size depends on the platform\&. +.TP +-XX:MinHeapFreeRatio=\fIpercent\fR +.br +Sets the minimum allowed percentage of free heap space (0 to 100) after a GC event\&. If free heap space falls below this value, then the heap will be expanded\&. By default, this value is set to 40%\&. + +The following example shows how to set the minimum free heap ratio to 25%: +.sp +.nf +\f3\-XX:MinHeapFreeRatio=25\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NewRatio=\fIratio\fR +.br +Sets the ratio between young and old generation sizes\&. By default, this option is set to 2\&. The following example shows how to set the young/old ratio to 1: +.sp +.nf +\f3\-XX:NewRatio=1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NewSize=\fIsize\fR +.br +Sets the initial size (in bytes) of the heap for the young generation (nursery)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The young generation region of the heap is used for new objects\&. GC is performed in this region more often than in other regions\&. If the size for the young generation is too low, then a large number of minor GCs will be performed\&. If the size is too high, then only full GCs will be performed, which can take a long time to complete\&. Oracle recommends that you keep the size for the young generation between a half and a quarter of the overall heap size\&. + +The following examples show how to set the initial size of young generation to 256 MB using various units: +.sp +.nf +\f3\-XX:NewSize=256m\fP +.fi +.nf +\f3\-XX:NewSize=262144k\fP +.fi +.nf +\f3\-XX:NewSize=268435456\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The \f3-XX:NewSize\fR option is equivalent to \f3-Xmn\fR\&. +.TP +-XX:ParallelGCThreads=\fIthreads\fR +.br +Sets the number of threads used for parallel garbage collection in the young and old generations\&. The default value depends on the number of CPUs available to the JVM\&. + +For example, to set the number of threads for parallel GC to 2, specify the following option: +.sp +.nf +\f3\-XX:ParallelGCThreads=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+ParallelRefProcEnabled +.br +Enables parallel reference processing\&. By default, this option is disabled\&. +.TP +-XX:+PrintAdaptiveSizePolicy +.br +Enables printing of information about adaptive generation sizing\&. By default, this option is disabled\&. +.TP +-XX:+PrintGC +.br +Enables printing of messages at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCApplicationConcurrentTime +.br +Enables printing of how much time elapsed since the last pause (for example, a GC pause)\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCApplicationStoppedTime +.br +Enables printing of how much time the pause (for example, a GC pause) lasted\&. By default, this option is disabled\&. +.TP +-XX+PrintGCDateStamp +.br +Enables printing of a date stamp at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCDetails +.br +Enables printing of detailed messages at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCTaskTimeStamps +.br +Enables printing of time stamps for every individual GC worker thread task\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCTimeStamp +.br +Enables printing of time stamps at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintTenuringDistribution +.br +Enables printing of tenuring age information\&. The following is an example of the output: +.sp +.nf +\f3Desired survivor size 48286924 bytes, new threshold 10 (max 10)\fP +.fi +.nf +\f3\- age 1: 28992024 bytes, 28992024 total\fP +.fi +.nf +\f3\- age 2: 1366864 bytes, 30358888 total\fP +.fi +.nf +\f3\- age 3: 1425912 bytes, 31784800 total\fP +.fi +.nf +\f3\&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Age 1 objects are the youngest survivors (they were created after the previous scavenge, survived the latest scavenge, and moved from eden to survivor space)\&. Age 2 objects have survived two scavenges (during the second scavenge they were copied from one survivor space to the next)\&. And so on\&. + +In the preceding example, 28 992 024 bytes survived one scavenge and were copied from eden to survivor space, 1 366 864 bytes are occupied by age 2 objects, etc\&. The third value in each row is the cumulative size of objects of age n or less\&. + +By default, this option is disabled\&. +.TP +-XX:+ScavengeBeforeFullGC +.br +Enables GC of the young generation before each full GC\&. This option is enabled by default\&. Oracle recommends that you \fIdo not\fR disable it, because scavenging the young generation before a full GC can reduce the number of objects reachable from the old generation space into the young generation space\&. To disable GC of the young generation before each full GC, specify \f3-XX:-ScavengeBeforeFullGC\fR\&. +.TP +-XX:SoftRefLRUPolicyMSPerMB=\fItime\fR +.br +Sets the amount of time (in milliseconds) a softly reachable object is kept active on the heap after the last time it was referenced\&. The default value is one second of lifetime per free megabyte in the heap\&. The \f3-XX:SoftRefLRUPolicyMSPerMB\fR option accepts integer values representing milliseconds per one megabyte of the current heap size (for Java HotSpot Client VM) or the maximum possible heap size (for Java HotSpot Server VM)\&. This difference means that the Client VM tends to flush soft references rather than grow the heap, whereas the Server VM tends to grow the heap rather than flush soft references\&. In the latter case, the value of the \f3-Xmx\fR option has a significant effect on how quickly soft references are garbage collected\&. + +The following example shows how to set the value to 2\&.5 seconds: +.sp +.nf +\f3\-XX:SoftRefLRUPolicyMSPerMB=2500\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:SurvivorRatio=\fIratio\fR +.br +Sets the ratio between eden space size and survivor space size\&. By default, this option is set to 8\&. The following example shows how to set the eden/survivor space ratio to 4: +.sp +.nf +\f3\-XX:SurvivorRatio=4\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:TargetSurvivorRatio=\fIpercent\fR +.br +Sets the desired percentage of survivor space (0 to 100) used after young garbage collection\&. By default, this option is set to 50%\&. + +The following example shows how to set the target survivor space ratio to 30%: +.sp +.nf +\f3\-XX:TargetSurvivorRatio=30\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:TLABSize=\fIsize\fR +.br +Sets the initial size (in bytes) of a thread-local allocation buffer (TLAB)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. If this option is set to 0, then the JVM chooses the initial size automatically\&. + +The following example shows how to set the initial TLAB size to 512 KB: +.sp +.nf +\f3\-XX:TLABSize=512k\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+UseAdaptiveSizePolicy +.br +Enables the use of adaptive generation sizing\&. This option is enabled by default\&. To disable adaptive generation sizing, specify \f3-XX:-UseAdaptiveSizePolicy\fR and set the size of the memory allocation pool explicitly (see the \f3-XX:SurvivorRatio\fR option)\&. +.TP +-XX:+UseCMSInitiatingOccupancyOnly +.br +Enables the use of the occupancy value as the only criterion for initiating the CMS collector\&. By default, this option is disabled and other criteria may be used\&. +.TP +-XX:+UseConcMarkSweepGC +.br +Enables the use of the CMS garbage collector for the old generation\&. Oracle recommends that you use the CMS garbage collector when application latency requirements cannot be met by the throughput (\f3-XX:+UseParallelGC\fR) garbage collector\&. The G1 garbage collector (\f3-XX:+UseG1GC\fR) is another alternative\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. When this option is enabled, the \f3-XX:+UseParNewGC\fR option is automatically set\&. +.TP +-XX:+UseG1GC +.br +Enables the use of the G1 garbage collector\&. It is a server-style garbage collector, targeted for multiprocessor machines with a large amount of RAM\&. It meets GC pause time goals with high probability, while maintaining good throughput\&. The G1 collector is recommended for applications requiring large heaps (sizes of around 6 GB or larger) with limited GC latency requirements (stable and predictable pause time below 0\&.5 seconds)\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. +.TP +-XX:+UseGCOverheadLimit +.br +Enables the use of a policy that limits the proportion of time spent by the JVM on GC before an \f3OutOfMemoryError\fR exception is thrown\&. This option is enabled, by default and the parallel GC will throw an \f3OutOfMemoryError\fR if more than 98% of the total time is spent on garbage collection and less than 2% of the heap is recovered\&. When the heap is small, this feature can be used to prevent applications from running for long periods of time with little or no progress\&. To disable this option, specify \f3-XX:-UseGCOverheadLimit\fR\&. +.TP +-XX:+UseNUMA +.br +Enables performance optimization of an application on a machine with nonuniform memory architecture (NUMA) by increasing the application\&'s use of lower latency memory\&. By default, this option is disabled and no optimization for NUMA is made\&. The option is only available when the parallel garbage collector is used (\f3-XX:+UseParallelGC\fR)\&. +.TP +-XX:+UseParallelGC +.br +Enables the use of the parallel scavenge garbage collector (also known as the throughput collector) to improve the performance of your application by leveraging multiple processors\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. If it is enabled, then the \f3-XX:+UseParallelOldGC\fR option is automatically enabled, unless you explicitly disable it\&. +.TP +-XX:+UseParallelOldGC +.br +Enables the use of the parallel garbage collector for full GCs\&. By default, this option is disabled\&. Enabling it automatically enables the \f3-XX:+UseParallelGC\fR option\&. +.TP +-XX:+UseParNewGC +.br +Enables the use of parallel threads for collection in the young generation\&. By default, this option is disabled\&. It is automatically enabled when you set the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:+UseSerialGC +.br +Enables the use of the serial garbage collector\&. This is generally the best choice for small and simple applications that do not require any special functionality from garbage collection\&. By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. +.TP +-XX:+UseTLAB +.br +Enables the use of thread-local allocation blocks (TLABs) in the young generation space\&. This option is enabled by default\&. To disable the use of TLABs, specify \f3-XX:-UseTLAB\fR\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +These options were included in the previous release, but have since been considered unnecessary\&. +.TP +-Xrun\fIlibname\fR +.br +Loads the specified debugging/profiling library\&. This option was superseded by the \f3-agentlib\fR option\&. +.TP +-XX:CMSInitiatingPermOccupancyFraction=\fIpercent\fR +.br +Sets the percentage of the permanent generation occupancy (0 to 100) at which to start a GC\&. This option was deprecated in JDK 8 with no replacement\&. +.TP +-XX:MaxPermSize=\fIsize\fR +.br +Sets the maximum permanent generation space size (in bytes)\&. This option was deprecated in JDK 8, and superseded by the \f3-XX:MaxMetaspaceSize\fR option\&. +.TP +-XX:PermSize=\fIsize\fR +.br +Sets the space (in bytes) allocated to the permanent generation that triggers a garbage collection if it is exceeded\&. This option was deprecated un JDK 8, and superseded by the \f3-XX:MetaspaceSize\fR option\&. +.TP +-XX:+UseSplitVerifier +.br +Enables splitting of the verification process\&. By default, this option was enabled in the previous releases, and verification was split into two phases: type referencing (performed by the compiler) and type checking (performed by the JVM runtime)\&. This option was deprecated in JDK 8, and verification is now split by default without a way to disable it\&. +.TP +-XX:+UseStringCache +.br +Enables caching of commonly allocated strings\&. This option was removed from JDK 8 with no replacement\&. +.SH PERFORMANCE\ TUNING\ EXAMPLES +The following examples show how to use experimental tuning flags to either optimize throughput or to provide lower response time\&. +.PP +\f3Example 1 Tuning for Higher Throughput\fR +.sp +.nf +\f3java \-d64 \-server \-XX:+AggressiveOpts \-XX:+UseLargePages \-Xmn10g \-Xms26g \-Xmx26g\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Tuning for Lower Response Time\fR +.sp +.nf +\f3java \-d64 \-XX:+UseG1GC \-Xms26g Xmx26g \-XX:MaxGCPauseMillis=500 \-XX:+PrintGCTimeStamp\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXIT\ STATUS +The following exit values are typically returned by the launcher when the launcher is called with the wrong arguments, serious errors, or exceptions thrown by the JVM\&. However, a Java application may choose to return any value by using the API call \f3System\&.exit(exitValue)\fR\&. The values are: +.TP 0.2i +\(bu +\f30\fR: Successful completion +.TP 0.2i +\(bu +\f3>0\fR: An error occurred +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +jar(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/javac.1 b/jdk/src/bsd/doc/man/javac.1 index 2e9c76a343d..3cbc97614b8 100644 --- a/jdk/src/bsd/doc/man/javac.1 +++ b/jdk/src/bsd/doc/man/javac.1 @@ -1,1205 +1,1364 @@ -." Copyright (c) 1994, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javac 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javac.1 +.\" +.if n .pl 99999 +.TH javac 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javac \- Java programming language compiler -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl - \fP\f3javac\fP [ options ] [ sourcefiles ] [ classes ] [ @argfiles ] -.fl +.SH NAME +javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi +\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] +.fi +.sp +Arguments can be in any order: +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIsourcefiles\fR +One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. +.TP +\fIclasses\fR +One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. +.TP +\fI@argfiles\fR +One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. +.SH DESCRIPTION +The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. +.PP +There are two ways to pass source code file names to \f3javac\fR\&. +.TP 0.2i +\(bu +For a small number of source files, list the file names on the command line\&. +.TP 0.2i +\(bu +For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. +.PP +Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. +.PP +Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. +.PP +Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. +.PP +By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. +.SH OPTIONS +The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. +.TP 0.2i +\(bu +See also Cross-Compilation Options +.TP 0.2i +\(bu +See also Nonstandard Options +.SS STANDARD\ OPTIONS +.TP +-A\fIkey\fR[\fI=value\fR] +.br +Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. +.TP +-cp \fIpath\fR or -classpath \fIpath\fR +.br +Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. -.LP -.LP -Arguments may be in any order. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -sourcefiles -One or more source files to be compiled (such as MyClass.java). -.TP 3 -classes -One or more classes to be processed for annotations (such as MyPackage.MyClass). -.TP 3 -@argfiles -One or more files that lists options and source files. The \f2\-J\fP options are not allowed in these files. -.RE +If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3javac\fP tool reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files. It can also process annotations in Java source files and classes. -.LP -.LP -There are two ways to pass source code file names to \f3javac\fP: -.LP -.RS 3 -.TP 2 -o -For a small number of source files, simply list the file names on the command line. -.TP 2 -o -For a large number of source files, list the file names in a file, separated by blanks or line breaks. Then use the list file name on the \f3javac\fP command line, preceded by an \f3@\fP character. -.RE +If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. +.TP +-Djava\&.ext\&.dirs=\fIdirectories\fR +.br +Overrides the location of installed extensions\&. +.TP +-Djava\&.endorsed\&.dirs=\fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-d \fIdirectory\fR +.br +Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. -.LP -.LP -Source code file names must have \f2.java\fP suffixes, class file names must have \f2.class\fP suffixes, and both source and class files must have root names that identify the class. For example, a class called \f2MyClass\fP would be written in a source file called \f2MyClass.java\fP and compiled into a bytecode class file called \f2MyClass.class\fP. -.LP -.LP -Inner class definitions produce additional class files. These class files have names combining the inner and outer class names, such as \f2MyClass$MyInnerClass.class\fP. -.LP -.LP -You should arrange source files in a directory tree that reflects their package tree. For example, if you keep all your source files in \f3/workspace\fP, the source code for \f2com.mysoft.mypack.MyClass\fP should be in \f3/workspace/com/mysoft/mypack/MyClass.java\fP. -.LP -.LP -By default, the compiler puts each class file in the same directory as its source file. You can specify a separate destination directory with \f3\-d\fP (see Options, below). -.LP -.SH "OPTIONS" -.LP -.LP -The compiler has a set of standard options that are supported on the current development environment and will be supported in future releases. An additional set of non\-standard options are specific to the current virtual machine and compiler implementations and are subject to change in the future. Non\-standard options begin with \f3\-X\fP. -.LP -.SS -Standard Options -.LP -.RS 3 -.TP 3 -\-Akey[=value] -Options to pass to annotation processors. These are not interpreted by javac directly, but are made available for use by individual processors. \f2key\fP should be one or more identifiers separated by ".". -.TP 3 -\-cp path or \-classpath path -Specify where to find user class files, and (optionally) annotation processors and source files. This class path overrides the user class path in the \f3CLASSPATH\fP environment variable. If neither \f3CLASSPATH\fP, \f3\-cp\fP nor \f3\-classpath\fP is specified, the user class path consists of the current directory. See Setting the Class Path for more details. +If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. + +If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. + +\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. +.TP +-deprecation .br +Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. +.TP +-encoding \fIencoding\fR .br ->If the \f3\-sourcepath\fP option is not specified, the user class path is also searched for source files. +Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. +.TP +-endorseddirs \fIdirectories\fR .br +Overrides the location of the endorsed standards path\&. +.TP +-extdirs \fIdirectories\fR .br -If the \f3\-processorpath\fP option is not specified, the class path is also searched for annotation processors. -.TP 3 -\-Djava.ext.dirs=directories -Override the location of installed extensions. -.TP 3 -\-Djava.endorsed.dirs=directories -Override the location of endorsed standards path. -.TP 3 -\-d directory -Set the destination directory for class files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, \f3javac\fP puts the class file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-d /home/myclasses\fP and the class is called \f2com.mypackage.MyClass\fP, then the class file is called \f2/home/myclasses/com/mypackage/MyClass.class\fP. +Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. + +If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. +.TP +-g .br +Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. +.TP +-g:none .br -If \f3\-d\fP is not specified, \f3javac\fP puts each class files in the same directory as the source file from which it was generated. +Does not generate any debugging information\&. +.TP +-g:[\fIkeyword list\fR] .br -.br -\f3Note:\fP The directory specified by \f3\-d\fP is not automatically added to your user class path. -.TP 3 -\-deprecation -Show a description of each use or override of a deprecated member or class. Without \f3\-deprecation\fP, \f3javac\fP shows a summary of the source files that use or override deprecated members or classes. \f3\-deprecation\fP is shorthand for \f3\-Xlint:deprecation\fP. -.TP 3 -\-encoding encoding -Set the source file encoding name, such as \f2EUC\-JP and UTF\-8\fP. If \f3\-encoding\fP is not specified, the platform default converter is used. -.TP 3 -\-endorseddirs directories -Override the location of endorsed standards path. -.TP 3 -\-extdirs directories -Overrides the location of the \f2ext\fP directory. The \f2directories\fP variable is a colon\-separated list of directories. Each JAR archive in the specified directories is searched for class files. All JAR archives found are automatically part of the class path. -.br -.br -If you are cross\-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), this option specifies the directories that contain the extension classes. See Cross\-Compilation Options for more information. -.TP 3 -\-g -Generate all debugging information, including local variables. By default, only line number and source file information is generated. -.TP 3 -\-g:none -Do not generate any debugging information. -.TP 3 -\-g:{keyword list} -Generate only some kinds of debugging information, specified by a comma separated list of keywords. Valid keywords are: -.RS 3 -.TP 3 +Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: +.RS +.TP source -Source file debugging information -.TP 3 +Source file debugging information\&. +.TP lines -Line number debugging information -.TP 3 +Line number debugging information\&. +.TP vars -Local variable debugging information -.RE -.TP 3 -\-help -Print a synopsis of standard options. -.TP 3 -\-implicit:{class,none} -Controls the generation of class files for implicitly loaded source files. To automatically generate class files, use \f3\-implicit:class\fP. To suppress class file generation, use \f3\-implicit:none\fP. If this option is not specified, the default is to automatically generate class files. In this case, the compiler will issue a warning if any such class files are generated when also doing annotation processing. The warning will not be issued if this option is set explicitly. See Searching For Types. -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. +Local variable debugging information\&. +.RE + +.TP +-help .br +Prints a synopsis of standard options\&. +.TP +-implicit:[\fIclass, none\fR] .br -\f3Note:\fP \f3CLASSPATH\fP, \f3\-classpath\fP, \f3\-bootclasspath\fP, and \f3\-extdirs\fP do \f2not\fP specify the classes used to run \f3javac\fP. Fiddling with the implementation of the compiler in this way is usually pointless and always risky. If you do need to do this, use the \f3\-J\fP option to pass through options to the underlying \f3java\fP launcher. -.TP 3 -\-nowarn -Disable warning messages. This has the same meaning as \f3\-Xlint:none\fP. -.TP 3 -\-proc: {none,only} -Controls whether annotation processing and/or compilation is done. \f3\-proc:none\fP means that compilation takes place without annotation processing. \f3\-proc:only\fP means that only annotation processing is done, without any subsequent compilation. -.TP 3 -\-processor class1[,class2,class3...] -Names of the annotation processors to run. This bypasses the default discovery process. -.TP 3 -\-processorpath path -Specify where to find annotation processors; if this option is not used, the class path will be searched for processors. -.TP 3 -\-s dir -Specify the directory where to place generated source files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, the compiler puts the source file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-s /home/mysrc\fP and the class is called \f2com.mypackage.MyClass\fP, then the source file will be placed in \f2/home/mysrc/com/mypackage/MyClass.java\fP. -.TP 3 -\-source release -Specifies the version of source code accepted. The following values for \f2release\fP are allowed: -.RS 3 -.TP 3 -1.3 -The compiler does \f2not\fP support assertions, generics, or other language features introduced after JDK 1.3. -.TP 3 -1.4 -The compiler accepts code containing assertions, which were introduced in JDK 1.4. -.TP 3 -1.5 -The compiler accepts code containing generics and other language features introduced in JDK 5. -.TP 3 +Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. + +\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. +.TP +-nowarn +.br +Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. +.TP +-parameters +.br +Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. +.TP +-proc: [\fInone\fR, \fIonly\fR] +.br +Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. +.TP +-processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] +.br +Names of the annotation processors to run\&. This bypasses the default discovery process\&. +.TP +-processorpath \fIpath\fR +.br +Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. +.TP +-s \fIdir\fR +.br +Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. + +If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. +.TP +-source \fIrelease\fR +.br +Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: +.RS +.TP +1\&.3 +The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. +.TP +1\&.4 +The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. +.TP +1\&.5 +The compiler accepts code containing generics and other language features introduced in Java SE 5\&. +.TP 5 -Synonym for 1.5. -.TP 3 -1.6 -This is the default value. No language changes were introduced in Java SE 6. However, encoding errors in source files are now reported as errors, instead of warnings, as previously. -.TP 3 +Synonym for 1\&.5\&. +.TP +1\&.6 +No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. +.TP 6 -Synonym for 1.6. -.TP 3 -1.7 -The compiler accepts code with features introduced in JDK 7. -.TP 3 +Synonym for 1\&.6\&. +.TP +1\&.7 +This is the default value\&. The compiler accepts code with features introduced in Java SE 7\&. +.TP 7 -Synonym for 1.7. -.RE -.TP 3 -\-sourcepath sourcepath -Specify the source code path to search for class or interface definitions. As with the user class path, source path entries are separated by colons (\f3:\fP) and can be directories, JAR archives, or ZIP archives. If packages are used, the local path name within the directory or archive must reflect the package name. -.br -.br -\f3Note:\fP Classes found through the class path may be subject to automatic recompilation if their sources are also found. See Searching For Types. -.TP 3 -\-verbose -Verbose output. This includes information about each class loaded and each source file compiled. -.TP 3 -\-version -Print version information. -.TP 3 -\-Werror -Terminate compilation if warnings occur. -.TP 3 -\-X -Display information about non\-standard options and exit. -.RE +Synonym for 1\&.7\&. +.RE -.LP -.SS -Cross\-Compilation Options -.LP -.LP -By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fP shipped with. But \f3javac\fP also supports \f2cross\-compiling\fP, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation. It is important to use \f3\-bootclasspath\fP and \f3\-extdirs\fP when cross\-compiling; see Cross\-Compilation Example below. -.LP -.RS 3 -.TP 3 -\-target version -Generate class files that target a specified version of the VM. Class files will run on the specified target and on later versions, but not on earlier versions of the VM. Valid targets are \f31.1\fP \f31.2\fP \f31.3\fP \f31.4\fP \f31.5\fP (also \f35\fP) \f31.6\fP (also \f36\fP) and \f31.7\fP (also \f37\fP). +.TP +-sourcepath \fIsourcepath\fR .br +Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. + +\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. +.TP +-verbose .br -The default for \f3\-target\fP depends on the value of \f3\-source\fP: -.RS 3 -.TP 2 -o -If \-source is \f3not specified\fP, the value of \-target is \f31.7\fP -.TP 2 -o -If \-source is \f31.2\fP, the value of \-target is \f31.4\fP -.TP 2 -o -If \-source is \f31.3\fP, the value of \-target is \f31.4\fP -.TP 2 -o -For \f3all other values\fP of \-source, the value of \f3\-target\fP is the value of \f3\-source\fP. -.RE -.TP 3 -\-bootclasspath bootclasspath -Cross\-compile against the specified set of boot classes. As with the user class path, boot class path entries are separated by colons (\f3:\fP) and can be directories, JAR archives, or ZIP archives. -.RE +Uses verbose output, which includes information about each class loaded and each source file compiled\&. +.TP +-version +.br +Prints release information\&. +.TP +-werror +.br +Terminates compilation when warnings occur\&. +.TP +-X +.br +Displays information about nonstandard options and exits\&. +.SS CROSS-COMPILATION\ OPTIONS +By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. +.TP +-target \fIversion\fR +.br +Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), and 1\&.7 (also 7)\&. -.LP -.SS -Non\-Standard Options -.LP -.RS 3 -.TP 3 -\-Xbootclasspath/p:path -Prepend to the bootstrap class path. -.TP 3 -\-Xbootclasspath/a:path -Append to the bootstrap class path. -.TP 3 -\-Xbootclasspath/:path -Override location of bootstrap class files. -.TP 3 -\-Xlint -Enable all recommended warnings. In this release, enabling all available warnings is recommended. -.TP 3 -\-Xlint:all -Enable all recommended warnings. In this release, enabling all available warnings is recommended. -.TP 3 -\-Xlint:none -Disable all warnings. -.TP 3 -\-Xlint:name -Enable warning \f2name\fP. See the section Warnings That Can Be Enabled or Disabled with \-Xlint Option for a list of warnings you can enable with this option. -.TP 3 -\-Xlint:\-name -Disable warning \f2name\fP. See the section Warnings That Can Be Enabled or Disabled with \-Xlint Option for a list of warnings you can disable with this option. -.TP 3 -\-Xmaxerrs number -Set the maximum number of errors to print. -.TP 3 -\-Xmaxwarns number -Set the maximum number of warnings to print. -.TP 3 -\-Xstdout filename -Send compiler messages to the named file. By default, compiler messages go to \f2System.err\fP. -.TP 3 -\-Xprefer:{newer,source} -Specify which file to read when both a source file and class file are found for a type. (See Searching For Types). If \f2\-Xprefer:newer\fP is used, it reads the newer of the source or class file for a type (default). If the \f2\-Xprefer:source\fP option is used, it reads source file. Use \f2\-Xprefer:source\fP when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f2SOURCE\fP. -.TP 3 -\-Xpkginfo:{always,legacy,nonempty} -Specify handling of package\-info files -.TP 3 -\-Xprint -Print out textual representation of specified types for debugging purposes; perform neither annotation processing nor compilation. The format of the output may change. -.TP 3 -\-XprintProcessorInfo -Print information about which annotations a processor is asked to process. -.TP 3 -\-XprintRounds -Print information about initial and subsequent annotation processing rounds. -.RE +The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: +.RS +.TP 0.2i +\(bu +If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.7 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.7 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.7 +.TP 0.2i +\(bu +For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. +.RE -.LP -.SS -Warnings That Can Be Enabled or Disabled with \-Xlint Option -.LP -.LP -Enable warning \f2name\fP with the option \f3\-Xlint:\fP\f2name\fP, where \f2name\fP is one of the following warning names. Similarly, you can disable warning \f2name\fP with the option \f3\-Xlint:\-\fP\f2name\fP: -.LP -.RS 3 -.TP 3 +.TP +-bootclasspath \fIbootclasspath\fR +.br +Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. +.SS COMPACT\ PROFILE\ OPTION +Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. +.PP +The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. +.TP +-profile +.br +When using compact profiles, this option specifies the profile name when compiling\&. For example: +.sp +.nf +\f3javac \-profile compact1 Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: +.sp +.nf +\f3cd jdk1\&.8\&.0/bin\fP +.fi +.nf +\f3\&./javac \-profile compact1 Paint\&.java\fP +.fi +.nf +\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP +.fi +.nf +\f3import java\&.applet\&.Applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) + +An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. +.SS NONSTANDARD\ OPTIONS +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Adds a suffix to the bootstrap class path\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Adds a prefix to the bootstrap class path\&. +.TP +-Xbootclasspath/:\fIpath\fR +.br +Overrides the location of the bootstrap class files\&. +.TP +-Xdoclint:[-]\fIgroup\fR [\fI/access\fR] +.br +Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. + +The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): +.sp +.nf +\f3\-Xdoclint:all/protected\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): +.sp +.nf +\f3\-Xdoclint:all,\-html/package\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xdoclint:none +.br +Disables all groups of checks\&. +.TP +-Xdoclint:all[\fI/access\fR] +.br +Enables all groups of checks\&. +.TP +-Xlint +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:all +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:none +.br +Disables all warnings\&. +.TP +-Xlint:\fIname\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. +.TP +-Xlint:\fI-name\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. +.TP +-Xmaxerrs \fInumber\fR +.br +Sets the maximum number of errors to print\&. +.TP +-Xmaxwarns \fInumber\fR +.br +Sets the maximum number of warnings to print\&. +.TP +-Xstdout \fIfilename\fR +.br +Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. +.TP +-Xprefer:[\fInewer,source\fR] +.br +Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. +.TP +-Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] +.br +Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. +.RS +.TP +always +Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. +.TP +legacy +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. + +\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. +.TP +nonempty +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. +.RE + +.TP +-Xprint +.br +Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. +.TP +-XprintProcessorInfo +.br +Prints information about which annotations a processor is asked to process\&. +.TP +-XprintRounds +.br +Prints information about initial and subsequent annotation processing rounds\&. +.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION +Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. +.TP cast -Warn about unnecessary and redundant casts. For example: -.nf -\f3 -.fl -String s = (String)"Hello!" -.fl -\fP -.fi -.TP 3 +Warns about unnecessary and redundant casts, for example: +.sp +.nf +\f3String s = (String) "Hello!"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP classfile -Warn about issues related to classfile contents. -.TP 3 +Warns about issues related to class file contents\&. +.TP deprecation -Warn about use of deprecated items. For example: -.nf -\f3 -.fl - java.util.Date myDate = new java.util.Date(); -.fl - int currentDay = myDate.getDay(); -.fl -\fP -.fi -The method \f2java.util.Date.getDay\fP has been deprecated since JDK 1.1. -.TP 3 -dep\-ann -Warn about items that are documented with an \f2@deprecated\fP Javadoc comment, but do not have a \f2@Deprecated\fP annotation. For example: -.nf -\f3 -.fl - /** -.fl - * @deprecated As of Java SE 7, replaced by {@link #newMethod()} -.fl - */ -.fl +Warns about the use of deprecated items, for example: +.sp +.nf +\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP +.fi +.nf +\f3int currentDay = myDate\&.getDay();\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - public static void deprecatedMethood() { } -.fl -.fl - public static void newMethod() { } -.fl -\fP -.fi -.TP 3 +The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 +.TP +dep-ann +Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static void deprecatedMethood() { }\fP +.fi +.nf +\f3public static void newMethod() { }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP divzero -Warn about division by constant integer 0. For example: -.nf -\f3 -.fl - int divideByZero = 42 / 0; -.fl -\fP -.fi -.TP 3 +Warns about division by the constant integer 0, for example: +.sp +.nf +\f3int divideByZero = 42 / 0;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP empty -Warn about empty statements after \f2if\fP statements. For example: -.nf -\f3 -.fl -class E { -.fl - void m() { -.fl - if (true) ; -.fl - } -.fl -} -.fl -\fP -.fi -.TP 3 +Warns about empty statements after \f3if\fRstatements, for example: +.sp +.nf +\f3class E {\fP +.fi +.nf +\f3 void m() {\fP +.fi +.nf +\f3 if (true) ;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP fallthrough -Check \f2switch\fP blocks for fall\-through cases and provide a warning message for any that are found. Fall\-through cases are cases in a \f2switch\fP block, other than the last case in the block, whose code does not include a \f2break\fP statement, allowing code execution to "fall through" from that case to the next case. For example, the code following the \f2case 1\fP label in this \f2switch\fP block does not end with a \f2break\fP statement: -.nf -\f3 -.fl -switch (x) { -.fl -case 1: -.fl - System.out.println("1"); -.fl - // No break statement here. -.fl -case 2: -.fl - System.out.println("2"); -.fl -} -.fl -\fP -.fi -If the \f2\-Xlint:fallthrough\fP flag were used when compiling this code, the compiler would emit a warning about "possible fall\-through into case," along with the line number of the case in question. -.TP 3 +Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: +.sp +.nf +\f3switch (x) {\fP +.fi +.nf +\f3case 1:\fP +.fi +.nf +\f3 System\&.out\&.println("1");\fP +.fi +.nf +\f3 // No break statement here\&.\fP +.fi +.nf +\f3case 2:\fP +.fi +.nf +\f3 System\&.out\&.println("2");\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. +.TP finally -Warn about \f2finally\fP clauses that cannot complete normally. For example: -.nf -\f3 -.fl - public static int m() { -.fl - try { -.fl - throw new NullPointerException(); -.fl - } catch (NullPointerException e) { -.fl - System.err.println("Caught NullPointerException."); -.fl - return 1; -.fl - } finally { -.fl - return 0; -.fl - } -.fl - } -.fl -\fP -.fi -The compiler generates a warning for \f2finally\fP block in this example. When this method is called, it returns a value of \f20\fP, not \f21\fP. A \f2finally\fP block always executes when the \f2try\fP block exits. In this example, if control is transferred to the \f2catch\fP, then the method exits. However, the \f2finally\fP block must be executed, so it is executed, even though control has already been transferred outside the method. -.TP 3 +Warns about \f3finally\fR clauses that cannot complete normally, for example: +.sp +.nf +\f3public static int m() {\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3 throw new NullPointerException();\fP +.fi +.nf +\f3 } catch (NullPointerException(); {\fP +.fi +.nf +\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP +.fi +.nf +\f3 return 1;\fP +.fi +.nf +\f3 } finally {\fP +.fi +.nf +\f3 return 0;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. +.TP options -Warn about issues relating to the use of command line options. See Cross\-Compilation Example for an example of this kind of warning. -.TP 3 +Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. +.TP overrides -Warn about issues regarding method overrides. For example, consider the following two classes: -.nf -\f3 -.fl -public class ClassWithVarargsMethod { -.fl - void varargsMethod(String... s) { } -.fl -} -.fl -\fP -.fi -.nf -\f3 -.fl -public class ClassWithOverridingMethod extends ClassWithVarargsMethod { -.fl - @Override -.fl - void varargsMethod(String[] s) { } -.fl -} -.fl -\fP -.fi -The compiler generates a warning similar to the following: -.br -.br -\f2warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod overrides varargsMethod(String...) in ClassWithVarargsMethod; overriding method is missing '...'\fP -.br -.br -When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. In the method \f2ClassWithVarargsMethod.varargsMethod\fP, the compiler translates the varargs formal parameter \f2String... s\fP to the formal parameter \f2String[] s\fP, an array, which matches the formal parameter of the method \f2ClassWithOverridingMethod.varargsMethod\fP. Consequently, this example compiles. -.TP 3 +Warns about issues regarding method overrides\&. For example, consider the following two classes: +.sp +.nf +\f3public class ClassWithVarargsMethod {\fP +.fi +.nf +\f3 void varargsMethod(String\&.\&.\&. s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP +.fi +.nf +\f3 @Override\fP +.fi +.nf +\f3 void varargsMethod(String[] s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning similar to the following:\&. +.sp +.nf +\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP +.fi +.nf +\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP +.fi +.nf +\f3method is missing \&'\&.\&.\&.\&'\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. +.TP path -Warn about invalid path elements and nonexistent path directories on the command line (with regards to the class path, the source path, and other paths). Such warnings cannot be suppressed with the \f2@SuppressWarnings\fP annotation. For example: -.nf -\f3 -.fl -javac \-Xlint:path \-classpath /nonexistentpath Example.java -.fl -\fP -.fi -.TP 3 +Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: +.sp +.nf +\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP processing -Warn about issues regarding annotation processing. The compiler generates this warning if you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception. For example, the following is a simple annotation processor: -.br -.br -\f3Source file \fP\f4AnnoProc.java\fP: -.nf -\f3 -.fl -import java.util.*; -.fl -import javax.annotation.processing.*; -.fl -import javax.lang.model.*; -.fl -import javax.lang.model.element.*; -.fl +Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: -.fl -@SupportedAnnotationTypes("NotAnno") -.fl -public class AnnoProc extends AbstractProcessor { -.fl - public boolean process(Set elems, RoundEnvironment renv) { -.fl - return true; -.fl - } -.fl +\fISource file AnnocProc\&.java\fR: +.sp +.nf +\f3import java\&.util\&.*;\fP +.fi +.nf +\f3import javax\&.annotation\&.processing\&.*;\fP +.fi +.nf +\f3import javax\&.lang\&.model\&.*;\fP +.fi +.nf +\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@SupportedAnnotationTypes("NotAnno")\fP +.fi +.nf +\f3public class AnnoProc extends AbstractProcessor {\fP +.fi +.nf +\f3 public boolean process(Set elems, RoundEnvironment renv){\fP +.fi +.nf +\f3 return true;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public SourceVersion getSupportedSourceVersion() {\fP +.fi +.nf +\f3 return SourceVersion\&.latest();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - public SourceVersion getSupportedSourceVersion() { -.fl - return SourceVersion.latest(); -.fl - } -.fl -} -.fl -\fP -.fi -\f3Source file \fP\f4AnnosWithoutProcessors.java\fP\f3:\fP -.nf -\f3 -.fl -@interface Anno { } -.fl -.fl -@Anno -.fl -class AnnosWithoutProcessors { } -.fl -\fP -.fi -The following commands compile the annotation processor \f2AnnoProc\fP, then run this annotation processor against the source file \f2AnnosWithoutProcessors.java\fP: -.nf -\f3 -.fl -% javac AnnoProc.java -.fl -% javac \-cp . \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors.java -.fl -\fP -.fi -When the compiler runs the annotation processor against the source file \f2AnnosWithoutProcessors.java\fP, it generates the following warning: -.br -.br -\f2warning: [processing] No processor claimed any of these annotations: Anno\fP -.br -.br -To resolve this issue, you can rename the annotation defined and used in the class \f2AnnosWithoutProcessors\fP from \f2Anno\fP to \f2NotAnno\fP. -.TP 3 +\fISource file AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3@interface Anno { }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@Anno\fP +.fi +.nf +\f3class AnnosWithoutProcessors { }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3javac AnnoProc\&.java\fP +.fi +.nf +\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: +.sp +.nf +\f3warning: [processing] No processor claimed any of these annotations: Anno\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. +.TP rawtypes -Warn about unchecked operations on raw types. The following statement generates a \f2rawtypes\fP warning: -.nf -\f3 -.fl -void countElements(List l) { ... } -.fl -\fP -.fi -The following does not generate a \f2rawtypes\fP warning: -.nf -\f3 -.fl -void countElements(List l) { ... } -.fl -\fP -.fi -\f2List\fP is a raw type. However, \f2List\fP is a unbounded wildcard parameterized type. Because \f2List\fP is a parameterized interface, you should always specify its type argument. In this example, the \f2List\fP formal argument is specified with a unbounded wildcard (\f2?\fP) as its formal type parameter, which means that the \f2countElements\fP method can accept any instantiation of the \f2List\fP interface. -.TP 3 -serial -Warn about missing \f2serialVersionUID\fP definitions on serializable classes. For example: -.nf -\f3 -.fl -public class PersistentTime implements Serializable -.fl -{ -.fl - private Date time; -.fl +Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: +.sp +.nf +\f3void countElements(List l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example does not generate a \f3rawtypes\fR warning +.sp +.nf +\f3void countElements(List l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\f3List\fR is a raw type\&. However, \f3List\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. +.TP +Serial +Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: +.sp +.nf +\f3public class PersistentTime implements Serializable\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 private Date time;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public PersistentTime() {\fP +.fi +.nf +\f3 time = Calendar\&.getInstance()\&.getTime();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public Date getTime() {\fP +.fi +.nf +\f3 return time;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - public PersistentTime() { -.fl - time = Calendar.getInstance().getTime(); -.fl - } -.fl -.fl - public Date getTime() { -.fl - return time; -.fl - } -.fl -} -.fl -\fP -.fi The compiler generates the following warning: -.br -.br -\f2warning: [serial] serializable class PersistentTime has no definition of serialVersionUID\fP -.br -.br -If a serializable class does not explicitly declare a field named \f2serialVersionUID\fP, then the serialization runtime will calculate a default \f2serialVersionUID\fP value for that class based on various aspects of the class, as described in the Java Object Serialization Specification. However, it is strongly recommended that all serializable classes explicitly declare \f2serialVersionUID\fP values because the default process of computing \f2serialVersionUID\fP vales is highly sensitive to class details that may vary depending on compiler implementations, and can thus result in unexpected \f2InvalidClassExceptions\fP during deserialization. Therefore, to guarantee a consistent \f2serialVersionUID\fP value across different Java compiler implementations, a serializable class must declare an explicit \f2serialVersionUID\fP value. -.TP 3 +.sp +.nf +\f3warning: [serial] serializable class PersistentTime has no definition of\fP +.fi +.nf +\f3serialVersionUID\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. +.TP static -Warn about issues relating to use of statics. For example: -.nf -\f3 -.fl -class XLintStatic { -.fl - static void m1() { } -.fl - void m2() { this.m1(); } -.fl -} -.fl -\fP -.fi +Warns about issues relating to the use of statics, for example: +.sp +.nf +\f3class XLintStatic {\fP +.fi +.nf +\f3 static void m1() { }\fP +.fi +.nf +\f3 void m2() { this\&.m1(); }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + The compiler generates the following warning: -.nf -\f3 -.fl -warning: [static] static method should be qualified by type name, XLintStatic, instead of by an expression -.fl -\fP -.fi -To resolve this issue, you can call the static method \f2m1\fP as follows: -.nf -\f3 -.fl -XLintStatic.m1(); -.fl -\fP -.fi -Alternatively, you can remove the \f2static\fP keyword from the declaration of the method \f2m1\fP. -.TP 3 +.sp +.nf +\f3warning: [static] static method should be qualified by type name, \fP +.fi +.nf +\f3XLintStatic, instead of by an expression\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: +.sp +.nf +\f3XLintStatic\&.m1();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. +.TP try -Warn about issues relating to use of \f2try\fP blocks, including try\-with\-resources statements. For example, a warning is generated for the following statement because the resource \f2ac\fP declared in the \f2try\fP statement is not used: -.nf -\f3 -.fl -try ( AutoCloseable ac = getResource() ) { -.fl - // do nothing -.fl -} -.fl -\fP -.fi -.TP 3 +Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: +.sp +.nf +\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP unchecked -Give more detail for unchecked conversion warnings that are mandated by the Java Language Specification. For example: -.nf -\f3 -.fl - List l = new ArrayList(); -.fl - List ls = l; // unchecked warning -.fl -\fP -.fi -During type erasure, the types \f2ArrayList\fP and \f2List\fP become \f2ArrayList\fP and \f2List\fP, respectively. -.br -.br -The variable \f2ls\fP has the parameterized type \f2List\fP. When the \f2List\fP referenced by \f2l\fP is assigned to \f2ls\fP, the compiler generates an unchecked warning; the compiler is unable to determine at compile time, and moreover knows that the JVM will not be able to determine at runtime, if \f2l\fP refers to a \f2List\fP type; it does not. Consequently, heap pollution occurs. -.br -.br -In detail, a heap pollution situation occurs when the \f2List\fP object \f2l\fP, whose static type is \f2List\fP, is assigned to another \f2List\fP object, \f2ls\fP, that has a different static type, \f2List\fP. However, the compiler still allows this assignment. It must allow this assignment to preserve backwards compatibility with versions of Java SE that do not support generics. Because of type erasure, \f2List\fP and \f2List\fP both become \f2List\fP. Consequently, the compiler allows the assignment of the object \f2l\fP, which has a raw type of \f2List\fP, to the object \f2ls\fP. -.TP 3 +Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: +.sp +.nf +\f3List l = new ArrayList();\fP +.fi +.nf +\f3List ls = l; // unchecked warning\fP +.fi +.nf +\f3\fP +.fi +.sp + + +During type erasure, the types \f3ArrayList\fR and \f3List\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. + +The \f3ls\fR command has the parameterized type \f3List\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List\fR type\&. In this case, \f3l\fR does not refer to a \f3List\fR type\&. As a result, heap pollution occurs\&. + +A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List\fR and \f3List\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. +.TP varargs -Warn about unsafe usages of variable arguments (varargs) methods, in particular, those that contain non\-reifiable arguments. For example: -.nf -\f3 -.fl -public class ArrayBuilder { -.fl - public static void addToList (List listArg, T... elements) { -.fl - for (T x : elements) { -.fl - listArg.add(x); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi -The compiler generates the following warning for the definition of the method \f2ArrayBuilder.addToList\fP: -.nf -\f3 -.fl -warning: [varargs] Possible heap pollution from parameterized vararg type T -.fl -\fP -.fi -When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. However, the Java programming language does not permit the creation of arrays of parameterized types. In the method \f2ArrayBuilder.addToList\fP, the compiler translates the varargs formal parameter \f2T... elements\fP to the formal parameter \f2T[] elements\fP, an array. However, because of type erasure, the compiler converts the varargs formal parameter to \f2Object[] elements\fP. Consequently, there is a possibility of heap pollution. -.RE +Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: +.sp +.nf +\f3public class ArrayBuilder {\fP +.fi +.nf +\f3 public static void addToList (List listArg, T\&.\&.\&. elements) {\fP +.fi +.nf +\f3 for (T x : elements) {\fP +.fi +.nf +\f3 listArg\&.add(x);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "COMMAND LINE ARGUMENT FILES" -.LP -.LP -To shorten or simplify the javac command line, you can specify one or more files that themselves contain arguments to the \f2javac\fP command (except \f2\-J\fP options). This enables you to create javac commands of any length on any operating system. -.LP -.LP -An argument file can include javac options and source filenames in any combination. The arguments within a file can be space\-separated or newline\-separated. If a filename contains embedded spaces, put the whole filename in double quotes. -.LP -.LP -Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying \f2*.java\fP). Use of the '\f2@\fP' character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -.LP -When executing javac, pass in the path and name of each argument file with the '\f2@\fP' leading character. When javac encounters an argument beginning with the character `\f2@\fP', it expands the contents of that file into the argument list. -.LP -.SS -Example \- Single Arg File -.LP -.LP -You could use a single argument file named "\f2argfile\fP" to hold all javac arguments: -.LP -.nf -\f3 -.fl -% \fP\f3javac @argfile\fP -.fl -.fi -.LP -.LP -This argument file could contain the contents of both files shown in the next example. -.LP -.SS -Example \- Two Arg Files -.LP -.LP -You can create two argument files \-\- one for the javac options and the other for the source filenames: (Notice the following lists have no line\-continuation characters.) -.LP -.LP -Create a file named "\f2options\fP" containing: -.LP -.nf -\f3 -.fl - \-d classes -.fl - \-g -.fl - \-sourcepath /java/pubs/ws/1.3/src/share/classes -.fl +\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. -.fl -\fP -.fi +The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR +.sp +.nf +\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -Create a file named "\f2classes\fP" containing: -.LP -.nf -\f3 -.fl - MyClass1.java -.fl - MyClass2.java -.fl - MyClass3.java -.fl - -.fl -\fP -.fi - -.LP -.LP -You would then run \f3javac\fP with: -.LP -.nf -\f3 -.fl - % \fP\f3javac @options @classes\fP -.fl - -.fl -.fi - -.LP -.SS -Example \- Arg Files with Paths -.LP -.LP -The argument files can have paths, but any filenames inside the files are relative to the current working directory (not \f2path1\fP or \f2path2\fP): -.LP -.nf -\f3 -.fl -% \fP\f3javac @path1/options @path2/classes\fP -.fl -.fi - -.LP -.SH "ANNOTATION PROCESSING" -.LP -.LP -\f3javac\fP provides direct support for annotation processing, superseding the need for the separate annotation processing tool, \f3apt\fP. -.LP -.LP -The API for annotation processors is defined in the \f2javax.annotation.processing\fP and \f2javax.lang.model\fP packages and subpackages. -.LP -.SS -Overview of annotation processing -.LP -.LP -Unless annotation processing is disabled with the \f3\-proc:none\fP option, the compiler searches for any annotation processors that are available. The search path can be specified with the \f3\-processorpath\fP option; if it is not given, the user class path is used. Processors are located by means of service provider\-configuration files named \f2META\-INF/services/javax.annotation.processing.Processor\fP on the search path. Such files should contain the names of any annotation processors to be used, listed one per line. Alternatively, processors can be specified explicitly, using the \f3\-processor\fP option. -.LP -.LP -After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process. When a match is found, the processor will be invoked. A processor may "claim" the annotations it processes, in which case no further attempt is made to find any processors for those annotations. Once all annotations have been claimed, the compiler does not look for additional processors. -.LP -.LP -If any processors generate any new source files, another round of annotation processing will occur: any newly generated source files will be scanned, and the annotations processed as before. Any processors invoked on previous rounds will also be invoked on all subsequent rounds. This continues until no new source files are generated. -.LP -.LP -After a round occurs where no new source files are generated, the annotation processors will be invoked one last time, to give them a chance to complete any work they may need to do. Finally, unless the \f3\-proc:only\fP option is used, the compiler will compile the original and all the generated source files. -.LP -.SS -Implicitly loaded source files -.LP -.LP -To compile a set of source files, the compiler may need to implicitly load additional source files. (See Searching For Types). Such files are currently not subject to annotation processing. By default, the compiler will give a warning if annotation processing has occurred and any implicitly loaded source files are compiled. See the \-implicit option for ways to suppress the warning. -.LP -.SH "SEARCHING FOR TYPES" -.LP -.LP -When compiling a source file, the compiler often needs information about a type whose definition did not appear in the source files given on the command line. The compiler needs type information for every class or interface used, extended, or implemented in the source file. This includes classes and interfaces not explicitly mentioned in the source file but which provide information through inheritance. -.LP -.LP -For example, when you subclass \f3java.applet.Applet\fP, you are also using \f3Applet's\fP ancestor classes: \f3java.awt.Panel\fP, \f3java.awt.Container\fP, \f3java.awt.Component\fP, and \f3java.lang.Object\fP. -.LP -.LP -When the compiler needs type information, it looks for a source file or class file which defines the type. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory). The user class path is defined by setting the \f3CLASSPATH\fP environment variable or by using the \f3\-classpath\fP command line option. (For details, see Setting the Class Path). -.LP -.LP -If you set the \-sourcepath option, the compiler searches the indicated path for source files; otherwise the compiler searches the user class path for both class files and source files. -.LP -.LP -You can specify different bootstrap or extension classes with the \f3\-bootclasspath\fP and \f3\-extdirs\fP options; see Cross\-Compilation Options below. -.LP -.LP -A successful type search may produce a class file, a source file, or both. If both are found, you can use the \-Xprefer option to instruct the compiler which to use. If \f3newer\fP is given, the compiler will use the newer of the two files. If \f3source\fP is given, it will use the source file. The default is \f3newer\fP. -.LP -.LP -If a type search finds a source file for a required type, either by itself, or as a result of the setting for \f3\-Xprefer\fP, the compiler will read the source file to get the information it needs. In addition, it will by default compile the source file as well. You can use the \-implicit option to specify the behavior. If \f3none\fP is given, no class files will be generated for the source file. If \f3class\fP is given, class files will be generated for the source file. -.LP -.LP -The compiler may not discover the need for some type information until after annotation processing is complete. If the type information is found in a source file and no \f3\-implicit\fP option is given, the compiler will give a warning that the file is being compiled without being subject to annotation processing. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3\-implicit\fP option to specify whether or not class files should be generated for such source files. -.LP -.SH "PROGRAMMATIC INTERFACE" -.LP -.LP -\f3javac\fP supports the new Java Compiler API defined by the classes and interfaces in the \f2javax.tools\fP package. -.LP -.SS -Example -.LP -.LP -To perform a compilation using arguments as you would give on the command line, you can use the following: -.LP -.nf -\f3 -.fl -JavaCompiler javac = ToolProvider.getSystemJavaCompiler(); -.fl -int rc = javac.run(null, null, null, args); -.fl -\fP -.fi - -.LP -.LP -This will write any diagnostics to the standard output stream, and return the exit code that \f3javac\fP would give when invoked from the command line. -.LP -.LP -You can use other methods on the \f2javax.tools.JavaCompiler\fP interface to handle diagnostics, control where files are read from and written to, and so on. -.LP -.SS -Old Interface -.LP -.LP -\f3Note:\fP This API is retained for backwards compatibility only; all new code should use the Java Compiler API, described above. -.LP -.LP -The \f2com.sun.tools.javac.Main\fP class provides two static methods to invoke the compiler from a program: -.LP -.nf -\f3 -.fl -public static int compile(String[] args); -.fl -public static int compile(String[] args, PrintWriter out); -.fl -\fP -.fi - -.LP -.LP -The \f2args\fP parameter represents any of the command line arguments that would normally be passed to the javac program and are outlined in the above Synopsis section. -.LP -.LP -The \f2out\fP parameter indicates where the compiler's diagnostic output is directed. -.LP -.LP -The return value is equivalent to the exit value from \f3javac\fP. -.LP -.LP -Note that all \f3other\fP classes and methods found in a package whose name starts with \f2com.sun.tools.javac\fP (informally known as sub\-packages of \f2com.sun.tools.javac\fP) are strictly internal and subject to change at any time. -.LP -.SH "EXAMPLES" -.LP -.SS -Compiling a Simple Program -.LP -.LP -One source file, \f2Hello.java\fP, defines a class called \f3greetings.Hello\fP. The \f2greetings\fP directory is the package directory both for the source file and the class file and is off the current directory. This allows us to use the default user class path. It also makes it unnecessary to specify a separate destination directory with \f3\-d\fP. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -greetings/ -.fl -% \f3ls greetings\fP -.fl -Hello.java -.fl -% \f3cat greetings/Hello.java\fP -.fl -package greetings; -.fl - -.fl -public class Hello { -.fl - public static void main(String[] args) { -.fl - for (int i=0; i < args.length; i++) { -.fl - System.out.println("Hello " + args[i]); -.fl - } -.fl - } -.fl -} -.fl -% \f3javac greetings/Hello.java\fP -.fl -% \f3ls greetings\fP -.fl -Hello.class Hello.java -.fl -% \f3java greetings.Hello World Universe Everyone\fP -.fl -Hello World -.fl -Hello Universe -.fl -Hello Everyone -.fl -.fi - -.LP -.SS -Compiling Multiple Source Files -.LP -.LP -This example compiles all the source files in the package \f2greetings\fP. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -greetings/ -.fl -% \f3ls greetings\fP -.fl -Aloha.java GutenTag.java Hello.java Hi.java -.fl -% \f3javac greetings/*.java\fP -.fl -% \f3ls greetings\fP -.fl -Aloha.class GutenTag.class Hello.class Hi.class -.fl -Aloha.java GutenTag.java Hello.java Hi.java -.fl -.fi - -.LP -.SS -Specifying a User Class Path -.LP -.LP -Having changed one of the source files in the previous example, we recompile it: -.LP -.nf -\f3 -.fl -% \fP\f3pwd\fP -.fl -/examples -.fl -% \f3javac greetings/Hi.java\fP -.fl -.fi - -.LP -.LP -Since \f2greetings.Hi\fP refers to other classes in the \f2greetings\fP package, the compiler needs to find these other classes. The example above works, because our default user class path happens to be the directory containing the package directory. But suppose we want to recompile this file and not worry about which directory we're in? Then we need to add \f2/examples\fP to the user class path. We can do this by setting \f3CLASSPATH\fP, but here we'll use the \f3\-classpath\fP option. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-classpath /examples /examples/greetings/Hi.java\fP -.fl -.fi - -.LP -.LP -If we change \f2greetings.Hi\fP again, to use a banner utility, that utility also needs to be accessible through the user class path. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-classpath /examples:/lib/Banners.jar \\ -.fl - /examples/greetings/Hi.java\fP -.fl -.fi - -.LP -.LP -To execute a class in \f2greetings\fP, we need access both to \f2greetings\fP and to the classes it uses. -.LP -.nf -\f3 -.fl -% \fP\f3java \-classpath /examples:/lib/Banners.jar greetings.Hi\fP -.fl -.fi - -.LP -.SS -Separating Source Files and Class Files -.LP -.LP -It often makes sense to keep source files and class files in separate directories, especially on large projects. We use \f3\-d\fP to indicate the separate class file destination. Since the source files are not in the user class path, we use \f3\-sourcepath\fP to help the compiler find them. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -classes/ lib/ src/ -.fl -% \f3ls src\fP -.fl -farewells/ -.fl -% \f3ls src/farewells\fP -.fl -Base.java GoodBye.java -.fl -% \f3ls lib\fP -.fl -Banners.jar -.fl -% \f3ls classes\fP -.fl -% \f3javac \-sourcepath src \-classpath classes:lib/Banners.jar \\ -.fl - src/farewells/GoodBye.java \-d classes\fP -.fl -% \f3ls classes\fP -.fl -farewells/ -.fl -% \f3ls classes/farewells\fP -.fl -Base.class GoodBye.class -.fl -.fi - -.LP -.LP -\f3Note:\fP The compiler compiled \f2src/farewells/Base.java\fP, even though we didn't specify it on the command line. To trace automatic compiles, use the \f3\-verbose\fP option. -.LP -.SS -Cross\-Compilation Example -.LP -.LP -Here we use \f3javac\fP to compile code that will run on a 1.6 VM. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-source 1.6 \-target 1.6 \-bootclasspath jdk1.6.0/lib/rt.jar \\ -.fl - \-extdirs "" OldCode.java\fP -.fl -.fi - -.LP -.LP -The \f2\-source 1.6\fP option specifies that version 1.6 (or 6) of the Java programming language be used to compile \f2OldCode.java\fP. The option \f3\-target 1.6\fP option ensures that the generated class files will be compatible with 1.6 VMs. Note that in most cases, the value of the \f3\-target\fP option is the value of the \f3\-source\fP option; in this example, you can omit the \f3\-target\fP option. -.LP -.LP -You must specify the \f3\-bootclasspath\fP option to specify the correct version of the bootstrap classes (the \f2rt.jar\fP library). If not, the compiler generates a warning: -.LP -.nf -\f3 -.fl -% \fP\f3javac \-source 1.6 OldCode.java\fP -.fl -warning: [options] bootstrap class path not set in conjunction with \-source 1.6 -.fl -.fi - -.LP -.LP -If you do not specify the correct version of bootstrap classes, the compiler will use the old language rules (in this example, it will use version 1.6 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to non\-existent methods can get included. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -.na -\f2The javac Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javac/index.html -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jdb(1) \- Java Application Debugger -.TP 2 -o -javah(1) \- C Header and Stub File Generator -.TP 2 -o -javap(1) \- Class File Disassembler -.TP 2 -o -javadoc(1) \- API Documentation Generator -.TP 2 -o -jar(1) \- JAR Archive Tool -.TP 2 -o -.na -\f2The Java Extensions Framework\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html -.RE - -.LP +When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: +.sp +.nf +\f3javac @argfile\fP +.fi +.nf +\f3\fP +.fi +.sp +This argument file could contain the contents of both files shown in Example 2 +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains the following: +.sp +.nf +\f3\-d classes\fP +.fi +.nf +\f3\-g\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named classes that contains the following: +.sp +.nf +\f3MyClass1\&.java\fP +.fi +.nf +\f3MyClass2\&.java\fP +.fi +.nf +\f3MyClass3\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Then, run the \f3javac\fR command as follows: +.sp +.nf +\f3javac @options @classes\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javac @path1/options @path2/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH ANNOTATION\ PROCESSING +The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. +.PP +The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. +.SS HOW\ ANNOTATION\ PROCESSING\ WORKS +Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. +.PP +After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. +.PP +If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. +.PP +After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. +.SS IMPLICITLY\ LOADED\ SOURCE\ FILES +To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. +.SH SEARCHING\ FOR\ TYPES +To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. +.PP +For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. +.PP +When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. +.PP +If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. +.PP +You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. +.PP +A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. +.PP +If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. +.PP +The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. +.SH PROGRAMMATIC\ INTERFACE +The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. +.SS EXAMPLE +To compile as though providing command-line arguments, use the following syntax: +.sp +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3\fP +.fi +.sp +The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. +.PP +You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. +.SS OLD\ INTERFACE +\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. +.PP +The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: +.sp +.nf +\f3public static int compile(String[] args);\fP +.fi +.nf +\f3public static int compile(String[] args, PrintWriter out);\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. +.PP +The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. +.PP +The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. +.PP +\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. +.SH EXAMPLES +\f3Example 1 Compile a Simple Program\fR +.PP +This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. +.PP +The source code in \f3Hello\&.java\fR: +.sp +.nf +\f3package greetings;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Hello {\fP +.fi +.nf +\f3 public static void main(String[] args) {\fP +.fi +.nf +\f3 for (int i=0; i < args\&.length; i++) {\fP +.fi +.nf +\f3 System\&.out\&.println("Hello " + args[i]);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +Compile greetings\&.Hello: +.sp +.nf +\f3javac greetings/Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Run \f3greetings\&.Hello\fR: +.sp +.nf +\f3java greetings\&.Hello World Universe Everyone\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3Hello Universe\fP +.fi +.nf +\f3Hello Everyone\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Compile Multiple Source Files\fR +.PP +This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. +.sp +.nf +\f3% javac greetings/*\&.java\fP +.fi +.nf +\f3% ls greetings\fP +.fi +.nf +\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP +.fi +.nf +\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Specify a User Class Path\fR +.PP +After changing one of the source files in the previous example, recompile it: +.sp +.nf +\f3pwd\fP +.fi +.nf +\f3/examples\fP +.fi +.nf +\f3javac greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. +.sp +.nf +\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. +.sp +.nf +\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP +.fi +.nf +\f3 /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. +.sp +.nf +\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Separate Source Files and Class Files\fR +.PP +The following example uses \f3javac\fR to compile code that runs on JVM 1\&.6\&. +.sp +.nf +\f3javac \-source 1\&.6 \-target 1\&.6 \-bootclasspath jdk1\&.6\&.0/lib/rt\&.jar \e \fP +.fi +.nf +\f3\-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3-source 1\&.6\fR option specifies that release 1\&.6 (or 6) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.6\fR option ensures that the generated class files are compatible with JVM 1\&.6\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.6 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \fP +.fi +.nf +\f3\-source 1\&.6\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.6 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to nonexistent methods can get included\&. +.PP +\f3Example 5 Cross Compile\fR +.PP +This example uses \f3javac\fR to compile code that runs on JVM 1\&.6\&. +.sp +.nf +\f3javac \-source 1\&.6 \-target 1\&.6 \-bootclasspath jdk1\&.6\&.0/lib/rt\&.jar \e\fP +.fi +.nf +\f3 \-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The\f3-source 1\&.6\fR option specifies that release 1\&.6 (or 6) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.6\fR option ensures that the generated class files are compatible with JVM 1\&.6\&. In most cases, the value of the \f3-target\fR is the value of \f3-source\fR\&. In this example, the \f3-target\fR option is omitted\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.6 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.6\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.6 of the Java programming language\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jdb(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/javadoc.1 b/jdk/src/bsd/doc/man/javadoc.1 index 7ccc12b7a2d..b48535a388a 100644 --- a/jdk/src/bsd/doc/man/javadoc.1 +++ b/jdk/src/bsd/doc/man/javadoc.1 @@ -1,4226 +1,2997 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javadoc 1 "10 May 2011" -.SH "Name" -javadoc \- The Java API Documentation Generator -.LP -Generates HTML pages of API documentation from Java source files. This document contains Javadoc examples for Solaris. -.SH "SYNOPSIS" -.LP -\f4javadoc\fP\f2\ [\ \fP\f2options\fP\f2\ ]\ [\ packagenames\ ]\ [\ sourcefilenames\ ]\ [\ \-subpackages\fP\ \f2pkg1:pkg2:...\fP\f2\ ]\ [\ \fP\f2@argfiles\fP\f2\ ]\fP -.LP -Arguments can be in any order. See processing of Source Files for details on how the Javadoc tool determines which "\f2.java\fP" files to process. -.RS 3 -.TP 3 -options -Command\-line options, as specified in this document. To see a typical use of javadoc options, see Real\-World Example. -.TP 3 -packagenames -A series of names of packages, separated by spaces, such as \f2java.lang\ java.lang.reflect\ java.awt\fP. You must separately specify each package you want to document. Wildcards are not allowed; use \-subpackages for recursion. The Javadoc tool uses \f2\-sourcepath\fP to look for these package names. See Example \- Documenting One or More Packages -.TP 3 -sourcefilenames -A series of source file names, separated by spaces, each of which can begin with a path and contain a wildcard such as asterisk (*). The Javadoc tool will process every file whose name ends with ".java", and whose name, when stripped of that suffix, is actually a legal class name (see the Java Language Specification). Therefore, you can name files with dashes (such as \f2X\-Buffer\fP), or other illegal characters, to prevent them from being documented. This is useful for test files and template files The path that precedes the source file name determines where javadoc will look for the file. (The Javadoc tool does \f2not\fP use \f2\-sourcepath\fP to look for these source file names.) Relative paths are relative to the current directory, so passing in \f2Button.java\fP is identical to \f2./Button.java\fP. A source file name with an absolute path and a wildcard, for example, is \f2/home/src/java/awt/Graphics*.java\fP. See Example\ \-\ Documenting One or More Classes. You can also mix packagenames and sourcefilenames, as in Example\ \-\ Documenting Both Packages and Classes -.TP 3 -\-subpackages pkg1:pkg2:... -Generates documentation from source files in the specified packages and recursively in their subpackages. An alternative to supplying packagenames or sourcefilenames. -.TP 3 -@argfiles -One or more files that contain a list of Javadoc options, packagenames and sourcefilenames in any order. Wildcards (*) and \f2\-J\fP options are not allowed in these files. -.RE -.SH "DESCRIPTION" -.LP -The \f3Javadoc\fP tool parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields. You can use it to generate the API (Application Programming Interface) documentation or the implementation documentation for a set of source files. -.LP -You can run the Javadoc tool on entire packages, individual source files, or both. When documenting entire packages, you can either use \f2\-subpackages\fP for traversing recursively down from a top\-level directory, or pass in an explicit list of package names. When documenting individual source files, you pass in a list of source (\f2.java\fP) filenames. Examples are given at the end of this document. How Javadoc processes source files is covered next. -.SS -Processing of source files -.LP -The Javadoc tool processes files that end in "\f2.java\fP" plus other files described under Source Files. If you run the Javadoc tool by explicitly passing in individual source filenames, you can determine exactly which "\f2.java\fP" files are processed. However, that is not how most developers want to work, as it is simpler to pass in package names. The Javadoc tool can be run three ways without explicitly specifying the source filenames. You can (1) pass in package names, (2) use \f2\-subpackages\fP, and (3) use wildcards with source filenames (\f2*.java\fP). In these cases, the Javadoc tool processes a "\f2.java\fP" file only if it fulfills all of the following requirements: -.RS 3 -.TP 2 -o -Its name, after stripping off the "\f2.java\fP" suffix, is actually a legal class name (see the Java Language Specification for legal characters) -.TP 2 -o -Its directory path relative to the root of the source tree is actually a legal package name (after converting its separators to dots) -.TP 2 -o -Its package statement contains the legal package name (specified in the previous bullet) -.RE -.LP -\f3Processing of links\fP \- During a run, the Javadoc tool automatically adds cross\-reference links to package, class and member names that are being documented as part of that run. Links appear in several places: -.RS 3 -.TP 2 -o -Declarations (return types, argument types, field types) -.TP 2 -o -"See Also" sections generated from \f2@see\fP tags -.TP 2 -o -In\-line text generated from \f2{@link}\fP tags -.TP 2 -o -Exception names generated from \f2@throws\fP tags -.TP 2 -o -"Specified by" links to members in interfaces and "Overrides" links to members in classes -.TP 2 -o -Summary tables listing packages, classes and members -.TP 2 -o -Package and class inheritance trees -.TP 2 -o -The index -.RE -.LP -You can add hyperlinks to existing text for classes not included on the command line (but generated separately) by way of the \f2\-link\fP and \f2\-linkoffline\fP options. -.LP -\f3Other processing details\fP \- The Javadoc tool produces one complete document each time it is run; it cannot do incremental builds \-\- that is, it cannot modify or \f2directly\fP incorporate results from previous runs of the Javadoc tool. However, it can link to results from other runs, as just mentioned. -.LP -As implemented, the Javadoc tool requires and relies on the java compiler to do its job. The Javadoc tool calls part of \f2javac\fP to compile the declarations, ignoring the member implementation. It builds a rich internal representation of the classes, including the class hierarchy, and "use" relationships, then generates the HTML from that. The Javadoc tool also picks up user\-supplied documentation from documentation comments in the source code. -.LP -In fact, the Javadoc tool will run on \f2.java\fP source files that are pure stub files with no method bodies. This means you can write documentation comments and run the Javadoc tool in the earliest stages of design while creating the API, before writing the implementation. -.LP -Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code. For example, the Javadoc tool documents default constructors (see Java Language Specification) that are present in the \f2.class\fP files but not in the source code. -.LP -In many cases, the Javadoc tool allows you to generate documentation for source files whose code is incomplete or erroneous. This is a benefit that enables you to generate documentation before all debugging and troubleshooting is done. For example, according to the \f2Java Language Specification\fP, a class that contains an abstract method should itself be declared abstract. The Javadoc tool does not check for this, and would proceed without a warning, whereas the javac compiler stops on this error. The Javadoc tool does do some primitive checking of doc comments. Use the DocCheck doclet to check the doc comments more thoroughly. -.LP -When the Javadoc tool builds its internal structure for the documentation, it loads all referenced classes. Because of this, the Javadoc tool must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes. For more about this, see -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html. Generally speaking, classes you create must either be loaded as an extension or in the Javadoc tool's class path. -.SS -Javadoc Doclets -.LP -You can customize the content and format of the Javadoc tool's output by using doclets. The Javadoc tool has a default "built\-in" doclet, called the standard doclet, that generates HTML\-formatted API documentation. You can modify or subclass the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you'd like. Information about doclets and their use is at the following locations: -.RS 3 -.TP 2 -o -.na -\f2Javadoc Doclets\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html -.TP 2 -o -The \f2\-doclet\fP command\-line option -.RE -.LP -When a custom doclet is not specified with the \f2\-doclet\fP command line option, the Javadoc tool will use the default standard doclet. The javadoc tool has several command line options that are available regardless of which doclet is being used. The standard doclet adds a supplementary set of command line options. Both sets of options are described below in the options section. -.SS -Related Documentation and Doclets -.RS 3 -.TP 2 -o -.na -\f2Javadoc Enhancements\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html for details about improvements added in Javadoc. -.TP 2 -o -.na -\f2Javadoc FAQ\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html for answers to common questions, information about Javadoc\-related tools, and workarounds for bugs. -.TP 2 -o -.na -\f2How to Write Doc Comments for Javadoc\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html for more information about Sun conventions for writing documentation comments. -.TP 2 -o -.na -\f2Requirements for Writing API Specifications\fP @ -.fi -http://java.sun.com/j2se/javadoc/writingapispecs/index.html \- Standard requirements used when writing the Java SE Platform Specification. It can be useful whether you are writing API specifications in source file documentation comments or in other formats. It covers requirements for packages, classes, interfaces, fields and methods to satisfy testable assertions. -.TP 2 -o -.na -\f2Documentation Comment Specification\fP @ -.fi -http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html \- The original specification on documentation comments, Chapter 18, Documentation Comments, in the \f2Java Language Specification\fP, First Edition, by James Gosling, Bill Joy, and Guy Steele. (This chapter was removed from the second edition.) -.TP 2 -o -.na -\f2DocCheck Doclet\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-141437.html \- Checks doc comments in source files and generates a report listing the errors and irregularities it finds. It is part of the Doc Check Utilities. -.TP 2 -o -.na -\f2MIF Doclet\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/ \- Can automate the generation of API documentation in MIF, FrameMaker and PDF formats. MIF is Adobe FrameMaker's interchange format. -.RE -.SS -Terminology -.LP -The terms \f2documentation comment\fP, \f2doc comment\fP, \f2main description\fP, \f2tag\fP, \f2block tag\fP, and \f2in\-line tag\fP are described at Documentation Comments. These other terms have specific meanings within the context of the Javadoc tool: -.RS 3 -.TP 3 -generated document -The document generated by the javadoc tool from the doc comments in Java source code. The default generated document is in HTML and is created by the standard doclet. -.LP -.TP 3 -name -A name of a program element written in the Java Language \-\- that is, the name of a package, class, interface, field, constructor or method. A name can be fully\-qualified, such as \f2java.lang.String.equals(java.lang.Object)\fP, or partially\-qualified, such as \f2equals(Object)\fP. -.LP -.TP 3 -documented classes -The classes and interfaces for which detailed documentation is generated during a javadoc run. To be documented, the source files must be available, their source filenames or package names must be passed into the javadoc command, and they must not be filtered out by their access modifier (public, protected, package\-private or private). We also refer to these as the classes included in the javadoc output, or the \f2included classes\fP. -.LP -.TP 3 -included classes -Classes and interfaces whose details are documented during a run of the Javadoc tool. Same as \f2documented classes\fP. -.LP -.TP 3 -excluded classes -Classes and interfaces whose details are \f2not\fP documented during a run of the Javadoc tool. -.LP -.TP 3 -referenced classes -The classes and interfaces that are explicitly referred to in the definition (implementation) or doc comments of the documented classes and interfaces. Examples of references include return type, parameter type, cast type, extended class, implemented interface, imported classes, classes used in method bodies, @see, {@link}, {@linkplain}, and {@inheritDoc} tags. (Notice this definition has changed since -.na -\f21.3\fP @ -.fi -http://download.oracle.com/javase/1.3/docs/tooldocs/solaris/javadoc.html#referencedclasses.) When the Javadoc tool is run, it should load into memory all of the referenced classes in javadoc's bootclasspath and classpath. (The Javadoc tool prints a "Class not found" warning for referenced classes not found.) The Javadoc tool can derive enough information from the .class files to determine their existence and the fully\-qualified names of their members. -.LP -.TP 3 -external referenced classes -The referenced classes whose documentation is not being generated during a javadoc run. In other words, these classes are not passed into the Javadoc tool on the command line. Links in the generated documentation to those classes are said to be \f2external references\fP or \f2external links\fP. For example, if you run the Javadoc tool on only the \f2java.awt\fP package, then any class in \f2java.lang\fP, such as \f2Object\fP, is an external referenced class. External referenced classes can be linked to using the \f2\-link\fP and \f2\-linkoffline\fP options. An important property of an external referenced class is that its source comments are normally not available to the Javadoc run. In this case, these comments cannot be inherited. -.RE -.SH "SOURCE FILES" -.LP -The Javadoc tool will generate output originating from four different types of "source" files: Java language source files for classes (\f2.java\fP), package comment files, overview comment files, and miscellaneous unprocessed files. This section also covers test files and template files that can also be in the source tree, but which you want to be sure not to document. -.SS -Class Source Code Files -.LP -Each class or interface and its members can have their own documentation comments, contained in a \f2.java\fP file. For more details about these doc comments, see Documentation Comments. -.SS -Package Comment Files -.LP -Each package can have its own documentation comment, contained in its own "source" file, that the Javadoc tool will merge into the package summary page that it generates. You typically include in this comment any documentation that applies to the entire package. -.LP -To create a package comment file, you have a choice of two files to place your comments: -.RS 3 -.TP 2 -o -\f2package\-info.java\fP \- Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is generally preferred over package.html. -.TP 2 -o -\f2package.html\fP \- Can contain only package comments and Javadoc tags, no package annotations. -.RE -.LP -A package may have a single \f2package.html\fP file or a single \f2package\-info.java\fP file but not both. Place either file in the package directory in the source tree along with your \f2.java\fP files. -.LP -\f4package\-info.java\fP \- This file can contain a package comment of the following structure \-\- the comment is placed before the package declaration: -.LP -File: \f2java/applet/package\-info.java\fP -.nf -\f3 -.fl -/** -.fl - * Provides the classes necessary to create an -.fl - * applet and the classes an applet uses -.fl - * to communicate with its applet context. -.fl - *

-.fl - * The applet framework involves two entities: -.fl - * the applet and the applet context. -.fl - * An applet is an embeddable window (see the -.fl - * {@link java.awt.Panel} class) with a few extra -.fl - * methods that the applet context can use to -.fl - * initialize, start, and stop the applet. -.fl - * -.fl - * @since 1.0 -.fl - * @see java.awt -.fl - */ -.fl -package java.lang.applet; -.fl -\fP -.fi -.LP -Note that while the comment separators \f2/**\fP and \f2/*\fP must be present, the leading asterisks on the intermediate lines can be omitted. -.LP -\f4package.html\fP \- This file can contain a package comment of the following structure \-\- the comment is placed in the \f2\fP element: -.LP -File: \f2java/applet/package.html\fP -.nf -\f3 -.fl - -.fl - -.fl -Provides the classes necessary to create an applet and the -.fl -classes an applet uses to communicate with its applet context. -.fl -

-.fl -The applet framework involves two entities: the applet -.fl -and the applet context. An applet is an embeddable -.fl -window (see the {@link java.awt.Panel} class) with a -.fl -few extra methods that the applet context can use to -.fl -initialize, start, and stop the applet. -.fl +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 10 May 2011 +.\" SectDesc: Basic Tools +.\" Title: javadoc.1 +.\" +.if n .pl 99999 +.TH javadoc 1 "10 May 2011" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.fl -@since 1.0 -.fl -@see java.awt -.fl - -.fl - -.fl -\fP -.fi -.LP -Notice this is just a normal HTML file and does not include a package declaration. The content of the package comment file is written in HTML, like all other comments, with one exception: The documentation comment should not include the comment separators \f2/**\fP and \f2*/\fP or leading asterisks. When writing the comment, you should make the first sentence a summary about the package, and not put a title or any other text between \f2\fP and the first sentence. You can include package tags; as with any documentation comment, all block tags must appear after the main description. If you add a \f2@see\fP tag in a package comment file, it must have a fully\-qualified name. For more details, see the -.na -\f2example of \fP\f2package.html\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#packagecomments. -.LP -\f3Processing of package comment file\fP \- When the Javadoc tool runs, it will automatically look for the package comment file; if found, the Javadoc tool does the following: -.RS 3 -.TP 2 -o -Copies the comment for processing. (For \f2package.html\fP, copies all content between \f2\fP and \f2\fP HTML tags. You can include a \f2\fP section to put a \f2\fP, source file copyright statement, or other information, but none of these will appear in the generated documentation.) -.TP 2 -o -Processes any package tags that are present. -.TP 2 -o -Inserts the processed text at the bottom of the package summary page it generates, as shown in -.na -\f2Package Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/applet/package\-summary.html. -.TP 2 -o -Copies the first sentence of the package comment to the top of the package summary page. It also adds the package name and this first sentence to the list of packages on the overview page, as shown in -.na -\f2Overview Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/overview\-summary.html. The end\-of\-sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions. -.RE -.SS -Overview Comment File -.LP -Each application or set of packages that you are documenting can have its own overview documentation comment, kept in its own "source" file, that the Javadoc tool will merge into the overview page that it generates. You typically include in this comment any documentation that applies to the entire application or set of packages. -.LP -To create an overview comment file, you can name the file anything you want, typically \f4overview.html\fP and place it anywhere, typically at the top level of the source tree. For example, if the source files for the \f2java.applet\fP package are contained in \f2/home/user/src/java/applet\fP directory, you could create an overview comment file at \f2/home/user/src/overview.html\fP. -.LP -Notice you can have multiple overview comment files for the same set of source files, in case you want to run javadoc multiple times on different sets of packages. For example, you could run javadoc once with \-private for internal documentation and again without that option for public documentation. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file. -.LP -The content of the overview comment file is one big documentation comment, written in HTML, like the package comment file described previously. See that description for details. To re\-iterate, when writing the comment, you should make the first sentence a summary about the application or set of packages, and not put a title or any other text between \f2<body>\fP and the first sentence. You can include overview tags; as with any documentation comment, all tags except in\-line tags, such as \f2{@link}\fP, must appear after the main description. If you add a \f2@see\fP tag, it must have a fully\-qualified name. -.LP -When you run the Javadoc tool, you specify the overview comment file name with the \-overview option. The file is then processed similar to that of a package comment file. -.RS 3 -.TP 2 -o -Copies all content between \f2<body>\fP and \f2</body>\fP tags for processing. -.TP 2 -o -Processes any overview tags that are present. -.TP 2 -o -Inserts the processed text at the bottom of the overview page it generates, as shown in -.na -\f2Overview Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/overview\-summary.html. -.TP 2 -o -Copies the first sentence of the overview comment to the top of the overview summary page. -.RE -.SS -Miscellaneous Unprocessed Files -.LP -You can also include in your source any miscellaneous files that you want the Javadoc tool to copy to the destination directory. These typically includes graphic files, example Java source (.java) and class (.class) files, and self\-standing HTML files whose content would overwhelm the documentation comment of a normal Java source file. -.LP -To include unprocessed files, put them in a directory called \f4doc\-files\fP which can be a subdirectory of any package directory that contains source files. You can have one such subdirectory for each package. You might include images, example code, source files, .class files, applets and HTML files. For example, if you want to include the image of a button \f2button.gif\fP in the \f2java.awt.Button\fP class documentation, you place that file in the \f2/home/user/src/java/awt/doc\-files/\fP directory. Notice the \f2doc\-files\fP directory should not be located at \f2/home/user/src/java/doc\-files\fP because \f2java\fP is not a package \-\- that is, it does not directly contain any source files. -.LP -All links to these unprocessed files must be hard\-coded, because the Javadoc tool does not look at the files \-\- it simply copies the directory and all its contents to the destination. For example, the link in the \f2Button.java\fP doc comment might look like: -.nf -\f3 -.fl - /** -.fl - * This button looks like this: -.fl - * <img src="doc\-files/Button.gif"> -.fl - */ -.fl -\fP -.fi -.SS -Test Files and Template Files -.LP -Some developers have indicated they want to store test files and templates files in the source tree near their corresponding source files. That is, they would like to put them in the same directory, or a subdirectory, of those source files. -.LP -If you run the Javadoc tool by explicitly passing in individual source filenames, you can deliberately omit test and templates files and prevent them from being processed. However, if you are passing in package names or wildcards, you need to follow certain rules to ensure these test files and templates files are not processed. -.LP -Test files differ from template files in that the former are legal, compilable source files, while the latter are not, but may end with ".java". -.LP -\f3Test files\fP \- Often developers want to put compilable, runnable test files for a given package in the \f2same\fP directory as the source files for that package. But they want the test files to belong to a package other than the source file package, such as the unnamed package (so the test files have no package statement or a different package statement from the source). In this scenario, when the source is being documented by specifying its package name specified on the command line, the test files will cause warnings or errors. You need to put such test files in a subdirectory. For example, if you want to add test files for source files in \f2com.package1\fP, put them in a subdirectory that would be an invalid package name (because it contains a hyphen): -.nf -\f3 -.fl - com/package1/test\-files/ -.fl -\fP -.fi -.LP -The test directory will be skipped by the Javadoc tool with no warnings. -.LP -If your test files contain doc comments, you can set up a separate run of the Javadoc tool to produce documentation of the test files by passing in their test source filenames with wildcards, such as \f2com/package1/test\-files/*.java\fP. -.LP -\f3Templates for source files\fP \- Template files have names that often end in ".java" and are not compilable. If you have a template for a source file that you want to keep in the source directory, you can name it with a dash (such as \f2Buffer\-Template.java\fP), or any other illegal Java character, to prevent it from being processed. This relies on the fact that the Javadoc tool will only process source files whose name, when stripped of the ".java" suffix, is actually a legal class name (see information about Identifiers in the Java Language Specification). -.SH "GENERATED FILES" -.LP -By default, javadoc uses a standard doclet that generates HTML\-formatted documentation. This doclet generates the following kinds of files (where each HTML "page" corresponds to a separate file). Note that javadoc generates files with two types of names: those named after classes/interfaces, and those that are not (such as \f2package\-summary.html\fP). Files in the latter group contain hyphens to prevent filename conflicts with those in the former group. -.LP -\f3Basic Content Pages\fP -.RS 3 -.TP 2 -o -One \f3class or interface page\fP (\f2classname\fP\f2.html\fP) for each class or interface it is documenting. -.TP 2 -o -One \f3package page\fP (\f2package\-summary.html\fP) for each package it is documenting. The Javadoc tool will include any HTML text provided in a file named \f2package.html\fP or \f2package\-info.java\fP in the package directory of the source tree. -.TP 2 -o -One \f3overview page\fP (\f2overview\-summary.html\fP) for the entire set of packages. This is the front page of the generated document. The Javadoc tool will include any HTML text provided in a file specified with the \f2\-overview\fP option. Note that this file is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) -.RE -.LP -\f3Cross\-Reference Pages\fP -.RS 3 -.TP 2 -o -One \f3class hierarchy page for the entire set of packages\fP (\f2overview\-tree.html\fP). To view this, click on "Overview" in the navigation bar, then click on "Tree". -.TP 2 -o -One \f3class hierarchy page for each package\fP (\f2package\-tree.html\fP) To view this, go to a particular package, class or interface page; click "Tree" to display the hierarchy for that package. -.TP 2 -o -One \f3"use" page\fP for each package (\f2package\-use.html\fP) and a separate one for each class and interface (\f2class\-use/\fP\f2classname\fP\f2.html\fP). This page describes what packages, classes, methods, constructors and fields use any part of the given class, interface or package. Given a class or interface A, its "use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar. -.TP 2 -o -A \f3deprecated API page\fP (\f2deprecated\-list.html\fP) listing all deprecated names. (A deprecated name is not recommended for use, generally due to improvements, and a replacement name is usually given. Deprecated APIs may be removed in future implementations.) -.TP 2 -o -A \f3constant field values page\fP (\f2constant\-values.html\fP) for the values of static fields. -.TP 2 -o -A \f3serialized form page\fP (\f2serialized\-form.html\fP) for information about serializable and externalizable classes. Each such class has a description of its serialization fields and methods. This information is of interest to re\-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class comment. The standard doclet automatically generates a serialized form page: any class (public or non\-public) that implements Serializable is included, along with \f2readObject\fP and \f2writeObject\fP methods, the fields that are serialized, and the doc comments from the \f2@serial\fP, \f2@serialField\fP, and \f2@serialData\fP tags. Public serializable classes can be excluded by marking them (or their package) with \f2@serial exclude\fP, and package\-private serializable classes can be included by marking them (or their package) with \f2@serial include\fP. As of 1.4, you can generate the complete serialized form for public and private classes by running javadoc \f2without\fP specifying the \f2\-private\fP option. -.TP 2 -o -An \f3index\fP (\f2index\-*.html\fP) of all class, interface, constructor, field and method names, alphabetically arranged. This is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\-Z for English). -.RE -.LP -\f3Support Files\fP -.RS 3 -.TP 2 -o -A \f3help page\fP (\f2help\-doc.html\fP) that describes the navigation bar and the above pages. You can provide your own custom help file to override the default using \f2\-helpfile\fP. -.TP 2 -o -One \f3index.html file\fP which creates the HTML frames for display. This is the file you load to display the front page with frames. This file itself contains no text content. -.TP 2 -o -Several \f3frame files\fP (\f2*\-frame.html\fP) containing lists of packages, classes and interfaces, used when HTML frames are being displayed. -.TP 2 -o -A \f3package list\fP file (\f2package\-list\fP), used by the \f2\-link\fP and \f2\-linkoffline\fP options. This is a text file, not HTML, and is not reachable through any links. -.TP 2 -o -A \f3style sheet\fP file (\f2stylesheet.css\fP) that controls a limited amount of color, font family, font size, font style and positioning on the generated pages. -.TP 2 -o -A \f3doc\-files\fP directory that holds any image, example, source code or other files that you want copied to the destination directory. These files are not processed by the Javadoc tool in any manner \-\- that is, any javadoc tags in them will be ignored. This directory is not generated unless it exists in the source tree. -.RE -.LP -\f3HTML Frames\fP -.LP -The Javadoc tool will generate either two or three HTML frames, as shown in the figure below. It creates the minimum necessary number of frames by omitting the list of packages if there is only one package (or no packages). That is, when you pass a single package name or source files (*.java) belonging to a single package as arguments into the javadoc command, it will create only one frame (C) in the left\-hand column \-\- the list of classes. When you pass into javadoc two or more package names, it creates a third frame (P) listing all packages, as well as an overview page (Detail). This overview page has the filename \f2overview\-summary.html\fP. Thus, this file is created only if you pass in two or more package names. You can bypass frames by clicking on the "No Frames" link or entering at overview\-summary.html. -.LP -If you are unfamiliar with HTML frames, you should be aware that frames can have \f2focus\fP for printing and scrolling. To give a frame focus, click on it. Then on many browsers the arrow keys and page keys will scroll that frame, and the print menu command will print it. -.LP -Load one of the following two files as the starting page depending on whether you want HTML frames or not: -.RS 3 -.TP 2 -o -\f2index.html\fP (for frames) -.TP 2 -o -\f2overview\-summary.html\fP (for no frames) -.RE -.LP -\f3Generated File Structure\fP -.LP -The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized. This structure is one directory per subpackage. -.LP -For example, the document generated for the class \f2java.applet.Applet\fP class would be located at \f2java/applet/Applet.html\fP. The file structure for the java.applet package follows, given that the destination directory is named \f2apidocs\fP. All files that contain the word "frame" appear in the upper\-left or lower\-left frames, as noted. All other HTML files appear in the right\-hand frame. -.LP -NOTE \- Directories are shown in \f3bold\fP. The asterisks (\f2*\fP) indicate the files and directories that are \f2omitted\fP when the arguments to javadoc are source filenames (*.java) rather than package names. Also when arguments are source filenames, \f2package\-list\fP is created but is empty. The doc\-files directory will not be created in the destination unless it exists in the source tree. -.nf -\f3 -.fl +.SH NAME +javadoc \- Generates HTML pages of API documentation from Java source files\&. +.SH SYNOPSIS +.sp +.nf -.fl -\fP\f3apidocs\fP Top directory -.fl - index.html Initial page that sets up HTML frames -.fl - * overview\-summary.html Lists all packages with first sentence summaries -.fl - overview\-tree.html Lists class hierarchy for all packages -.fl - deprecated\-list.html Lists deprecated API for all packages -.fl - constant\-values.html Lists values of static fields for all packages -.fl - serialized\-form.html Lists serialized form for all packages -.fl - * overview\-frame.html Lists all packages, used in upper\-left frame -.fl - allclasses\-frame.html Lists all classes for all packages, used in lower\-left frame -.fl - help\-doc.html Lists user help for how these pages are organized -.fl - index\-all.html Default index created without \-splitindex option -.fl - \f3index\-files\fP Directory created with \-splitindex option -.fl - index\-<number>.html Index files created with \-splitindex option -.fl - package\-list Lists package names, used only for resolving external refs -.fl - stylesheet.css HTML style sheet for defining fonts, colors and positions -.fl - \f3java\fP Package directory -.fl - \f3applet\fP Subpackage directory -.fl - Applet.html Page for Applet class -.fl - AppletContext.html Page for AppletContext interface -.fl - AppletStub.html Page for AppletStub interface -.fl - AudioClip.html Page for AudioClip interface -.fl - * package\-summary.html Lists classes with first sentence summaries for this package -.fl - * package\-frame.html Lists classes in this package, used in lower left\-hand frame -.fl - * package\-tree.html Lists class hierarchy for this package -.fl - package\-use Lists where this package is used -.fl - \f3doc\-files\fP Directory holding image and example files -.fl - \f3class\-use\fP Directory holding pages API is used -.fl - Applet.html Page for uses of Applet class -.fl - AppletContext.html Page for uses of AppletContext interface -.fl - AppletStub.html Page for uses of AppletStub interface -.fl - AudioClip.html Page for uses of AudioClip interface -.fl - \f3src\-html\fP Source code directory -.fl - \f3java\fP Package directory -.fl - \f3applet\fP Subpackage directory -.fl - Applet.html Page for Applet source code -.fl - AppletContext.html Page for AppletContext source code -.fl - AppletStub.html Page for AppletStub source code -.fl - AudioClip.html Page for AudioClip source code -.fl -.fi -.SS -Generated API Declarations -.LP -The Javadoc tool generates a declaration at the start of each class, interface, field, constructor, and method description for that API item. For example, the declaration for the \f2Boolean\fP class is: -.LP -\f2public final class Boolean\fP -.br -\f2extends Object\fP -.br -\f2implements Serializable\fP -.LP -and the declaration for the \f2Boolean.valueOf\fPmethod is: -.LP -\f2public static Boolean valueOf(String s)\fP -.LP -The Javadoc tool can include the modifiers \f2public\fP, \f2protected\fP, \f2private\fP, \f2abstract\fP, \f2final\fP, \f2static\fP, \f2transient\fP, and \f2volatile\fP, but not \f2synchronized\fP or \f2native\fP. These last two modifiers are considered implementation detail and not part of the API specification. -.LP -Rather than relying on the keyword \f2synchronized\fP, APIs should document their concurrency semantics in the comment's main description, as in "a single \f2Enumeration\fP cannot be used by multiple threads concurrently". The document should not describe how to achieve these semantics. As another example, while \f2Hashtable\fP should be thread\-safe, there's no reason to specify that we achieve this by synchronizing all of its exported methods. We should reserve the right to synchronize internally at the bucket level, thus offering higher concurrency. -.SH "DOCUMENTATION COMMENTS" -.LP -The original "Documentation Comment Specification" can be found under related documentation. -.SS -Commenting the Source Code -.LP -You can include \f2documentation comments\fP ("doc comments") in the source code, ahead of declarations for any class, interface, method, constructor, or field. You can also create doc comments for each package and another one for the overview, though their syntax is slightly different. Doc comments are also known informally as "Javadoc comments" (but this term violates its trademark usage). A doc comment consists of the characters between the characters \f2/**\fP that begin the comment and the characters \f2*/\fP that end it. Leading asterisks are allowed on each line and are described further below. The text in a comment can continue onto multiple lines. -.nf -\f3 -.fl -/** -.fl - * This is the typical format of a simple documentation comment -.fl - * that spans two lines. -.fl - */ -.fl -\fP -.fi -.LP +\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] +.fi +.sp +.TP +\fIpackages\fR +Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. + +By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. +.TP +\fIsource-files\fR +Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. +.TP +\fIoptions\fR +Command-line options, separated by spaces\&. See Options\&. +.TP +\fI@argfiles\fR +Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. +.SH DESCRIPTION +The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. +.PP +You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. +.SS PROCESS\ SOURCE\ FILES +The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: +.TP 0.2i +\(bu +The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. +.TP 0.2i +\(bu +The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. +.TP 0.2i +\(bu +The package statement contains the valid package name\&. +.PP +Processing Links + +During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. +.TP 0.2i +\(bu +Declarations (return types, argument types, and field types)\&. +.TP 0.2i +\(bu +\fISee Also\fR sections that are generated from \f3@see\fR tags\&. +.TP 0.2i +\(bu +Inline text generated from \f3{@link}\fR tags\&. +.TP 0.2i +\(bu +Exception names generated from \f3@throws\fR tags\&. +.TP 0.2i +\(bu +\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. +.TP 0.2i +\(bu +Summary tables listing packages, classes and members\&. +.TP 0.2i +\(bu +Package and class inheritance trees\&. +.TP 0.2i +\(bu +The index\&. +.PP +You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. +.PP +Processing Details + +The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. +.PP +The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. +.PP +The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. +.PP +Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. +.PP +In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. +.PP +When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.PP +Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. +.SS JAVADOC\ DOCLETS +You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. +.PP +When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. +.SH SOURCE\ FILES +The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. +.SS CLASS\ SOURCE\ FILES +Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. +.SS PACKAGE\ COMMENT\ FILES +Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. +.PP +To create a package comment file, you can place your comments in one of the following files: +.TP 0.2i +\(bu +The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. +.TP 0.2i +\(bu +The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. +.PP +A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. +.PP +The package-info\&.java File + +The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. +.PP +\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Provides the classes necessary to create an \fP +.fi +.nf +\f3 * applet and the classes an applet uses \fP +.fi +.nf +\f3 * to communicate with its applet context\&.\fP +.fi +.nf +\f3 * <p>\fP +.fi +.nf +\f3 * The applet framework involves two entities:\fP +.fi +.nf +\f3 * the applet and the applet context\&.\fP +.fi +.nf +\f3 * An applet is an embeddable window (see the\fP +.fi +.nf +\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP +.fi +.nf +\f3 * methods that the applet context can use to \fP +.fi +.nf +\f3 * initialize, start, and stop the applet\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @since 1\&.0\fP +.fi +.nf +\f3 * @see java\&.awt\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3package java\&.lang\&.applet;\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +The package\&.html File + +The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. +.PP +File: \f3java/applet/package\&.html\fR +.sp +.nf +\f3<HTML>\fP +.fi +.nf +\f3<BODY>\fP +.fi +.nf +\f3Provides the classes necessary to create an applet and the \fP +.fi +.nf +\f3classes an applet uses to communicate with its applet context\&.\fP +.fi +.nf +\f3<p>\fP +.fi +.nf +\f3The applet framework involves two entities: the applet\fP +.fi +.nf +\f3and the applet context\&. An applet is an embeddable\fP +.fi +.nf +\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP +.fi +.nf +\f3few extra methods that the applet context can use to\fP +.fi +.nf +\f3initialize, start, and stop the applet\&. \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3@since 1\&.0 \fP +.fi +.nf +\f3@see java\&.awt\fP +.fi +.nf +\f3</BODY>\fP +.fi +.nf +\f3</HTML>\fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. +.PP +Processing the Comment File + +When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. +.TP 0.2i +\(bu +Processes the package tags\&. See Package Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html + +The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. +.SS OVERVIEW\ COMMENT\ FILES +Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. +.PP +You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. +.PP +For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. +.PP +You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. +.PP +The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. +.PP +When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. +.TP 0.2i +\(bu +Processes the overview tags that are present\&. See Overview Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the overview comment to the top of the overview summary page\&. +.SS UNPROCESSED\ FILES +Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. +.PP +To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. +.PP +For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. +.PP +All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This button looks like this: \fP +.fi +.nf +\f3 * <img src="doc\-files/Button\&.gif">\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS TEST\ AND\ TEMPLATE\ FILES +You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. +.PP +Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. +.PP +Test Files + +If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: +.sp +.nf +\f3com/package1/test\-files/\fP +.fi +.nf +\f3\fR +.fi +.sp +If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. +.PP +Template Files + +If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. +.SH GENERATED\ FILES +By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. +.SS BASIC\ CONTENT\ PAGES +.TP 0.2i +\(bu +One class or interface page (classname\&.html) for each class or interface being documented\&. +.TP 0.2i +\(bu +One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. +.TP 0.2i +\(bu +One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. +.SS CROSS-REFERENCE\ PAGES +.TP 0.2i +\(bu +One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. +.TP 0.2i +\(bu +One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. +.TP 0.2i +\(bu +One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. +.TP 0.2i +\(bu +A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. +.TP 0.2i +\(bu +A constant field values page (constant-values\&.html) for the values of static fields\&. +.TP 0.2i +\(bu +A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. +.TP 0.2i +\(bu +An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. +.SS SUPPORT\ PAGES +.TP 0.2i +\(bu +A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. +.TP 0.2i +\(bu +One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. +.TP 0.2i +\(bu +Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. +.TP 0.2i +\(bu +A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. +.TP 0.2i +\(bu +A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. +.TP 0.2i +\(bu +A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. +.PP +See Options\&. +.SS HTML\ FRAMES +The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. +.SS GENERATED\ FILE\ STRUCTURE +The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. +.PP +For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. +.PP +The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. +.PP +Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. +.TP 0.2i +\(bu +\fIapidocs\fR: Top-level directory +.RS +.TP 0.2i +\(bu +index\&.html: Initial Page that sets up HTML frames +.TP 0.2i +\(bu +*overview-summary\&.html: Package list with summaries +.TP 0.2i +\(bu +overview-tree\&.html: Class hierarchy for all packages +.TP 0.2i +\(bu +deprecated-list\&.html: Deprecated APIs for all packages +.TP 0.2i +\(bu +constant-values\&.html: Static field values for all packages +.TP 0.2i +\(bu +serialized-form\&.html: Serialized forms for all packages +.TP 0.2i +\(bu +*overview-frame\&.html: All packages for display in upper-left frame +.TP 0.2i +\(bu +allclasses-frame\&.html: All classes for display in lower-left frame +.TP 0.2i +\(bu +help-doc\&.html: Help about Javadoc page organization +.TP 0.2i +\(bu +index-all\&.html: Default index created without \f3-splitindex\fR option +.TP 0.2i +\(bu +\fIindex-files\fR: Directory created with \f3-splitindex\fR option +.RS +.TP 0.2i +\(bu +index-<number>\&.html: Index files created with \f3-splitindex\fR option +.RE + +.TP 0.2i +\(bu +package-list: Package names for resolving external references +.TP 0.2i +\(bu +stylesheet\&.css: Defines fonts, colors, positions, and so on +.RE + +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory +.RS +.TP 0.2i +\(bu +Applet\&.html: \f3Applet\fR class page +.TP 0.2i +\(bu +AppletContext\&.html: \f3AppletContext\fR interface +.TP 0.2i +\(bu +AppletStub\&.html: \f3AppletStub\fR interface +.TP 0.2i +\(bu +AudioClip\&.html: \f3AudioClip\fR interface +.TP 0.2i +\(bu +package-summary\&.html: Classes with summaries +.TP 0.2i +\(bu +package-frame\&.html: Package classes for display in lower-left frame +.TP 0.2i +\(bu +package-tree\&.html: Class hierarchy for this package +.TP 0.2i +\(bu +package-use\&.html: Where this package is used +.TP 0.2i +\(bu +\fIdoc-files\fR: Image and example files directory +.TP 0.2i +\(bu +\fIclass-use\fR: Image and examples file location + +- Applet\&.html: Uses of the Applet class + +- AppletContext\&.html: Uses of the \f3AppletContext\fR interface + +- AppletStub\&.html: Uses of the \f3AppletStub\fR interface + +- AudioClip\&.html: Uses of the \f3AudioClip\fR interface +.RE + +.RE + +.TP 0.2i +\(bu +\fIsrc-html\fR: Source code directory +.RS +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory + +- Applet\&.html: Applet source code + +- AppletContext\&.html: \f3AppletContext\fR source code + +- AppletStub\&.html: \f3AppletStub\fR source code + +- AudioClip\&.html: \f3AudioClip\fR source code +.RE + +.RE + +.SS GENERATED\ API\ DECLARATIONS +The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: +.sp +.nf +\f3public final class Boolean\fP +.fi +.nf +\f3extends Object\fP +.fi +.nf +\f3implements Serializable\fP +.fi +.nf +\f3\fR +.fi +.sp +The declaration for the \f3Boolean\&.valueOf\fR method is: +.sp +.nf +\f3public static Boolean valueOf(String s)\fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. +.PP +Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. +.SH DOCUMENTATION\ COMMENTS +This section describes source code comments and comment inheritance\&. +.SS SOURCE\ CODE\ COMMENTS +You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the typical format of a simple documentation comment\fP +.fi +.nf +\f3 * that spans two lines\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp To save space you can put a comment on one line: -.nf -\f3 -.fl -/** This comment takes up only one line. */ -.fl -\fP -.fi -.LP -\f3Placement of comments\fP \- Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations \-\- see the class example, method example, and field example. Documentation comments placed in the body of a method are ignored. Only one documentation comment per declaration statement is recognized by the Javadoc tool. -.LP -A common mistake is to put an \f2import\fP statement between the class comment and the class declaration. Avoid this, as the Javadoc tool will ignore the class comment. -.nf -\f3 -.fl - /** -.fl - * This is the class comment for the class Whatever. -.fl - */ -.fl +.sp +.nf +\f3/** This comment takes up only one line\&. */\fP +.fi +.nf +\f3\fR +.fi +.sp -.fl - import com.sun; // MISTAKE \- Important not to put import statement here -.fl +.PP +Placement of Comments -.fl - public class Whatever { -.fl - } -.fl -\fP -.fi -.LP -\f3A doc comment is composed of a \fP\f4main description\fP\f3 followed by a \fP\f4tag section\fP \- The \f2main description\fP begins after the starting delimiter \f2/**\fP and continues until the tag section. The \f2tag section\fP starts with the first block tag, which is defined by the first \f2@\fP character that begins a line (ignoring leading asterisks, white space, and leading separator \f2/**\fP). It is possible to have a comment with only a tag section and no main description. The main description cannot continue after the tag section begins. The argument to a tag can span multiple lines. There can be any number of tags \-\- some types of tags can be repeated while others cannot. For example, this \f2@see\fP starts the tag section: -.nf -\f3 -.fl -/** -.fl - * This sentence would hold the main description for this doc comment. -.fl - * @see java.lang.Object -.fl - */ -.fl -\fP -.fi -.LP -\f3Block tags and in\-line tags\fP \- A \f2tag\fP is a special keyword within a doc comment that the Javadoc tool can process. There are two kinds of tags: block tags, which appear as \f2@tag\fP (also known as "standalone tags"), and in\-line tags, which appear within curly braces, as \f2{@tag}\fP. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and separator (\f2/**\fP). This means you can use the \f2@\fP character elsewhere in the text and it will not be interpreted as the start of a tag. If you want to start a line with the \f2@\fP character and not have it be interpreted, use the HTML entity \f2@\fP. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the doc comment. This associated text can span multiple lines. An in\-line tag is allowed and interpreted anywhere that text is allowed. The following example contains the block tag \f2@deprecated\fP and in\-line tag \f2{@link}\fP. -.nf -\f3 -.fl -/** -.fl - * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} -.fl - */ -.fl -\fP -.fi -.LP -\f3Comments are written in HTML\fP \- The text must be written in HTML, in that they should use HTML entities and can use HTML tags. You can use whichever version of HTML your browser supports; we have written the standard doclet to generate HTML 3.2\-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames. (We preface each generated file with "HTML 4.0" because of the frame sets.) -.LP -For example, entities for the less\-than (\f2<\fP) and greater\-than (\f2>\fP) symbols should be written \f2<\fP and \f2>\fP. Likewise, the ampersand (\f2&\fP) should be written \f2&\fP. The bold HTML tag \f2<b>\fP is shown in the following example. -.LP -Here is a doc comment: -.nf -\f3 -.fl -/** -.fl - * This is a <b>doc</b> comment. -.fl - * @see java.lang.Object -.fl - */ -.fl -\fP -.fi -.LP -\f3Leading asterisks\fP \- When javadoc parses a doc comment, leading asterisk (\f2*\fP) characters on each line are discarded; blanks and tabs preceding the initial asterisk (\f2*\fP) characters are also discarded. Starting with 1.4, if you omit the leading asterisk on a line, the leading white space is no longer removed. This enables you to paste code examples directly into a doc comment inside a \f2<PRE>\fP tag, and its indentation will be honored. Spaces are generally interpreted by browsers more uniformly than tabs. Indentation is relative to the left margin (rather than the separator \f2/**\fP or \f2<PRE>\fP tag). -.LP -\f3First sentence\fP \- The first sentence of each doc comment should be a summary sentence, containing a concise but complete description of the declared entity. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag. The Javadoc tool copies this first sentence to the member summary at the top of the HTML page. -.LP -\f3Declaration with multiple fields\fP \- Java allows declaring multiple fields in a single statement, but this statement can have only one documentation comment, which is copied for all fields. Therefore if you want individual documentation comments for each field, you must declare each field in a separate statement. For example, the following documentation comment doesn't make sense written as a single declaration and would be better handled as two declarations: -.nf -\f3 -.fl -/** -.fl - * The horizontal and vertical distances of point (x,y) -.fl - */ -.fl -public int x, y; // Avoid this -.fl -\fP -.fi -.LP -The Javadoc tool generates the following documentation from the above code: -.nf -\f3 -.fl -public int \fP\f3x\fP -.fl -.fi -.RS 3 -The horizontal and vertical distances of point (x,y) -.RE -.nf -\f3 -.fl -public int \fP\f3y\fP -.fl -.fi -.RS 3 -The horizontal and vertical distances of point (x,y) -.RE -.LP -\f3Use header tags carefully\fP \- When writing documentation comments for members, it's best not to use HTML heading tags such as <H1> and <H2>, because the Javadoc tool creates an entire structured document and these structural tags might interfere with the formatting of the generated document. However, it is fine to use these headings in class and package comments to provide your own structure. -.SS -Automatic Copying of Method Comments -.LP -The Javadoc tool has the ability to copy or "inherit" method comments in classes and interfaces under the following two circumstances. Constructors, fields and nested classes do not inherit doc comments. -.RS 3 -.TP 2 -o -\f3Automatically inherit comment to fill in missing text\fP \- When a main description, or \f2@return\fP, \f2@param\fP or \f2@throws\fP tag is missing from a method comment, the Javadoc tool copies the corresponding main description or tag comment from the method it overrides or implements (if any), according to the algorithm below. -.LP -More specifically, when a \f2@param\fP tag for a particular parameter is missing, then the comment for that parameter is copied from the method further up the inheritance hierarchy. When a \f2@throws\fP tag for a particular exception is missing, the \f2@throws\fP tag is copied \f2only if that exception is declared\fP. -.LP -This behavior contrasts with version 1.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited. -.TP 2 -o -\f3Explicitly inherit comment with {@inheritDoc} tag\fP \- Insert the inline tag \f2{@inheritDoc}\fP in a method main description or \f2@return\fP, \f2@param\fP or \f2@throws\fP tag comment \-\- the corresponding inherited main description or tag comment is copied into that spot. -.RE -.LP -The source file for the inherited method need only be on the path specified by \-sourcepath for the doc comment to actually be available to copy. Neither the class nor its package needs to be passed in on the command line. This contrasts with 1.3.x and earlier releases, where the class had to be a documented class -.LP -\f3Inherit from classes and interfaces\fP \- Inheriting of comments occurs in all three possible cases of inheritance from classes and interfaces: -.RS 3 -.TP 2 -o +Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. +.PP +A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the class comment for the class Whatever\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3public class Whatever{ }\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Parts of Comments + +A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This sentence holds the main description for this documentation comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Block and inline Tags + +A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Write Comments in HTML + +The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. +.PP +For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is a <b>doc</b> comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Leading Asterisks + +When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. +.PP +First Sentence + +The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. +.PP +Multiple-Field Declarations + +The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: +.sp +.nf +\f3/** \fP +.fi +.nf +\f3 * The horizontal and vertical distances of point (x,y)\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public int x, y; // Avoid this \fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3javadoc\fR command generates the following documentation from the previous code: +.sp +.nf +\f3public int x\fP +.fi +.nf +\f3\fR +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.sp +.nf +\f3public int y\fP +.fi +.nf +\f3\fR +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.PP +Use of Header Tags + +When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. +.SS METHOD\ COMMENT\ INHERITANCE +The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. +.PP +\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. +.PP +Fill in Missing Text + +When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. +.PP +When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. +.PP +This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. +.PP +See Javadoc Tags and Options\&. +.PP +Explicit Inheritance + +Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. +.SS CLASS\ AND\ INTERFACE\ INHERITANCE +Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: +.TP 0.2i +\(bu When a method in a class overrides a method in a superclass -.TP 2 -o +.TP 0.2i +\(bu When a method in an interface overrides a method in a superinterface -.TP 2 -o +.TP 0.2i +\(bu When a method in a class implements a method in an interface -.RE -.LP -In the first two cases, for method overrides, the Javadoc tool generates a subheading "Overrides" in the documentation for the overriding method, with a link to the method it is overriding, whether or not the comment is inherited. -.LP -In the third case, when a method in a given class implements a method in an interface, the Javadoc tool generates a subheading "Specified by" in the documentation for the overriding method, with a link to the method it is implementing. This happens whether or not the comment is inherited. -.LP -\f3Algorithm for Inheriting Method Comments\fP \- If a method does not have a doc comment, or has an {@inheritDoc} tag, the Javadoc tool searches for an applicable comment using the following algorithm, which is designed to find the most specific applicable doc comment, giving preference to interfaces over superclasses: -.RS 3 -.TP 3 -1. -Look in each directly implemented (or extended) interface in the order they appear following the word implements (or extends) in the method declaration. Use the first doc comment found for this method. -.TP 3 -2. -If step 1 failed to find a doc comment, recursively apply this entire algorithm to each directly implemented (or extended) interface, in the same order they were examined in step 1. -.TP 3 -3. -If step 2 failed to find a doc comment and this is a class other than Object (not an interface): -.RS 3 -.TP 3 -a. -If the superclass has a doc comment for this method, use it. -.TP 3 -b. -If step 3a failed to find a doc comment, recursively apply this entire algorithm to the superclass. -.RE -.RE -.SH "JAVADOC TAGS" -.LP -The Javadoc tool parses special tags when they are embedded within a Java doc comment. These doc tags enable you to autogenerate a complete, well\-formatted API from your source code. The tags start with an "at" sign (\f2@\fP) and are case\-sensitive \-\- they must be typed with the uppercase and lowercase letters as shown. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk) or it is treated as normal text. By convention, tags with the same name are grouped together. For example, put all \f2@see\fP tags together. -.LP -Tags come in two types: -.RS 3 -.TP 2 -o -\f3Block tags\fP \- Can be placed only in the tag section that follows the main description. Block tags are of the form: \f2@tag\fP. -.TP 2 -o -\f3Inline tags\fP \- Can be placed anywhere in the main description or in the comments for block tags. Inline tags are denoted by curly braces: \f2{@tag}\fP. -.RE -.LP -For information about tags we might introduce in future releases, see -.na -\f2Proposed Tags\fP @ -.fi -http://java.sun.com/j2se/javadoc/proposed\-tags.html. -.LP -The current tags are: -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 80 0 -.nr 38 \w\f3Tag\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@author\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@code}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@docRoot}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@deprecated\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@exception\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@inheritDoc}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@link}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@linkplain}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@literal}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@param\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@return\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@see\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serial\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serialData\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serialField\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@since\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@throws\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@value}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@version\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Introduced in JDK/SDK\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.5 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.3 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.5 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.1 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 873 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Tag\fP\h'|\n(41u'\f3Introduced in JDK/SDK\fP -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@author\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@code}\fP\h'|\n(41u'1.5 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@docRoot}\fP\h'|\n(41u'1.3 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@deprecated\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@exception\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@inheritDoc}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@link}\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@linkplain}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@literal}\fP\h'|\n(41u'1.5 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@param\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@return\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@see\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serial\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serialData\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serialField\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@since\fP\h'|\n(41u'1.1 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@throws\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@value}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@version\fP\h'|\n(41u'1.0 -.fc -.nr T. 1 -.T# 1 -.35 -.if \n-(b.=0 .nr c. \n(.c-\n(d.-42 -.LP -For custom tags, see the \-tag option. -.RS 3 -.TP 3 -@author\ name\-text -Adds an "Author" entry with the specified \f2name\-text\fP to the generated docs when the \-author option is used. A doc comment may contain multiple \f2@author\fP tags. You can specify one name per \f2@author\fP tag or multiple names per tag. In the former case, the Javadoc tool inserts a comma (\f2,\fP) and space between names. In the latter case, the entire text is simply copied to the generated document without being parsed. Therefore, you can use multiple names per line if you want a localized name separator other than comma. -.RE -.LP -For more details, see Where Tags Can Be Used and -.na -\f2writing @author tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@author. -.LP -.RS 3 -.TP 3 -@deprecated\ deprecated\-text Note: You can deprecate a program element using the @Deprecated annotation. -.RE -.LP -Adds a comment indicating that this API should no longer be used (even though it may continue to work). The Javadoc tool moves the \f2deprecated\-text\fP ahead of the main description, placing it in italics and preceding it with a bold warning: "Deprecated". This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field. -.LP -The first sentence of \f2deprecated\-text\fP should at least tell the user when the API was deprecated and what to use as a replacement. The Javadoc tool copies just the first sentence to the summary section and index. Subsequent sentences can also explain why it has been deprecated. You should include a \f2{@link}\fP tag (for Javadoc 1.2 or later) that points to the replacement API: -.LP -For more details, see -.na -\f2writing @deprecated tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@deprecated. -.RS 3 -.TP 2 -o -For Javadoc 1.2 and later, use a \f2{@link}\fP tag. This creates the link in\-line, where you want it. For example: -.nf -\f3 -.fl -/** -.fl - * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} -.fl - */ -.fl +.PP +In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. +.PP +In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. +.SS METHOD\ COMMENTS\ ALGORITHM +If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: +.TP 0.4i +1\&. +Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. +.TP 0.4i +2\&. +If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. +.TP 0.4i +3\&. +When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: +.RS +.TP 0.4i +1\&. +If the superclass has a documentation comment for this method, then use it\&. +.TP 0.4i +2\&. +If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. +.RE -.fl -\fP -.fi -.TP 2 -o -For Javadoc 1.1, the standard format is to create a \f2@see\fP tag (which cannot be in\-line) for each \f2@deprecated\fP tag. -.RE -.LP -For more about deprecation, see -.na -\f2The @deprecated tag\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/deprecation/index.html. -.LP -.RS 3 -.TP 3 -{@code\ text} -Equivalent to \f2<code>{@literal}</code>\fP. -.LP -Displays \f2text\fP in \f2code\fP font without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (\f2<\fP and \f2>\fP) instead of the HTML entities (\f2<\fP and \f2>\fP) in doc comments, such as in parameter types (\f2<Object>\fP), inequalities (\f23 < 4\fP), or arrows (\f2<\-\fP). For example, the doc comment text: -.nf -\f3 -.fl - \fP\f4{@code A<B>C}\fP\f3 -.fl +.SH JAVADOC\ TAGS +The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. +.PP +Tags have the following types: +.TP 0.2i +\(bu +Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. +.TP 0.2i +\(bu +Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. +.PP +For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. +.SS TAG\ DESCRIPTIONS +.TP +@author \fIname-text\fR +Introduced in JDK 1\&.0 -.fl -\fP -.fi -.LP -displays in the generated HTML page unchanged, as: -.nf -\f3 -.fl - \fP\f4A<B>C\fP\f3 -.fl +Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author +.TP +{@code \fItext\fR} +Introduced in JDK 1\&.5 -.fl -\fP -.fi -.LP -The noteworthy point is that the \f2<B>\fP is not interpreted as bold and is in code font. -.LP -If you want the same functionality without the code font, use \f2{@literal}\fP. -.LP -.TP 3 +Equivalent to \f3<code>{@literal}</code>\fR\&. + +Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. +.TP +@deprecated \fIdeprecated-text\fR +Introduced in JDK 1\&.0 + +Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. + +The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. + +Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html + +See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated +.TP {@docRoot} -Represents the relative path to the generated document's (destination) root directory from any generated page. It is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages. Linking to the copyright page from the bottom of each page is common. -.LP -This \f2{@docRoot}\fP tag can be used both on the command line and in a doc comment: This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated). -.RS 3 -.TP 3 -1. -On the command line, where the header/footer/bottom are defined: -.nf -\f3 -.fl - javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>' -.fl +Introduced in JDK 1\&.3 -.fl -\fP -.fi -.LP -NOTE \- When using \f2{@docRoot}\fP this way in a make file, some makefile programs require special escaping for the brace {} characters. For example, the Inprise MAKE version 5.2 running on Windows requires double braces: \f2{{@docRoot}}\fP. It also requires double (rather than single) quotes to enclose arguments to options such as \f2\-bottom\fP (with the quotes around the \f2href\fP argument omitted). -.TP 3 -2. -In a doc comment: -.nf -\f3 -.fl - /** -.fl - * See the <a href="{@docRoot}/copyright.html">Copyright</a>. -.fl - */ -.fl +Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. -.fl -\fP -.fi +This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. +.RS +.TP 0.2i +\(bu +On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. + +When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. +.TP 0.2i +\(bu +In a documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. +.RE + +.TP +@exception \fIclass-name description\fR +Introduced in JDK 1\&.0 + +Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. +.TP +{@inheritDoc} +Introduced in JDK 1\&.4 + +Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. + +This tag is valid only in these places in a documentation comment: +.RS +.TP 0.2i +\(bu +In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. +.TP 0.2i +\(bu +In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. .RE -.LP -The reason this tag is needed is because the generated docs are in hierarchical directories, as deep as the number of subpackages. This expression: -.nf -\f3 -.fl - <a href="{@docRoot}/copyright.html"> -.fl +.RS +See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. -.fl -\fP -.fi -.LP -would resolve to: -.nf -\f3 -.fl - <a href="../../copyright.html"> for java/lang/Object.java -.fl - -.fl -\fP -.fi -.LP -and -.nf -\f3 -.fl - <a href="../../../copyright.html"> for java/lang/ref/Reference.java -.fl - -.fl -\fP -.fi -.LP -.TP 3 -@exception\ class\-name\ description -The \f2@exception\fP tag is a synonym for \f2@throws\fP. -.LP -.TP 3 -{@inheritDoc}\ -Inherits (copies) documentation from the "nearest" inheritable class or implementable interface into the current doc comment at this tag's location. This allows you to write more general comments higher up the inheritance tree, and to write around the copied text. -.LP -This tag is valid only in these places in a doc comment: -.RS 3 -.TP 2 -o -In the main description block of a method. In this case, the main description is copied from a class or interface up the hierarchy. -.TP 2 -o -In the text arguments of the @return, @param and @throws tags of a method. In this case, the tag text is copied from the corresponding tag up the hierarchy. .RE -.LP -See Automatic Copying of Method Comments for a more precise description of how comments are found in the inheritance hierarchy. Note that if this tag is missing, the comment is or is not automatically inherited according to rules described in that section. -.LP -.TP 3 -{@link\ package.class#member\ label} -Inserts an in\-line link with visible text \f2label\fP that points to the documentation for the specified package, class or member name of a referenced class. This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated). -.LP -This tag is very simliar to \f2@see\fP \-\- both require the same references and accept exactly the same syntax for \f2package.class\fP\f2#\fP\f2member\fP and \f2label\fP. The main difference is that \f2{@link}\fP generates an in\-line link rather than placing the link in the "See Also" section. Also, the \f2{@link}\fP tag begins and ends with curly braces to separate it from the rest of the in\-line text. If you need to use "}" inside the label, use the HTML entity notation } -.LP -There is no limit to the number of \f2{@link}\fP tags allowed in a sentence. You can use this tag in the main description part of any documentation comment or in the text portion of any tag (such as @deprecated, @return or @param). -.LP -For example, here is a comment that refers to the \f2getComponentAt(int, int)\fP method: -.nf -\f3 -.fl -Use the {@link #getComponentAt(int, int) getComponentAt} method. -.fl +.TP +{@link \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.2 -.fl -\fP -.fi -.LP -From this, the standard doclet would generate the following HTML (assuming it refers to another class in the same package): -.nf -\f3 -.fl -Use the <a href="Component.html#getComponentAt(int, int)">getComponentAt</a> method. -.fl +Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link -.fl -\fP -.fi -.LP -Which appears on the web page as: -.nf -\f3 -.fl -Use the getComponentAt method. -.fl +This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. -.fl -\fP -.fi -.LP -You can extend \f2{@link}\fP to link to classes not being documented by using the \f2\-link\fP option. -.LP -For more details, see -.na -\f2writing {@link} tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#{@link}. -.LP -.TP 3 -{@linkplain\ package.class#member\ label} -Identical to \f2{@link}\fP, except the link's label is displayed in plain text than code font. Useful when the label is plain text. Example: -.nf -\f3 -.fl - Refer to {@linkplain add() the overridden method}. -.fl +There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. -.fl -\fP -.fi -.LP -This would display as: -.LP -Refer to the overridden method. -.LP -.TP 3 -{@literal\ text} -Displays \f2text\fP without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (\f2<\fP and \f2>\fP) instead of the HTML entities (\f2<\fP and \f2>\fP) in doc comments, such as in parameter types (\f2<Object>\fP), inequalities (\f23 < 4\fP), or arrows (\f2<\-\fP). For example, the doc comment text: -.nf -\f3 -.fl - \fP\f4{@literal A<B>C}\fP\f3 -.fl +For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: +.sp +.nf +\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + + +From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): +.sp +.nf +\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The previous line appears on the web page as: +.sp +.nf +\f3Use the getComponentAt method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +{@linkplain \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.4 + +Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. +.TP +{@literal \fItext\fR} +Introduced in JDK 1\&.5 + +Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. +.TP +@param \fIparameter-name description\fR +Introduced in JDK 1\&.0 + +Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param + +The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. -.fl -\fP -.fi -.LP -displays unchanged in the generated HTML page in your browser, as: -.LP -\f2\ \ \ \ \ \fPA<B>C -.LP -The noteworthy point is that the \f2<B>\fP is not interpreted as bold (and it is not in code font). -.LP -If you want the same functionality but with the text in code font, use \f2{@code}\fP. -.LP -.TP 3 -@param\ parameter\-name description -Adds a parameter with the specified \f2parameter\-name\fP followed by the specified \f2description\fP to the "Parameters" section. When writing the doc comment, you may continue the \f2description\fP onto multiple lines. This tag is valid only in a doc comment for a method, constructor or class. -.LP -The \f2parameter\-name\fP can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method or constructor. Use angle brackets around this parameter name to specify the use of a type parameter. -.LP Example of a type parameter of a class: -.nf -\f3 -.fl - /** -.fl - * @param <E> Type of element stored in a list -.fl - */ -.fl - public interface List<E> extends Collection<E> { -.fl - } -.fl +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param <E> Type of element stored in a list\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public interface List<E> extends Collection<E> {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp + -.fl -\fP -.fi -.LP Example of a type parameter of a method: -.nf -\f3 -.fl - /** -.fl - * @param string the string to be converted -.fl - * @param type the type to convert the string to -.fl - * @param <T> the type of the element -.fl - * @param <V> the value of the element -.fl - */ -.fl - <T, V extends T> V convert(String string, Class<T> type) { -.fl - } -.fl +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param string the string to be converted\fP +.fi +.nf +\f3 * @param type the type to convert the string to\fP +.fi +.nf +\f3 * @param <T> the type of the element\fP +.fi +.nf +\f3 * @param <V> the value of the element\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3<T, V extends T> V convert(String string, Class<T> type) {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp -.fl -\fP -.fi -.LP -For more details, see -.na -\f2writing @param tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@param. -.LP -.TP 3 -@return\ description -Adds a "Returns" section with the \f2description\fP text. This text should describe the return type and permissible range of values. This tag is valid only in a doc comment for a method. -.LP -For more details, see -.na -\f2writing @return tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@return. -.LP -.TP 3 -@see\ reference -Adds a "See Also" heading with a link or text entry that points to \f2reference\fP. A doc comment may contain any number of \f2@see\fP tags, which are all grouped under the same heading. The \f2@see\fP tag has three variations; the third form below is the most common. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. For inserting an in\-line link within a sentence to a package, class or member, see \f2{@link}\fP. -.RS 3 -.TP 3 -@see "string" -Adds a text entry for \f2string\fP. No link is generated. The \f2string\fP is a book or other reference to information not available by URL. The Javadoc tool distinguishes this from the previous cases by looking for a double\-quote (\f2"\fP) as the first character. For example: -.nf -\f3 -.fl - @see "The Java Programming Language" -.fl +.TP +@return \fIdescription\fR +Introduced in JDK 1\&.0 + +Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return +.TP +@see \fIreference\fR +Introduced in JDK 1\&.0 + +Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. + +\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: + +\fISee Also\fR: -.fl -\fP -.fi -.LP -This generates text such as: -.RE -.RE -.RS 3 -.RS 3 -.RS 3 -.RS 3 -.TP 3 -See Also: "The Java Programming Language" -.RE -.RE -.TP 3 -@see <a href="URL#value">label</a> -Adds a link as defined by \f2URL\fP#\f2value\fP. The \f2URL\fP#\f2value\fP is a relative or absolute URL. The Javadoc tool distinguishes this from other cases by looking for a less\-than symbol (\f2<\fP) as the first character. For example: -.nf -\f3 -.fl - @see <a href="spec.html#section">Java Spec</a> -.fl -\fP -.fi -This generates a link such as: -.RS 3 -.TP 3 -See Also: + +\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: + +\fISee Also\fR: + Java Spec -.RE -.TP 3 -@see\ package.class#member\ label -Adds a link, with visible text \f2label\fP, that points to the documentation for the specified name in the Java Language that is referenced. The \f2label\fP is optional; if omitted, the name appears instead as the visible text, suitably shortened \-\- see How a name is displayed. Use \-noqualifier to globally remove the package name from this visible text. Use the label when you want the visible text to be different from the auto\-generated visible text. -.LP -Only in version 1.2, just the name but not the label would automatically appear in <code> HTML tags, Starting with 1.2.2, the <code> is always included around the visible text, whether or not a label is used. -.LP -.RS 3 -.TP 2 -o -\f4package.class\fP\f4#\fP\f4member\fP is any valid program element name that is referenced \-\- a package, class, interface, constructor, method or field name \-\- except that the character ahead of the member name should be a hash character (\f2#\fP). The \f2class\fP represents any top\-level or nested class or interface. The \f2member\fP represents any constructor, method or field (not a nested class or interface). If this name is in the documented classes, the Javadoc tool will automatically create a link to it. To create links to external referenced classes, use the \f2\-link\fP option. Use either of the other two \f2@see\fP forms for referring to documentation of a name that does not belong to a referenced class. This argument is described at greater length below under Specifying a Name. -.TP 2 -o -\f4label\fP is optional text that is visible as the link's label. The \f2label\fP can contain whitespace. If \f2label\fP is omitted, then \f2package.class.member\fP will appear, suitably shortened relative to the current class and package \-\- see How a name is displayed. -.TP 2 -o -A space is the delimiter between \f2package.class\fP\f2#\fP\f2member\fP and \f2label\fP. A space inside parentheses does not indicate the start of a label, so spaces may be used between parameters in a method. -.RE -.LP -\f3Example\fP \- In this example, an \f2@see\fP tag (in the \f2Character\fP class) refers to the \f2equals\fP method in the \f2String\fP class. The tag includes both arguments: the name "\f2String#equals(Object)\fP" and the label "\f2equals\fP". -.nf -\f3 -.fl - /** -.fl - * @see String#equals(Object) equals -.fl - */ -.fl -\fP -.fi -The standard doclet produces HTML something like this: -.nf -\f3 -.fl -<dl> -.fl -<dt><b>See Also:</b> -.fl -<dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals<code></a> -.fl -</dl> -.fl -\fP -.fi -Which looks something like this in a browser, where the label is the visible link text: -.RS 3 -.TP 3 -See Also: + +\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. + +In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. +.RS +.TP 0.2i +\(bu +\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. + +\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. +.TP 0.2i +\(bu +\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. +.TP 0.2i +\(bu +A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. +.RE + + +\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @see String#equals(Object) equals\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The standard doclet produces HTML that is similar to: +.sp +.nf +\f3<dl>\fP +.fi +.nf +\f3<dt><b>See Also:</b>\fP +.fi +.nf +\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP +.fi +.nf +\f3</dl>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The previous code looks similar to the following in a browser, where the label is the visible link text: + +\fISee Also\fR: + equals -.RE -.LP -\f3Specifying a name\fP \- This \f2package.class\fP\f2#\fP\f2member\fP name can be either fully\-qualified, such as \f2java.lang.String#toUpperCase()\fP or not, such as \f2String#toUpperCase()\fP or \f2#toUpperCase()\fP. If less than fully\-qualified, the Javadoc tool uses the normal Java compiler search order to find it, further described below in Search order for @see. The name can contain whitespace within parentheses, such as between method arguments. -.LP -Of course the advantage of providing shorter, "partially\-qualified" names is that they are shorter to type and there is less clutter in the source code. The following table shows the different forms of the name, where \f2Class\fP can be a class or interface, \f2Type\fP can be a class, interface, array, or primitive, and \f2method\fP can be a method or constructor. -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 -.nr 34 \n(.lu -.eo -.am 80 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Typical\ forms\ for\ \fP\f4@see\fP\f3\ \fP\f4package.class#member\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ a\ member\ of\ the\ current\ class\fP -.br -\f2@see\fP\ \f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ another\ class\ in\ the\ current\ or\ imported\ packages\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2Class.NestedClass\fP -.br -\f2@see\fP\ \f2Class\fP -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ an\ element\ in\ another\ package\fP\ (fully qualified) -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2package.Class.NestedClass\fP -.br -\f2@see\fP\ \f2package.Class\fP -.br -\f2@see\fP\ \f2package\fP -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.80 -.rm 80 -.nr 38 \n(a- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(b- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(c- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr TW \n(80 -.if t .if \n(TW>\n(.li .tm Table at line 1364 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-58 -.LP -The following notes apply to the above table: -.RS 3 -.TP 2 -o -The first set of forms (with no class or package) will cause the Javadoc tool to search only through the current class's hierarchy. It will find a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search steps 1\-3). It will not search the rest of the current package or other packages (search steps 4\-5). -.TP 2 -o -If any method or constructor is entered as a name with no parentheses, such as \f2getValue\fP, and if there is no field with the same name, the Javadoc tool will correctly create a link to it, but will print a warning message reminding you to add the parentheses and arguments. If this method is overloaded, the Javadoc tool will link to the first method its search encounters, which is unspecified. -.TP 2 -o -Nested classes must be specified as \f2outer\fP\f2.\fP\f2inner\fP, not simply \f2inner\fP, for all forms. -.TP 2 -o -As stated, the hash character (\f2#\fP), rather than a dot (\f2.\fP) separates a member from its class. This enables the Javadoc tool to resolve ambiguities, since the dot also separates classes, nested classes, packages, and subpackages. However, the Javadoc tool is generally lenient and will properly parse a dot if you know there is no ambiguity, though it will print a warning. -.RE -.LP -\f3Search order for @see\fP \- the Javadoc tool will process a \f2@see\fP tag that appears in a source file (.java), package file (package.html or package\-info.java) or overview file (overview.html). In the latter two files, you must fully\-qualify the name you supply with \f2@see\fP. In a source file, you can specify a name that is fully\-qualified or partially\-qualified. -.LP -When the Javadoc tool encounters a \f2@see\fP tag in a \f2.java\fP file that is \f2not\fP fully qualified, it searches for the specified name in the same order as the Java compiler would (except the Javadoc tool will not detect certain namespace ambiguities, since it assumes the source code is free of these errors). This search order is formally defined in the \f2Java Language Specification\fP. The Javadoc tool searches for that name through all related and imported classes and packages. In particular, it searches in this order: -.RS 3 -.TP 3 -1. -the current class or interface -.TP 3 -2. -any enclosing classes and interfaces, searching closest first -.TP 3 -3. -any superclasses and superinterfaces, searching closest first -.TP 3 -4. -the current package -.TP 3 -5. -any imported packages, classes and interfaces, searching in the order of the import statement -.RE -.LP -The Javadoc tool continues to search recursively through steps 1\-3 for each class it encounters until it finds a match. That is, after it searches through the current class and its enclosing class E, it will search through E's superclasses before E's enclosing classes. In steps 4 and 5, the Javadoc tool does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler). In step 5, the Javadoc tool looks in java.lang, since that is automatically imported by all programs. -.LP -The Javadoc tool does not necessarily look in subclasses, nor will it look in other packages even if their documentation is being generated in the same run. For example, if the \f2@see\fP tag is in the \f2java.awt.event.KeyEvent\fP class and refers to a name in the \f2java.awt\fP package, javadoc does not look in that package unless that class imports it. -.LP -\f3How a name is displayed\fP \- If \f2label\fP is omitted, then \f2package.class.member\fP appears. In general, it is suitably shortened relative to the current class and package. By "shortened", we mean the Javadoc tool displays only the minimum name necessary. For example, if the \f2String.toUpperCase()\fP method contains references to a member of the same class and to a member of a different class, the class name is displayed only in the latter case, as shown in the following table. -.LP -Use \-noqualifier to globally remove the package names. -.br -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f3Example in \fP\f4String.toUpperCase()\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of the same class, same package -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2toLowerCase()\fP (omits the package and class names) -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of a different class, same package -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@see Character#toLowerCase(char)\fP -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2Character.toLowerCase(char)\fP (omits the package name, includes the class name) -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of a different class, different package -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@see java.io.File#exists()\fP -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2java.io.File.exists()\fP (includes the package and class names) -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Type of Reference\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(b- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(g- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f2@see String#toLowerCase()\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 82 0 -.nr 38 \w\f3Displays As\fP -.if \n(82<\n(38 .nr 82 \n(38 -.82 -.rm 82 -.nr 38 \n(c- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \n(f- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \n(i- -.if \n(82<\n(38 .nr 82 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr TW \n(82 -.if t .if \n(TW>\n(.li .tm Table at line 1440 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Type of Reference\fP\h'|\n(41u'\h'|\n(42u'\f3Displays As\fP -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.ne \n(c|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\f2@see String#toLowerCase()\fP\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.ne \n(f|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.ne \n(h|u+\n(.Vu -.ne \n(i|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-28 -.LP -\f3Examples of @see\fP -.br -The comment to the right shows how the name would be displayed if the \f2@see\fP tag is in a class in another package, such as \f2java.applet.Applet\fP. -.nf -\f3 -.fl - See also: -.fl -@see java.lang.String // String \fP\f3 -.fl -@see java.lang.String The String class // The String class \fP\f3 -.fl -@see String // String \fP\f3 -.fl -@see String#equals(Object) // String.equals(Object) \fP\f3 -.fl -@see String#equals // String.equals(java.lang.Object) \fP\f3 -.fl -@see java.lang.Object#wait(long) // java.lang.Object.wait(long) \fP\f3 -.fl -@see Character#MAX_RADIX // Character.MAX_RADIX \fP\f3 -.fl -@see <a href="spec.html">Java Spec</a> // Java Spec \fP\f3 -.fl -@see "The Java Programming Language" // "The Java Programming Language" \fP\f3 -.fl -\fP -.fi -You can extend \f2@see\fP to link to classes not being documented by using the \f2\-link\fP option. -.LP -For more details, see -.na -\f2writing @see tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@see. -.RE -.RE -.LP -.RS 3 -.TP 3 -@serial\ field\-description | include | exclude -Used in the doc comment for a default serializable field. -.LP -An optional \f2field\-description\fP should explain the meaning of the field and list the acceptable values. If needed, the description can span multiple lines. The standard doclet adds this information to the serialized form page. -.LP -If a serializable field was added to a class some time after the class was made serializable, a statement should be added to its main description to identify at which version it was added. -.LP -The \f2include\fP and \f2exclude\fP arguments identify whether a class or package should be included or excluded from the serialized form page. They work as follows: -.RS 3 -.TP 2 -o -A public or protected class that implements \f2Serializable\fP is \f2included\fP unless that class (or its package) is marked \f2@serial exclude\fP. -.TP 2 -o -A private or package\-private class that implements \f2Serializable\fP is \f2excluded\fP unless that class (or its package) is marked \f2@serial include\fP. -.RE -.LP -Examples: The \f2javax.swing\fP package is marked \f2@serial exclude\fP (in \f2package.html\fP or \f2package\-info.java\fP). The public class \f2java.security.BasicPermission\fP is marked \f2@serial exclude\fP. The package\-private class \f2java.util.PropertyPermissionCollection\fP is marked \f2@serial include\fP. -.LP -The tag @serial at a class level overrides @serial at a package level. -.LP -For more information about how to use these tags, along with an example, see " -.na -\f2Documenting Serializable Fields and Data for a Class\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/serialization/spec/serial\-arch.html," Section 1.6 of the \f2Java Object Serialization Specification\fP. Also see the -.na -\f2Serialization FAQ\fP @ -.fi -http://java.sun.com/javase/technologies/core/basic/serializationFAQ.jsp#javadoc_warn_missing, which covers common questions, such as "Why do I see javadoc warnings stating that I am missing @serial tags for private fields if I am not running javadoc with the \-private switch?". Also see -.na -\f2Sun's criteria\fP @ -.fi -http://java.sun.com/j2se/javadoc/writingapispecs/serialized\-criteria.html for including classes in the serialized form specification. -.LP -.TP 3 -@serialField\ field\-name\ field\-type\ field\-description -Documents an \f2ObjectStreamField\fP component of a \f2Serializable\fP class's \f2serialPersistentFields\fP member. One \f2@serialField\fP tag should be used for each \f2ObjectStreamField\fP component. -.LP -.TP 3 -@serialData\ data\-description -The \f2data\-description\fP documents the types and order of data in the serialized form. Specifically, this data includes the optional data written by the \f2writeObject\fP method and all data (including base classes) written by the \f2Externalizable.writeExternal\fP method. -.LP -The \f2@serialData\fP tag can be used in the doc comment for the \f2writeObject\fP, \f2readObject\fP, \f2writeExternal\fP, \f2readExternal\fP, \f2writeReplace\fP, and \f2readResolve\fP methods. -.LP -.TP 3 -@since\ since\-text -Adds a "Since" heading with the specified \f2since\-text\fP to the generated documentation. The text has no special internal structure. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. This tag means that this change or feature has existed since the software release specified by the \f2since\-text\fP. For example: -.nf -\f3 -.fl - @since 1.5 -.fl +.PP +Specify a Name -.fl -\fP -.fi -.LP -For source code in the Java platform, this tag indicates the version of the Java platform API specification (not necessarily when it was added to the reference implementation). Multiple @since tags are allowed and are treated like multiple @author tags. You could use multiple tags if the prgram element is used by more than one API. -.LP -.TP 3 -@throws\ class\-name\ description -The \f2@throws\fP and \f2@exception\fP tags are synonyms. Adds a "Throws" subheading to the generated documentation, with the \f2class\-name\fP and \f2description\fP text. The \f2class\-name\fP is the name of the exception that may be thrown by the method. This tag is valid only in the doc comment for a method or constructor. If this class is not fully\-specified, the Javadoc tool uses the search order to look up this class. Multiple \f2@throws\fP tags can be used in a given doc comment for the same or different exceptions. -.LP -To ensure that all checked exceptions are documented, if a \f2@throws\fP tag does not exist for an exception in the throws clause, the Javadoc tool automatically adds that exception to the HTML output (with no description) as if it were documented with @throws tag. -.LP -The \f2@throws\fP documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method. The same is true for copying from an interface method to an implementing method. You can use {@inheritDoc} to force @throws to inherit documentation. -.LP -For more details, see -.na -\f2writing @throws tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@exception. -.LP -.TP 3 -{@value\ package.class#field} -When \f2{@value}\fP is used (without any argument) in the doc comment of a static field, it displays the value of that constant: -.nf -\f3 -.fl - /** -.fl - * The value of this constant is {@value}. -.fl - */ -.fl - public static final String SCRIPT_START = "<script>" -.fl +\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. +.sp +.nf +\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP +.fi +.nf +\f3\fIReferencing a member of the current class\fR\fP +.fi +.nf +\f3@see #field\fP +.fi +.nf +\f3@see #method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3\fIReferencing another class in the current or imported packages\fR\fP +.fi +.nf +\f3@see Class#field\fP +.fi +.nf +\f3@see Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class\&.NestedClass\fP +.fi +.nf +\f3@see Class \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3\fIReferencing an element in another package (fully qualified)\fR\fP +.fi +.nf +\f3@see package\&.Class#field\fP +.fi +.nf +\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class\&.NestedClass\fP +.fi +.nf +\f3@see package\&.Class\fP +.fi +.nf +\f3@see package\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3\fRNotes about the previous listing: +.TP 0.2i +\(bu +The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. +.TP 0.2i +\(bu +If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. +.TP 0.2i +\(bu +Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. +.TP 0.2i +\(bu +As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. +.PP +Search Order for the @see Tag -.fl -\fP -.fi -.LP -When used with argument \f2package.class#field\fP in any doc comment, it displays the value of the specified constant: -.nf -\f3 -.fl - /** -.fl - * Evaluates the script starting with {@value #SCRIPT_START}. -.fl - */ -.fl - public String evalScript(String script) { -.fl - } -.fl +\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. +.PP +The following is the search order for the \f3@see\fR tag\&. +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superonterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. +.PP +The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. +.PP +When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces, searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. +.PP +The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. +.PP +How a Name Appears -.fl -\fP -.fi -.LP -The argument \f2package.class#field\fP takes a form identical to that of the @see argument, except that the member must be a static field. -.LP -These values of these constants are also displayed on the -.na -\f2Constant Field Values\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/constant\-values.html page. -.LP -.TP 3 -@version\ version\-text -Adds a "Version" subheading with the specified \f2version\-text\fP to the generated docs when the \-version option is used. This tag is intended to hold the current version number of the software that this code is part of (as opposed to @since, which holds the version number where this code was introduced). The \f2version\-text\fP has no special internal structure. To see where the version tag can be used, see Where Tags Can Be Used. -.LP -A doc comment may contain multiple \f2@version\fP tags. If it makes sense, you can specify one version number per \f2@version\fP tag or multiple version numbers per tag. In the former case, the Javadoc tool inserts a comma (\f2,\fP) and space between names. In the latter case, the entire text is simply copied to the generated document without being parsed. Therefore, you can use multiple names per line if you want a localized name separator other than comma. -.LP -For more details, see -.na -\f2writing @version tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@version. +\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package +.br +\fIExample in\fR: \f3@see String#toLowerCase()\fR +.br +\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package +.br +\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR +.br +\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package +.br +\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR +.br +\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names +.br + +.PP +Examples of the @see Tag + +The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see +.sp +.nf +\f3 See also:\fP +.fi +.nf +\f3@see java\&.lang\&.String // String \fP +.fi +.nf +\f3@see java\&.lang\&.String The String class // The String class \fP +.fi +.nf +\f3@see String // String \fP +.fi +.nf +\f3@see String#equals(Object) // String\&.equals(Object) \fP +.fi +.nf +\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP +.fi +.nf +\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP +.fi +.nf +\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP +.fi +.nf +\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP +.fi +.nf +\f3@see "The Java Programming Language" // "The Java Programming Language" \fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. +.TP +@serial \fIfield-description\fR | include | exclude +Introduced in JDK 1\&.2 + +Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 + +See also Oracle\(cqs Criteria for Including Classes in the Serialilzed Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html + +An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. + +If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. + +The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: +.RS +.TP 0.2i +\(bu +A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. +.TP 0.2i +\(bu +A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. .RE -.SS -Where Tags Can Be Used -.LP -The following sections describe where the tags can be used. Note that these tags can be used in all doc comments: \f2@see\fP, \f2@since\fP, \f2@deprecated\fP, \f2{@link}\fP, \f2{@linkplain}\fP, and \f2{@docroot}\fP. -.SS -Overview Documentation Tags -.LP -Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named \f2overview.html\fP). Like in any other documentation comments, these tags must appear after the main description. -.LP -\f3NOTE\fP \- The \f2{@link}\fP tag has a bug in overview documents in version 1.2 \-\- the text appears properly but has no link. The \f2{@docRoot}\fP tag does not currently work in overview documents. -.LP -\f3Overview Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP +.RS +For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. + +The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. + .RE -.SS -Package Documentation Tags -.LP -Package tags are tags that can appear in the documentation comment for a package (which resides in the source file named \f2package.html\fP or \f2package\-info.java\fP). The \f2@serial\fP tag can only be used here with the \f2include\fP or \f2exclude\fP argument. -.LP -\f3Package Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -.SS -Class and Interface Documentation Tags -.LP -The following are tags that can appear in the documentation comment for a class or interface. The \f2@serial\fP tag can only be used here with the \f2include\fP or \f2exclude\fP argument. -.LP -\f3Class/Interface Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -\f3An example of a class comment:\fP -.nf -\f3 -.fl -/** -.fl - * A class representing a window on the screen. -.fl - * For example: -.fl - * <pre> -.fl - * Window win = new Window(parent); -.fl - * win.show(); -.fl - * </pre> -.fl - * -.fl - * @author Sami Shaio -.fl - * @version 1.13, 06/08/06 -.fl - * @see java.awt.BaseWindow -.fl - * @see java.awt.Button -.fl - */ -.fl -class Window extends BaseWindow { -.fl - ... -.fl -} -.fl -\fP -.fi -.SS -Field Documentation Tags -.LP -The following are the tags that can appear in -.LP -\f3Field Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@serialField\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.TP 2 -o -\f2{@value}\fP -.RE -\f3An example of a field comment:\fP -.nf -\f3 -.fl - /** -.fl - * The X\-coordinate of the component. -.fl - * -.fl - * @see #getLocation() -.fl - */ -.fl - int x = 1263732; -.fl -\fP -.fi -.SS -Constructor and Method Documentation Tags -.LP -The following are the tags that can appear in the documentation comment for a constructor or method, except for \f2@return\fP, which cannot appear in a constructor, and \f2{@inheritDoc}\fP, which has certain restrictions. The \f2@serialData\fP tag can only be used in the doc comment for certain serialization methods. -.LP -\f3Method/Constructor Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@param\fP -.TP 2 -o -\f2@return\fP -.TP 2 -o -\f2@throws\fP and \f2@exception\fP -.TP 2 -o -\f2@serialData\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@inheritDoc}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -\f3An example of a method doc comment:\fP -.nf -\f3 -.fl - /** -.fl - * Returns the character at the specified index. An index -.fl - * ranges from <code>0</code> to <code>length() \- 1</code>. -.fl - * -.fl - * @param index the index of the desired character. -.fl - * @return the desired character. -.fl - * @exception StringIndexOutOfRangeException -.fl - * if the index is not in the range <code>0</code> -.fl - * to <code>length()\-1</code>. -.fl - * @see java.lang.Character#charValue() -.fl - */ -.fl - public char charAt(int index) { -.fl - ... -.fl - } -.fl -\fP -.fi -.SH "OPTIONS" -.LP -The javadoc tool uses doclets to determine its output. The Javadoc tool uses the default standard doclet unless a custom doclet is specified with the \-doclet option. The Javadoc tool provides a set of command\-line options that can be used with any doclet \-\- these options are described below under the sub\-heading Javadoc Options. The standard doclet provides an additional set of command\-line options that are described below under the sub\-heading Options Provided by the Standard Doclet. All option names are case\-insensitive, though their arguments can be case\-sensitive. -.LP +.TP +@serialData \fIdata-description\fR +Introduced in JDK 1\&.2 + +Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. + +The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.TP +@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR +Introduced in JDK 1\&.2 + +Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. +.TP +@since \fIsince-text\fR +Introduced in JDK 1\&.1 + +Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. + +For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. +.TP +@throws \fIclass-name\fR\fIdescription\fR +Introduced in JDK 1\&.2 + +Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception + +The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. + +To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. + +The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. +.TP +{@value \fIpackage\&.class#field\fR} +Introduced in JDK 1\&.4 + +Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * The value of this constant is {@value}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static final String SCRIPT_START = "<script>"\fP +.fi +.nf +\f3\fR +.fi +.sp + + +When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public String evalScript(String script) {}\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. + +The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html +.TP +@version \fIversion-text\fR +Introduced in JDK 1\&.0 + +Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version + +A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. +.SH WHERE\ TAGS\ CAN\ BE\ USED +The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. +.SS OVERVIEW\ TAGS +Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description +.PP +\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. +.PP +The overview tags are the following: +.PP +@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS PACKAGE\ TAGS +Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. +.PP +The package tags are the following: +.PP +@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS CLASS\ AND\ INTERFACE\ TAGS +The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.PP +Class comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * A class representing a window on the screen\&.\fP +.fi +.nf +\f3 * For example:\fP +.fi +.nf +\f3 * <pre>\fP +.fi +.nf +\f3 * Window win = new Window(parent);\fP +.fi +.nf +\f3 * win\&.show();\fP +.fi +.nf +\f3 * </pre>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @author Sami Shaio\fP +.fi +.nf +\f3 * @version 1\&.13, 06/08/06\fP +.fi +.nf +\f3 * @see java\&.awt\&.BaseWindow\fP +.fi +.nf +\f3 * @see java\&.awt\&.Button\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3class Window extends BaseWindow {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS FIELD\ TAGS +These tags can appear in fields: +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} +.PP +Field comment example: +.sp +.nf +\f3 /**\fP +.fi +.nf +\f3 * The X\-coordinate of the component\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @see #getLocation()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 int x = 1263732;\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS CONSTRUCTOR\ AND\ METHOD\ TAGS +The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} +.PP +\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.PP +Method comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Returns the character at the specified index\&. An index \fP +.fi +.nf +\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @param index the index of the desired character\&.\fP +.fi +.nf +\f3 * @return the desired character\&.\fP +.fi +.nf +\f3 * @exception StringIndexOutOfRangeException \fP +.fi +.nf +\f3 * if the index is not in the range <code>0</code> \fP +.fi +.nf +\f3 * to <code>length()\-1</code>\fP +.fi +.nf +\f3 * @see java\&.lang\&.Character#charValue()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 public char charAt(int index) {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fR +.fi +.sp +.SH OPTIONS +The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. +.TP 0.2i +\(bu +See also Javadoc Options +.TP 0.2i +\(bu +See also Standard Doclet Options +.PP The options are: -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 -.nr 34 \n(.lu -.eo -.am 80 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\-\f21.1\fP -.br -\-author -.br -\-\f2bootclasspath\fP -.br -\-bottom -.br -\-\f2breakiterator\fP -.br -\-charset -.br -\-\f2classpath\fP -.br -\-d -.br -\-docencoding -.br -\-docfilessubdirs -.br -\-\f2doclet\fP -.br -\-\f2docletpath\fP -.br -\-doctitle -.br -\-\f2encoding\fP -.br -\-\f2exclude\fP -.br -\-excludedocfilessubdir -.br -\-\f2extdirs\fP -.br -\-footer -.br -\-group -.br -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\-header -.br -\-\f2help\fP -.br -\-helpfile -.br -\-\f2J\fP -.br -\-keywords -.br -\-link -.br -\-linkoffline -.br -\-linksource -.br -\-\f2locale\fP -.br -\-nocomment -.br -\-nodeprecated -.br -\-nodeprecatedlist -.br -\-nohelp -.br -\-noindex -.br -\-nonavbar -.br -\-noqualifier -.br -\-nosince -.br -\-notimestamp -.br -\-notree -.br -\-\f2overview\fP -.br -\-\f2package\fP -.br -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\-\f2private\fP -.br -\-\f2protected\fP -.br -\-\f2public\fP -.br -\-\f2quiet\fP -.br -\-serialwarn -.br -\-\f2source\fP -.br -\-\f2sourcepath\fP -.br -\-sourcetab -.br -\-splitindex -.br -\-stylesheetfile -.br -\-\f2subpackages\fP -.br -\-tag -.br -\-taglet -.br -\-tagletpath -.br -\-top -.br -\-title -.br -\-use -.br -\-\f2verbose\fP -.br -\-version -.br -\-windowtitle -.br -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.80 -.rm 80 -.nr 38 \n(a- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.81 -.rm 81 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 82 0 -.82 -.rm 82 -.nr 38 \n(c- -.if \n(82<\n(38 .nr 82 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr TW \n(82 -.if t .if \n(TW>\n(.li .tm Table at line 2015 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.ne \n(b|u+\n(.Vu -.ne \n(c|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-127 -.LP -Options shown in \f2italic\fP are the Javadoc core options, which are provided by the front end of the Javadoc tool and are available to all doclets. The standard doclet itself provides the non\-italic options. -.SS -Javadoc Options -.RS 3 -.TP 3 -\-overview \ path/filename -Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by \f2path/filename\fP and place it on the Overview page (\f2overview\-summary.html\fP). The \f2path/filename\fP is relative to the current directory. -.br -.br -While you can use any name you want for \f2filename\fP and place it anywhere you want for \f2path\fP, a typical thing to do is to name it \f2overview.html\fP and place it in the source tree at the directory that contains the topmost package directories. In this location, no \f2path\fP is needed when documenting packages, since \f2\-sourcepath\fP will point to this file. For example, if the source tree for the \f2java.lang\fP package is \f2/src/classes/java/lang/\fP, then you could place the overview file at \f2/src/classes/overview.html\fP. See Real World Example. -.br -.br -For information about the file specified by \f2path/filename\fP, see overview comment file. -.br -.br -Note that the overview page is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) -.br -.br -The title on the overview page is set by \f2\-doctitle\fP. -.TP 3 -\-public -Shows only public classes and members. -.TP 3 -\-protected -Shows only protected and public classes and members. This is the default. -.TP 3 -\-package -Shows only package, protected, and public classes and members. -.TP 3 -\-private -Shows all classes and members. -.TP 3 -\-help -Displays the online help, which lists these javadoc and doclet command line options. -.TP 3 -\-doclet\ class -Specifies the class file that starts the doclet used in generating the documentation. Use the fully\-qualified name. This doclet defines the content and formats the output. If the \f4\-doclet\fP option is not used, javadoc uses the standard doclet for generating the default HTML format. This class must contain the \f2start(Root)\fP method. The path to this starting class is defined by the \f2\-docletpath\fP option. -.br -.br -For example, to call the MIF doclet, use: -.nf -\f3 -.fl - \-doclet com.sun.tools.doclets.mif.MIFDoclet -.fl -\fP -.fi -For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.TP 3 -\-docletpath\ classpathlist -Specifies the path to the doclet starting class file (specified with the \f2\-doclet\fP option) and any jar files it depends on. If the starting class file is in a jar file, then this specifies the path to that jar file, as shown in the example below. You can specify an absolute path or a path relative to the current directory. If \f2classpathlist\fP contains multiple paths or jar files, they should be separated with a colon (:) on Solaris and a semi\-colon (;) on Windows. This option is not necessary if the doclet starting class is already in the search path. -.br -.br -Example of path to jar file that contains the starting doclet class file. Notice the jar filename is included. -.nf -\f3 -.fl - \-docletpath /home/user/mifdoclet/lib/mifdoclet.jar -.fl -\fP -.fi -Example of path to starting doclet class file. Notice the class filename is omitted. -.nf -\f3 -.fl - \-docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/ -.fl -\fP -.fi -For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.TP 3 -\-1.1 -\f2This feature has been removed from Javadoc 1.4. There is no replacement for it. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1.1 (it never supported nested classes). If you need this option, use Javadoc 1.2 or 1.3 instead.\fP -.TP 3 -\-source release -Specifies the version of source code accepted. The following values for \f2release\fP are allowed: -.RS 3 -.TP 2 -o -\f31.5\fP \- javadoc accepts code containing generics and other language features introduced in JDK 1.5. The compiler defaults to the 1.5 behavior if the \f3\-source\fP flag is not used. -.TP 2 -o -\f31.4\fP \- javadoc accepts code containing assertions, which were introduced in JDK 1.4. -.TP 2 -o -\f31.3\fP \- javadoc does \f2not\fP support assertions, generics, or other language features introduced after JDK 1.3. +.PP +-1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title +.PP +The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. +.SS JAVADOC\ OPTIONS +.TP +-overview \fIpath/filename\fR +.br +Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. + +While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. + +For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html + +See Real-World Examples\&. + +For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. + +The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. +.TP +-Xdoclint:(all|none|[-]\fI<group>\fR) +.br +Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. + +This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. + +When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. + +By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. + +Change what the \f3-Xdoclint\fR option reports with the following options: +.RS +.TP 0.2i +\(bu +\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option +.TP 0.2i +\(bu +\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks +.TP 0.2i +\(bu +\f3-Xdoclint all\fR : enable all groups of checks +.TP 0.2i +\(bu +\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks .RE -Use the value of \f2release\fP corresponding to that used when compiling the code with javac. -.TP 3 -\-sourcepath\ sourcepathlist -Specifies the search paths for finding source files (\f2.java\fP) when passing package names or \f2\-subpackages\fP into the \f2javadoc\fP command. The \f2sourcepathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented but whose comments are inherited by the source files being documented. +.RS +The variable \fIgroup\fR has one of the following values: +.RS + +.RE +.TP 0.2i +\(bu +\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. +.TP 0.2i +\(bu +\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. +.TP 0.2i +\(bu +\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. +.TP 0.2i +\(bu +\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. +.TP 0.2i +\(bu +\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. +.RE +.RS +You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. +.sp +.nf +\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP +.fi +.nf +\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. + +The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. + +.RE +.TP +-public .br +Shows only public classes and members\&. +.TP +-protected .br -Note that you can use the \f2\-sourcepath\fP option only when passing package names into the javadoc command \-\- it will not locate \f2.java\fP files passed into the \f2javadoc\fP command. (To locate \f2.java\fP files, cd to that directory or include the path ahead of each file, as shown at Documenting One or More Classes.) If \f2\-sourcepath\fP is omitted, javadoc uses the class path to find the source files (see \-classpath). Therefore, the default \-sourcepath is the value of class path. If \-classpath is omitted and you are passing package names into javadoc, it looks in the current directory (and subdirectories) for the source files. +Shows only protected and public classes and members\&. This is the default\&. +.TP +-package .br +Shows only package, protected, and public classes and members\&. +.TP +-private .br -Set \f2sourcepathlist\fP to the root directory of the source tree for the package you are documenting. For example, suppose you want to document a package called \f2com.mypackage\fP whose source files are located at: -.nf -\f3 -.fl - /home/user/src/com/mypackage/*.java -.fl -\fP -.fi -In this case you would specify the \f2sourcepath\fP to \f2/home/user/src\fP, the directory that contains \f2com/mypackage\fP, and then supply the package name \f2com.mypackage\fP: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user/src/ com.mypackage\fP -.fl -.fi -This is easy to remember by noticing that if you concatenate the value of sourcepath and the package name together and change the dot to a slash "/", you end up with the full path to the package: \f2/home/user/src/com/mypackage\fP. +Shows all classes and members\&. +.TP +-help .br +Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. +.TP +-doclet \fIclass\fR .br +Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-docletpath \fIclasspathlist\fR +.br +Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-1\&.1 +.br +Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. +.TP +-source \fIrelease\fR +.br +Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. +.RS +.TP 0.2i +\(bu +\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. +.RE + +.TP +-sourcepath \fIsourcepathlist\fR +.br +Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. + +You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. + +Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. + +For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: +.sp +.nf +\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: + +/home/user/src/com/mypackage + To point to two source paths: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com.mypackage\fP -.fl -.fi -.TP 3 -\-classpath\ classpathlist -Specifies the paths where javadoc will look for referenced classes (\f2.class\fP files) \-\- these are the documented classes plus any classes referenced by those classes. The \f2classpathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. Follow the instructions in -.na -\f2class path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general documentation for specifying \f2classpathlist\fP. -.br -.br -If \f2\-sourcepath\fP is omitted, the Javadoc tool uses \f2\-classpath\fP to find the source files as well as class files (for backward compatibility). Therefore, if you want to search for source and class files in separate paths, use both \f2\-sourcepath\fP and \f2\-classpath\fP. -.br -.br -For example, if you want to document \f2com.mypackage\fP, whose source files reside in the directory \f2/home/user/src/com/mypackage\fP, and if this package relies on a library in \f2/home/user/lib\fP, you would specify: -.nf -\f3 -.fl - % \fP\f3javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage\fP -.fl -.fi -As with other tools, if you do not specify \f2\-classpath\fP, the Javadoc tool uses the CLASSPATH environment variable, if it is set. If both are not set, the Javadoc tool searches for classes from the current directory. -.br -.br -For an in\-depth description of how the Javadoc tool uses \f2\-classpath\fP to find user classes as it relates to extension classes and bootstrap classes, see -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html. -.br -.br -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a Java program cannot tell the difference between the two invocations). -.br -.br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.TP 3 -\-subpackages\ \ package1:package2:... -Generates documentation from source files in the specified packages and recursively in their subpackages. This option is useful when adding new subpackages to the source code, as they are automatically included. Each \f2package\fP argument is any top\-level subpackage (such as \f2java\fP) or fully qualified package (such as \f2javax.swing\fP) that does not need to contain source files. Arguments are separated by colons (on all operating systmes). Wildcards are not needed or allowed. Use \f2\-sourcepath\fP to specify where to find the packages. This option is smart about not processing source files that are in the source tree but do not belong to the packages, as described at processing of source files. -.br -.br -For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP -.fl -.fi -This command generates documentation for packages named "java" and "javax.swing" and all their subpackages. -.br -.br -You can use \f2\-subpackages\fP in conjunction with \f2\-exclude\fP to exclude specific packages. -.TP 3 -\-exclude\ \ packagename1:packagename2:... -Unconditionally excludes the specified packages and their subpackages from the list formed by \f2\-subpackages\fP. It excludes those packages even if they would otherwise be included by some previous or later \f2\-subpackages\fP option. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude java.net:java.lang\fP -.fl -.fi -would include \f2java.io\fP, \f2java.util\fP, and \f2java.math\fP (among others), but would exclude packages rooted at \f2java.net\fP and \f2java.lang\fP. Notice this excludes \f2java.lang.ref\fP, a subpackage of \f2java.lang\fP). -.TP 3 -\-bootclasspath\ classpathlist -Specifies the paths where the boot classes reside. These are nominally the Java platform classes. The bootclasspath is part of the search path the Javadoc tool will use to look up source and class files. See -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfiles. for more details. Separate directories in \f2classpathlist\fP with colons (:). -.TP 3 -\-extdirs\ dirlist -Specifies the directories where extension classes reside. These are any classes that use the Java Extension mechanism. The extdirs is part of the search path the Javadoc tool will use to look up source and class files. See \f2\-classpath\fP (above) for more details. Separate directories in \f2dirlist\fP with colons (:). -.TP 3 -\-verbose -Provides more detailed messages while javadoc is running. Without the verbose option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting. The verbose option causes the printing of additional messages specifying the number of milliseconds to parse each java source file. -.TP 3 -\-quiet -Shuts off non\-error and non\-warning messages, leaving only the warnings and errors appear, making them easier to view. Also suppresses the version string. -.TP 3 -\-breakiterator\ -Uses the internationalized sentence boundary of -.na -\f2java.text.BreakIterator\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/text/BreakIterator.html to determine the end of the first sentence for English (all other locales already use \f2BreakIterator\fP), rather than an English language, locale\-specific algorithm. By \f2first sentence\fP, we mean the first sentence in the main description of a package, class or member. This sentence is copied to the package, class or member summary, and to the alphabetic index. -.br -.br -From JDK 1.2 forward, the BreakIterator class is already used to determine the end of sentence for all languages but English. Therefore, the \f2\-breakiterator\fP option has no effect except for English from 1.2 forward. English has its own default algorithm: -.RS 3 -.TP 2 -o -English default sentence\-break algorithm \- Stops at a period followed by a space or a HTML block tag, such as \f2<P>\fP. -.TP 2 -o -Breakiterator sentence\-break algorithm \- In general, stops at a period, question mark or exclamation mark followed by a space if the next word starts with a capital letter. This is meant to handle most abbreviations (such as "The serial no. is valid", but won't handle "Mr. Smith"). Doesn't stop at HTML tags or sentences that begin with numbers or symbols. Stops at the last period in "../filename", even if embedded in an HTML tag. -.RE -NOTE: We have removed from 1.5.0 the breakiterator warning messages that were in 1.4.x and have left the default sentence\-break algorithm unchanged. That is, the \-breakiterator option is not the default in 1.5.0, nor do we expect it to become the default. This is a reversal from our former intention that the default would change in the "next major release" (1.5.0). This means if you have not modified your source code to eliminate the breakiterator warnings in 1.4.x, then you don't have to do anything, and the warnings go away starting with 1.5.0. The reason for this reversal is because any benefit to having breakiterator become the default would be outweighed by the incompatible source change it would require. We regret any extra work and confusion this has caused. -.TP 3 -\-locale\ language_country_variant -\f3Important\fP \- The \f2\-locale\fP option must be placed \f2ahead\fP (to the left) of any options provided by the standard doclet or any other doclet. Otherwise, the navigation bars will appear in English. This is the only command\-line option that is order\-dependent. -.br -.br -Specifies the locale that javadoc uses when generating documentation. The argument is the name of the locale, as described in java.util.Locale documentation, such as \f2en_US\fP (English, United States) or \f2en_US_WIN\fP (Windows variant). -.br -.br -Specifying a locale causes javadoc to choose the resource files of that locale for messages (strings in the navigation bar, headings for lists and tables, help file contents, comments in stylesheet.css, and so forth). It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence. It does not determine the locale of the doc comment text specified in the source files of the documented classes. -.TP 3 -\-encoding\ name -Specifies the encoding name of the source files, such as \f2EUCJIS/SJIS\fP. If this option is not specified, the platform default converter is used. -.br -.br -Also see \-docencoding and \-charset. -.TP 3 -\-Jflag -Passes \f2flag\fP directly to the runtime system java that runs javadoc. Notice there must be no space between the \f2J\fP and the \f2flag\fP. For example, if you need to ensure that the system sets aside 32 megabytes of memory in which to process the generated documentation, then you would call the \f2\-Xmx\fP option of java as follows (\f2\-Xms\fP is optional, as it only sets the size of initial memory, which is useful if you know the minimum amount of memory required): -.nf -\f3 -.fl - % \fP\f3javadoc \-J\-Xmx32m \-J\-Xms32m\fP \f3com.mypackage\fP -.fl -.fi -To tell what version of javadoc you are using, call the "\f2\-version\fP" option of java: -.nf -\f3 -.fl - % \fP\f3javadoc \-J\-version\fP -.fl - java version "1.2" -.fl - Classic VM (build JDK\-1.2\-V, green threads, sunwjit) -.fl -.fi -(The version number of the standard doclet appears in its output stream.) -.RE -.SS -Options Provided by the Standard Doclet -.RS 3 -.TP 3 -\-d\ directory -Specifies the destination directory where javadoc saves the generated HTML files. (The "d" means "destination.") Omitting this option causes the files to be saved to the current directory. The value \f2directory\fP can be absolute, or relative to the current working directory. As of 1.4, the destination directory is automatically created when javadoc is run. -.br -.br -For example, the following generates the documentation for the package \f2com.mypackage\fP and saves the results in the \f2/home/user/doc/\fP directory: -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/user/doc com.mypackage\fP -.fl -.fi -.TP 3 -\-use -Includes one "Use" page for each documented class and package. The page describes what packages, classes, methods, constructors and fields use any API of the given class or package. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C. -.br -.br -For example, let us look at what might appear on the "Use" page for String. The \f2getName()\fP method in the \f2java.awt.Font\fP class returns type \f2String\fP. Therefore, \f2getName()\fP uses \f2String\fP, and you will find that method on the "Use" page for \f2String\fP. -.br -.br -Note that this documents only uses of the API, not the implementation. If a method uses \f2String\fP in its implementation but does not take a string as an argument or return a string, that is not considered a "use" of \f2String\fP. -.br -.br -You can access the generated "Use" page by first going to the class or package, then clicking on the "Use" link in the navigation bar. -.TP 3 -\-version -Includes the @version text in the generated docs. This text is omitted by default. To tell what version of the Javadoc tool you are using, use the \f2\-J\-version\fP option. -.TP 3 -\-author -Includes the @author text in the generated docs. -.TP 3 -\-splitindex -Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non\-alphabetical characters. -.TP 3 -\-windowtitle\ title -Specifies the title to be placed in the HTML <title> tag. This appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page. This title should not contain any HTML tags, as the browser will not properly interpret them. Any internal quotation marks within \f2title\fP may have to be escaped. If \-windowtitle is omitted, the Javadoc tool uses the value of \-doctitle for this option. -.nf -\f3 -.fl - % \fP\f3javadoc \-windowtitle "Java SE Platform" com.mypackage\fP -.fl -.fi -.TP 3 -\-doctitle\ title -Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level\-one heading directly beneath the upper navigation bar. The \f2title\fP may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2title\fP may have to be escaped. -.nf -\f3 -.fl - % \fP\f3javadoc \-doctitle "Java(TM)" com.mypackage\fP -.fl -.fi -.TP 3 -\-title\ title -\f3This option no longer exists.\fP It existed only in Beta versions of Javadoc 1.2. It has been renamed to \f2\-doctitle\fP. This option is being renamed to make it clear that it defines the document title rather than the window title. -.TP 3 -\-header\ header -Specifies the header text to be placed at the top of each output file. The header will be placed to the right of the upper navigation bar. \f2header\fP may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2header\fP may have to be escaped. -.nf -\f3 -.fl - % \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP -.fl -.fi -.TP 3 -\-footer\ footer -Specifies the footer text to be placed at the bottom of each output file. The footer will be placed to the right of the lower navigation bar. \f2footer\fP may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2footer\fP may have to be escaped. -.TP 3 -\-top -Specifies the text to be placed at the top of each output file. -.TP 3 -\-bottom\ text -Specifies the text to be placed at the bottom of each output file. The text will be placed at the bottom of the page, below the lower navigation bar. The \f2text\fP may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2text\fP may have to be escaped. -.TP 3 -\-link\ extdocURL -Creates links to existing javadoc\-generated documentation of external referenced classes. It takes one argument: -.RS 3 -.TP 2 -o -\f4extdocURL\fP is the absolute or relative URL of the directory containing the external javadoc\-generated documentation you want to link to. Examples are shown below. The package\-list file must be found in this directory (otherwise, use \f2\-linkoffline\fP). The Javadoc tool reads the package names from the \f2package\-list\fP file and then links to those packages at that URL. When the Javadoc tool is run, the \f2extdocURL\fP value is copied literally into the \f2<A HREF>\fP links that are created. Therefore, \f2extdocURL\fP must be the URL to the \f2directory\fP, not to a file. -.br -.br -You can use an absolute link for \f2extdocURL\fP to enable your docs to link to a document on any website, or can use a relative link to link only to a relative location. If relative, the value you pass in should be the relative path from the destination directory (specified with \f2\-d\fP) to the directory containing the packages being linked to. -.br -.br -When specifying an absolute link you normally use an \f2http:\fP link. However, if you want to link to a file system that has no web server, you can use a \f2file:\fP link \-\- however, do this only if everyone wanting to access the generated documentation shares the same file system. -.br -.br -In all cases, and on all operating systems, you should use a forward slash as the separator, whether the URL is absolute or relative, and "http:" or "file:" based (as specified in the -.na -\f2URL Memo\fP @ -.fi -http://www.ietf.org/rfc/rfc1738.txt). -.RS 3 -.TP 3 -Absolute http: based link: -\f2\-link http://<host>/<directory>/<directory>/.../<name>\fP -.TP 3 -Absolute file: based link: -\f2\-link file://<host>/<directory>/<directory>/.../<name>\fP -.TP 3 -Relative link: -\f2\-link <directory>/<directory>/.../<name>\fP -.RE -.RE -You can specify multiple \f2\-link\fP options in a given javadoc run to link to multiple documents. -.br -.br -\f3Choosing between \-linkoffline and \-link\fP: -.br -.br -Use \f2\-link\fP: -.RS 3 -.TP 2 -o -when using a relative path to the external API document, or -.TP 2 -o -when using an absolute URL to the external API document, if your shell allows a program to open a connection to that URL for reading. -.RE -Use \f2\-linkoffline\fP: -.RS 3 -.TP 2 -o -when using an absolute URL to the external API document, if your shell \f2does not allow\fP a program to open a connection to that URL for reading. This can occur if you are behind a firewall and the document you want to link to is on the other side. -.RE -.br -.br -\f3Example using absolute links to the external docs\fP \- Let us say you want to link to the \f2java.lang\fP, \f2java.io\fP and other Java Platform packages at -.na -\f2http://download.oracle.com/javase/7/docs/api/\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/. The following command generates documentation for the package \f2com.mypackage\fP with links to the Java SE Platform packages. The generated documentation will contain links to the \f2Object\fP class, for example, in the class trees. (Other options, such as \f2\-sourcepath\fP and \f2\-d\fP, are not shown.) -.nf -\f3 -.fl - % \fP\f3javadoc \-link http://download.oracle.com/javase/7/docs/api/ com.mypackage\fP -.fl -.fi -\f3Example using relative links to the external docs\fP \- Let us say you have two packages whose docs are generated in different runs of the Javadoc tool, and those docs are separated by a relative path. In this example, the packages are \f2com.apipackage\fP, an API, and \f2com.spipackage\fP, an SPI (Service Provide Interface). You want the documentation to reside in \f2docs/api/com/apipackage\fP and \f2docs/spi/com/spipackage\fP. Assuming the API package documentation is already generated, and that \f2docs\fP is the current directory, you would document the SPI package with links to the API documentation by running: -.nf -\f3 -.fl - % \fP\f3javadoc \-d ./spi \-link ../api com.spipackage\fP -.fl -.fi -Notice the \f2\-link\fP argument is relative to the destination directory (\f2docs/spi\fP). -.br -.br -\f3Details\fP \- The \f2\-link\fP option enables you to link to classes referenced to by your code but \f2not\fP documented in the current javadoc run. For these links to go to valid pages, you must know where those HTML pages are located, and specify that location with \f2extdocURL\fP. This allows, for instance, third party documentation to link to \f2java.*\fP documentation on \f2http://java.sun.com\fP. -.br -.br -Omit the \f2\-link\fP option for javadoc to create links only to API within the documentation it is generating in the current run. (Without the \f2\-link\fP option, the Javadoc tool does not create links to documentation for external references, because it does not know if or where that documentation exists.) -.br -.br -This option can create links in several places in the generated documentation. -.br -.br -Another use is for cross\-links between sets of packages: Execute javadoc on one set of packages, then run javadoc again on another set of packages, creating links both ways between both sets. -.br -.br -\f3How a Class Must be Referenced\fP \- For a link to an external referenced class to actually appear (and not just its text label), the class must be referenced in the following way. It is not sufficient for it to be referenced in the body of a method. It must be referenced in either an \f2import\fP statement or in a declaration. Here are examples of how the class \f2java.io.File\fP can be referenced: -.RS 3 -.TP 2 -o -In any kind of \f2import\fP statement: by wildcard import, import explicitly by name, or automatically import for \f2java.lang.*\fP. For example, this would suffice: -.br -\f2import java.io.*;\fP -.br -In 1.3.x and 1.2.x, only an explicit import by name works \-\- a wildcard import statement does not work, nor does the automatic import \f2java.lang.*\fP. -.TP 2 -o -In a declaration: -.br -\f2void foo(File f) {}\fP -.br -The reference and be in the return type or parameter type of a method, constructor, field, class or interface, or in an \f2implements\fP, \f2extends\fP or \f2throws\fP statement. -.RE -An important corollary is that when you use the \f2\-link\fP option, there may be many links that unintentionally do not appear due to this constraint. (The text would appear without a hypertext link.) You can detect these by the warnings they emit. The most innocuous way to properly reference a class and thereby add the link would be to import that class, as shown above. -.br -.br -\f3Package List\fP \- The \f2\-link\fP option requires that a file named \f2package\-list\fP, which is generated by the Javadoc tool, exist at the URL you specify with \f2\-link\fP. The \f2package\-list\fP file is a simple text file that lists the names of packages documented at that location. In the earlier example, the Javadoc tool looks for a file named \f2package\-list\fP at the given URL, reads in the package names and then links to those packages at that URL. -.br -.br -For example, the package list for the Java SE 6 API is located at -.na -\f2http://download.oracle.com/javase/7/docs/api/package\-list\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/package\-list. and starts as follows: -.nf -\f3 -.fl - java.applet -.fl - java.awt -.fl - java.awt.color -.fl - java.awt.datatransfer -.fl - java.awt.dnd -.fl - java.awt.event -.fl - java.awt.font -.fl - etc. -.fl -\fP -.fi -When javadoc is run without the \f2\-link\fP option, when it encounters a name that belongs to an external referenced class, it prints the name with no link. However, when the \f2\-link\fP option is used, the Javadoc tool searches the \f2package\-list\fP file at the specified \f2extdocURL\fP location for that package name. If it finds the package name, it prefixes the name with \f2extdocURL\fP. -.br -.br -In order for there to be no broken links, all of the documentation for the external references must exist at the specified URLs. The Javadoc tool will not check that these pages exist \-\- only that the package\-list exists. -.br -.br -\f3Multiple Links\fP \- You can supply multiple \f2\-link\fP options to link to any number of external generated documents. \ Javadoc 1.2 has a known bug which prevents you from supplying more than one \f2\-link\fP command. This was fixed in 1.2.2. -.br -.br -Specify a different link option for each external document to link to: -.br -.br -\ \ \f2% \fP\f4javadoc \-link\fP \f2extdocURL1\fP \f4\-link\fP \f2extdocURL2\fP \f2... \fP\f4\-link\fP \f2extdocURLn\fP \f4com.mypackage\fP -.br -.br -where \f2extdocURL1\fP,\ \f2extdocURL2\fP,\ ... \f2extdocURLn\fP point respectively to the roots of external documents, each of which contains a file named \f2package\-list\fP. -.br -.br -\f3Cross\-links\fP \- Note that "bootstrapping" may be required when cross\-linking two or more documents that have not previously been generated. In other words, if \f2package\-list\fP does not exist for either document, when you run the Javadoc tool on the first document, the \f2package\-list\fP will not yet exist for the second document. Therefore, to create the external links, you must re\-generate the first document after generating the second document. -.br -.br -In this case, the purpose of first generating a document is to create its \f2package\-list\fP (or you can create it by hand it if you're certain of the package names). Then generate the second document with its external links. The Javadoc tool prints a warning if a needed external \f2package\-list\fP file does not exist. -.TP 3 -\-linkoffline\ extdocURL\ packagelistLoc -This option is a variation of \f2\-link\fP; they both create links to javadoc\-generated documentation for external referenced classes. Use the \f2\-linkoffline\fP option when linking to a document on the web when the Javadoc tool itself is "offline" \-\- that is, it cannot access the document through a web connection. -.br -.br -More specifically, use \f2\-linkoffline\fP if the external document's \f2package\-list\fP file is not accessible or does not exist at the \f2extdocURL\fP location but does exist at a different location, which can be specified by \f2packageListLoc\fP (typically local). Thus, if \f2extdocURL\fP is accessible only on the World Wide Web, \f2\-linkoffline\fP removes the constraint that the Javadoc tool have a web connection when generating the documentation. -.br -.br -Another use is as a "hack" to update docs: After you have run javadoc on a full set of packages, then you can run javadoc again on onlya smaller set of changed packages, so that the updated files can be inserted back into the original set. Examples are given below. -.br -.br -The \f2\-linkoffline\fP option takes two arguments \-\- the first for the string to be embedded in the \f2<a href>\fP links, the second telling it where to find \f2package\-list\fP: -.RS 3 -.TP 2 -o -\f4extdocURL\fP is the absolute or relative URL of the directory containing the external javadoc\-generated documentation you want to link to. If relative, the value should be the relative path from the destination directory (specified with \f2\-d\fP) to the root of the packages being linked to. For more details, see \f2extdocURL\fP in the \f2\-link\fP option. -.TP 2 -o -\f4packagelistLoc\fP is the path or URL to the directory containing the \f2package\-list\fP file for the external documentation. This can be a URL (http: or file:) or file path, and can be absolute or relative. If relative, make it relative to the \f2current\fP directory from where javadoc was run. Do not include the \f2package\-list\fP filename. -.RE -You can specify multiple \f2\-linkoffline\fP options in a given javadoc run. (Prior to 1.2.2, it could be specified only once.) -.br -.br -\f3Example using absolute links to the external docs\fP \- Let us say you want to link to the \f2java.lang\fP, \f2java.io\fP and other Java SE Platform packages at \f2http://download.oracle.com/javase/7/docs/api/\fP, but your shell does not have web access. You could open the \f2package\-list\fP file in a browser at -.na -\f2http://download.oracle.com/javase/7/docs/api/package\-list\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/package\-list, save it to a local directory, and point to this local copy with the second argument, \f2packagelistLoc\fP. In this example, the package list file has been saved to the current directory "\f2.\fP" . The following command generates documentation for the package \f2com.mypackage\fP with links to the Java SE Platform packages. The generated documentation will contain links to the \f2Object\fP class, for example, in the class trees. (Other necessary options, such as \f2\-sourcepath\fP, are not shown.) -.nf -\f3 -.fl -% \fP\f3javadoc \-linkoffline http://download.oracle.com/javase/7/docs/api/ . com.mypackage\fP -.fl -.fi -\f3Example using relative links to the external docs\fP \- It's not very common to use \f2\-linkoffline\fP with relative paths, for the simple reason that \f2\-link\fP usually suffices. When using \f2\-linkoffline\fP, the \f2package\-list\fP file is generally local, and when using relative links, the file you are linking to is also generally local. So it is usually unnecessary to give a different path for the two arguments to \f2\-linkoffline\fP. When the two arguments are identical, you can use \f2\-link\fP. See the \f2\-link\fP relative example. -.br -.br -\f3Manually Creating a \fP\f4package\-list\fP\f3 File\fP \- If a \f2package\-list\fP file does not yet exist, but you know what package names your document will link to, you can create your own copy of this file by hand and specify its path with \f2packagelistLoc\fP. An example would be the previous case where the package list for \f2com.spipackage\fP did not exist when \f2com.apipackage\fP was first generated. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published. This is also a way of creating \f2package\-list\fP files for packages generated with Javadoc 1.0 or 1.1, where \f2package\-list\fP files were not generated. Likewise, two companies can share their unpublished \f2package\-list\fP files, enabling them to release their cross\-linked documentation simultaneously. -.br -.br -\f3Linking to Multiple Documents\fP \- You can include \f2\-linkoffline\fP once for each generated document you want to refer to (each option is shown on a separate line for clarity): -.br -.br -\f2% \fP\f4javadoc \-linkoffline\fP \f2extdocURL1\fP \f2packagelistLoc1\fP \f2\\\fP -.br -\f2\ \ \ \ \ \ \ \ \ \ \fP\f4\-linkoffline\fP \f2extdocURL2\fP \f2packagelistLoc2\fP \f2\\\fP -.br -\f2\ \ \ \ \ \ \ \ \ \ ...\fP -.br -.br -\f3Updating docs\fP \- Another use for \f2\-linkoffline\fP option is useful if your project has dozens or hundreds of packages, if you have already run javadoc on the entire tree, and now, in a separate run, you want to quickly make some small changes and re\-run javadoc on just a small portion of the source tree. This is somewhat of a hack in that it works properly only if your changes are only to doc comments and not to declarations. If you were to add, remove or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, use page, and other places. -.br -.br -First, you create a new destination directory (call it \f2update\fP) for this new small run. Let us say the original destination directory was named \f2html\fP. In the simplest example, cd to the parent of \f2html\fP. Set the first argument of \f2\-linkoffline\fP to the current directory "." and set the second argument to the relative path to \f2html\fP, where it can find \f2package\-list\fP, and pass in only the package names of the packages you want to update: -.nf -\f3 -.fl - % \fP\f3javadoc \-d update \-linkoffline . html com.mypackage\fP -.fl -.fi -When the Javadoc tool is done, copy these generated class pages in \f2update/com/package\fP (not the overview or index), over the original files in \f2html/com/package\fP. -.TP 3 -\-linksource\ -Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation. Links are created for classes, interfaces, constructors, methods and fields whose declarations are in a source file. Otherwise, links are not created, such as for default constructors and generated classes. -.br -.br -\f3This option exposes \fP\f4all\fP\f3 private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, \fP\f4regardless of the \fP\f4\-public\fP\f3, \fP\f4\-package\fP\f3, \fP\f4\-protected\fP\f3 and \fP\f4\-private\fP\f3 options.\fP Unless you also use the \f2\-private\fP option, not all private classes or interfaces will necessarily be accessible via links. -.br -.br -Each link appears on the name of the identifier in its declaration. For example, the link to the source code of the \f2Button\fP class would be on the word "Button": -.nf -\f3 -.fl - public class Button -.fl - extends Component -.fl - implements Accessible -.fl -\fP -.fi -and the link to the source code of the \f2getLabel()\fP method in the Button class would be on the word "getLabel": -.nf -\f3 -.fl - public String getLabel() -.fl -\fP -.fi -.TP 3 -\-group\ groupheading\ packagepattern:packagepattern:... -Separates packages on the overview page into whatever groups you specify, one group per table. You specify each group with a different \f2\-group\fP option. The groups appear on the page in the order specified on the command line; packages are alphabetized within a group. For a given \f2\-group\fP option, the packages matching the list of \f2packagepattern\fP expressions appear in a table with the heading \f2groupheading\fP. -.RS 3 -.TP 2 -o -\f4groupheading\fP can be any text, and can include white space. This text is placed in the table heading for the group. -.TP 2 -o -\f4packagepattern\fP can be any package name, or can be the start of any package name followed by an asterisk (\f2*\fP). The asterisk is a wildcard meaning "match any characters". This is the only wildcard allowed. Multiple patterns can be included in a group by separating them with colons (\f2:\fP). -.RE -\f3NOTE: If using an asterisk in a pattern or pattern list, the pattern list must be inside quotes, such as \fP\f4"java.lang*:java.util"\fP -.br -.br -If you do not supply any \f2\-group\fP option, all packages are placed in one group with the heading "Packages". If the all groups do not include all documented packages, any leftover packages appear in a separate group with the heading "Other Packages". -.br -.br -For example, the following option separates the four documented packages into core, extension and other packages. Notice the trailing "dot" does not appear in "java.lang*" \-\- including the dot, such as "java.lang.*" would omit the java.lang package. -.nf -\f3 -.fl - % \fP\f3javadoc \-group "Core Packages" "java.lang*:java.util" -.fl - \-group "Extension Packages" "javax.*" -.fl - java.lang java.lang.reflect java.util javax.servlet java.new\fP -.fl -.fi -This results in the groupings: -.RS 3 -.TP 3 -Core Packages -\f2java.lang\fP -\f2java.lang.reflect\fP -\f2java.util\fP -.TP 3 -Extension Packages -\f2javax.servlet\fP -.TP 3 -Other Packages -\f2java.new\fP -.RE -.TP 3 -\-nodeprecated -Prevents the generation of any deprecated API at all in the documentation. This does what \-nodeprecatedlist does, plus it does not generate any deprecated API throughout the rest of the documentation. This is useful when writing code and you don't want to be distracted by the deprecated code. -.TP 3 -\-nodeprecatedlist -Prevents the generation of the file containing the list of deprecated APIs (deprecated\-list.html) and the link in the navigation bar to that page. (However, javadoc continues to generate the deprecated API throughout the rest of the document.) This is useful if your source code contains no deprecated API, and you want to make the navigation bar cleaner. -.TP 3 -\-nosince -Omits from the generated docs the "Since" sections associated with the @since tags. -.TP 3 -\-notree -Omits the class/interface hierarchy pages from the generated docs. These are the pages you reach using the "Tree" button in the navigation bar. The hierarchy is produced by default. -.TP 3 -\-noindex -Omits the index from the generated docs. The index is produced by default. -.TP 3 -\-nohelp -Omits the HELP link in the navigation bars at the top and bottom of each page of output. -.TP 3 -\-nonavbar -Prevents the generation of the navigation bar, header and footer, otherwise found at the top and bottom of the generated pages. Has no affect on the "bottom" option. The \f2\-nonavbar\fP option is useful when you are interested only in the content and have no need for navigation, such as converting the files to PostScript or PDF for print only. -.TP 3 -\-helpfile\ path/filename -Specifies the path of an alternate help file \f2path/filename\fP that the HELP link in the top and bottom navigation bars link to. Without this option, the Javadoc tool automatically creates a help file \f2help\-doc.html\fP that is hard\-coded in the Javadoc tool. This option enables you to override this default. The \f2filename\fP can be any name and is not restricted to \f2help\-doc.html\fP \-\- the Javadoc tool will adjust the links in the navigation bar accordingly. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-helpfile /home/user/myhelp.html java.awt\fP -.fl -.fi -.TP 3 -\-stylesheetfile\ path/filename -Specifies the path of an alternate HTML stylesheet file. Without this option, the Javadoc tool automatically creates a stylesheet file \f2stylesheet.css\fP that is hard\-coded in the Javadoc tool. This option enables you to override this default. The \f2filename\fP can be any name and is not restricted to \f2stylesheet.css\fP. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-stylesheetfile /home/user/mystylesheet.css com.mypackage\fP -.fl -.fi -.TP 3 -\-serialwarn -Generates compile\-time warnings for missing @serial tags. By default, Javadoc 1.2.2 (and later versions) generates no serial warnings. (This is a reversal from earlier versions.) Use this option to display the serial warnings, which helps to properly document default serializable fields and \f2writeExternal\fP methods. -.TP 3 -\-charset\ name -Specifies the HTML character set for this document. The name should be a preferred MIME name as given in the -.na -\f2IANA Registry\fP @ -.fi -http://www.iana.org/assignments/character\-sets. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-charset "iso\-8859\-1" mypackage\fP -.fl -.fi -would insert the following line in the head of every generated page: -.nf -\f3 -.fl - <META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1"> -.fl -\fP -.fi -This META tag is described in the -.na -\f2HTML standard\fP @ -.fi -http://www.w3.org/TR/REC\-html40/charset.html#h\-5.2.2. (4197265 and 4137321) -.br -.br -Also see \-encoding and \-docencoding. -.TP 3 -\-docencoding\ name -Specifies the encoding of the generated HTML files. The name should be a preferred MIME name as given in the -.na -\f2IANA Registry\fP @ -.fi -http://www.iana.org/assignments/character\-sets. If you omit this option but use \-encoding, then the encoding of the generated HTML files is determined by \-encoding. Example: -.nf -\f3 -.fl - % \fP\f3javadoc \-docencoding "ISO\-8859\-1" mypackage\fP -.fl -.fi -Also see \-encoding and \-charset. -.TP 3 -\-keywords -Adds HTML meta keyword tags to the generated file for each class. These tags can help the page be found by search engines that look for meta tags. (Most search engines that search the entire Internet do not look at meta tags, because pages can misuse them; but search engines offered by companies that confine their search to their own website can benefit by looking at meta tags.) -.br -.br -The meta tags include the fully qualified name of the class and the unqualified names of the fields and methods. Constructors are not included because they are identical to the class name. For example, the class String starts with these keywords: -.nf -\f3 -.fl - <META NAME="keywords" CONTENT="java.lang.String class"> -.fl - <META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER"> -.fl - <META NAME="keywords" CONTENT="length()"> -.fl - <META NAME="keywords" CONTENT="charAt()"> -.fl -\fP -.fi -.TP 3 -\-tag\ \ tagname:Xaoptcmf:"taghead" -Enables the Javadoc tool to interpret a simple, one\-argument custom block tag \f2@\fP\f2tagname\fP in doc comments. So the Javadoc tool can "spell\-check" tag names, it is important to include a \f2\-tag\fP option for every custom tag that is present in the source code, disabling (with \f2X\fP) those that are not being output in the current run. -.br -.br -The colon (\f4:\fP) is always the separator. To use a colon in \f2tagname\fP, see Use of Colon in Tag Name. -.br -.br -The \f2\-tag\fP option outputs the tag's heading \f2taghead\fP in bold, followed on the next line by the text from its single argument, as shown in the example below. Like any block tag, this argument's text can contain inline tags, which are also interpreted. The output is similar to standard one\-argument tags, such as \f2@return\fP and \f2@author\fP. Omitting \f2taghead\fP causes \f2tagname\fP to appear as the heading. -.br -.br -\f3Placement of tags\fP \- The \f4Xaoptcmf\fP part of the argument determines where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f2X\fP). You can supply either \f4a\fP, to allow the tag in all places, or any combination of the other letters: -.br -.br -\f4X\fP (disable tag) -.br -\f4a\fP (all) -.br -\f4o\fP (overview) -.br -\f4p\fP (packages) -.br -\f4t\fP (types, that is classes and interfaces) -.br -\f4c\fP (constructors) -.br -\f4m\fP (methods) -.br -\f4f\fP (fields) -.br -.br -\f3Examples of single tags\fP \- An example of a tag option for a tag that can be used anywhere in the source code is: -.nf -\f3 -.fl - \-tag todo:a:"To Do:" -.fl -\fP -.fi -If you wanted @todo to be used only with constructors, methods and fields, you would use: -.nf -\f3 -.fl - \-tag todo:cmf:"To Do:" -.fl -\fP -.fi -Notice the last colon (\f2:\fP) above is not a parameter separator, but is part of the heading text (as shown below). You would use either tag option for source code that contains the tag \f2@todo\fP, such as: -.nf -\f3 -.fl - @todo The documentation for this method needs work. -.fl -\fP -.fi -\f3Use of Colon in Tag Name\fP \- A colon can be used in a tag name if it is escaped with a backslash. For this doc comment: -.nf -\f3 -.fl - /** -.fl - * @ejb:bean -.fl - */ -.fl -\fP -.fi -use this tag option: -.nf -\f3 -.fl - \-tag ejb\\\\:bean:a:"EJB Bean:" -.fl -\fP -.fi -\f3Spell\-checking tag names (Disabling tags)\fP \- Some developers put custom tags in the source code that they don't always want to output. In these cases, it is important to list all tags that are present in the source code, enabling the ones you want to output and disabling the ones you don't want to output. The presence of \f2X\fP disables the tag, while its absence enables the tag. This gives the Javadoc tool enough information to know if a tag it encounters is unknown, probably the results of a typo or a misspelling. It prints a warning in these cases. -.br -.br -You can add \f2X\fP to the placement values already present, so that when you want to enable the tag, you can simply delete the \f2X\fP. For example, if @todo is a tag that you want to suppress on output, you would use: -.nf -\f3 -.fl - \-tag todo:Xcmf:"To Do:" -.fl -\fP -.fi -or, if you'd rather keep it simple: -.nf -\f3 -.fl - \-tag todo:X -.fl -\fP -.fi -The syntax \f2\-tag todo:X\fP works even if \f2@todo\fP is defined by a taglet. -.br -.br -\f3Order of tags\fP \- The order of the \f2\-tag\fP (and \f2\-taglet\fP) options determine the order the tags are output. You can mix the custom tags with the standard tags to intersperse them. The tag options for standard tags are placeholders only for determining the order \-\- they take only the standard tag's name. (Subheadings for standard tags cannot be altered.) This is illustrated in the following example. -.br -.br -If \f2\-tag\fP is missing, then the position of \f2\-taglet\fP determines its order. If they are both present, then whichever appears last on the command line determines its order. (This happens because the tags and taglets are processed in the order that they appear on the command line. For example, if \f2\-taglet\fP and \f2\-tag\fP both have the name "todo", the one that appears last on the command line will determine its order. -.br -.br -\f3Example of a complete set of tags\fP \- This example inserts "To Do" after "Parameters" and before "Throws" in the output. By using "X", it also specifies that @example is a tag that might be encountered in the source code that should not be output during this run. Notice that if you use @argfile, you can put the tags on separate lines in an argument file like this (no line continuation characters needed): -.nf -\f3 -.fl - \-tag param -.fl - \-tag return -.fl - \-tag todo:a:"To Do:" -.fl - \-tag throws -.fl - \-tag see -.fl - \-tag example:X -.fl -\fP -.fi -When javadoc parses the doc comments, any tag encountered that is neither a standard tag nor passed in with \f2\-tag\fP or \f2\-taglet\fP is considered unknown, and a warning is thrown. -.br -.br -The standard tags are initially stored internally in a list in their default order. Whenever \f2\-tag\fP options are used, those tags get appended to this list \-\- standard tags are moved from their default position. Therefore, if a \f2\-tag\fP option is omitted for a standard tag, it remains in its default position. -.br -.br -\f3Avoiding Conflicts\fP \- If you want to slice out your own namespace, you can use a dot\-separated naming convention similar to that used for packages: \f2com.mycompany.todo\fP. Oracle will continue to create standard tags whose names do not contain dots. Any tag you create will override the behavior of a tag by the same name defined by Oracle. In other words, if you create a tag or taglet \f2@todo\fP, it will always have the same behavior you define, even if Oracle later creates a standard tag of the same name. -.br -.br -\f3Annotations vs. Javadoc Tags\fP \- In general, if the markup you want to add is intended to affect or produce documentation, it should probably be a javadoc tag; otherwise, it should be an annotation. See -.na -\f2Comparing Annotations and Javadoc Tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#annotations< -.br -.br -You can also create more complex block tags, or custom inline tags with the \-taglet option. -.TP 3 -\-taglet\ \ class -Specifies the class file that starts the taglet used in generating the documentation for that tag. Use the fully\-qualified name for \f2class\fP. This taglet also defines the number of text arguments that the custom tag has. The taglet accepts those arguments, processes them, and generates the output. For extensive documentation with example taglets, see: -.RS 3 -.TP 2 -o -.na -\f2Taglet Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html -.RE -Taglets are useful for block or inline tags. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes. -.br -.br -Taglets can only determine where a tag should appear and in what form. All other decisions are made by the doclet. So a taglet cannot do things such as remove a class name from the list of included classes. However, it can execute side effects, such as printing the tag's text to a file or triggering another process. -.br -.br -Use the \f2\-tagletpath\fP option to specify the path to the taglet. Here is an example that inserts the "To Do" taglet after "Parameters" and ahead of "Throws" in the generated pages: -.nf -\f3 -.fl - \-taglet com.sun.tools.doclets.ToDoTaglet -.fl - \-tagletpath /home/taglets -.fl - \-tag return -.fl - \-tag param -.fl - \-tag todo -.fl - \-tag throws -.fl - \-tag see -.fl -\fP -.fi -Alternatively, you can use the \f2\-taglet\fP option in place of its \f2\-tag\fP option, but that may be harder to read. -.TP 3 -\-tagletpath\ \ tagletpathlist -Specifies the search paths for finding taglet class files (.class). The \f2tagletpathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. -.TP 3 -\-docfilessubdirs\ -Enables deep copying of "\f2doc\-files\fP" directories. In other words, subdirectories and all contents are recursively copied to the destination. For example, the directory \f2doc\-files/example/images\fP and all its contents would now be copied. There is also an option to exclude subdirectories. -.TP 3 -\-excludedocfilessubdir\ \ name1:name2... -Excludes any "\f2doc\-files\fP" subdirectories with the given names. This prevents the copying of SCCS and other source\-code\-control subdirectories. -.TP 3 -\-noqualifier\ \ all\ | \ packagename1:packagename2:... -Omits qualifying package name from ahead of class names in output. The argument to \f2\-noqualifier\fP is either "\f2all\fP" (all package qualifiers are omitted) or a colon\-separate list of packages, with wildcards, to be removed as qualifiers. The package name is removed from places where class or interface names appear. -.br -.br -The following example omits all package qualifiers: -.nf -\f3 -.fl - \-noqualifier all -.fl -\fP -.fi -The following example omits "java.lang" and "java.io" package qualifiers: -.nf -\f3 -.fl - \-noqualifier java.lang:java.io -.fl -\fP -.fi -The following example omits package qualifiers starting with "java", and "com.sun" subpackages (but not "javax"): -.nf -\f3 -.fl - \-noqualifier java.*:com.sun.* -.fl -\fP -.fi -Where a package qualifier would appear due to the above behavior, the name can be suitably shortened \-\- see How a name is displayed. This rule is in effect whether or not \f2\-noqualifier\fP is used. -.TP 3 -\-notimestamp\ -Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page. Useful when you want to run javadoc on two source bases and diff them, as it prevents timestamps from causing a diff (which would otherwise be a diff on every page). The timestamp includes the javadoc version number, and currently looks like this: -.nf -\f3 -.fl - <!\-\- Generated by javadoc (build 1.5.0_01) on Thu Apr 02 14:04:52 IST 2009 \-\-> -.fl -\fP -.fi -.TP 3 -\-nocomment\ -Suppress the entire comment body, including the main description and all tags, generating only declarations. This option enables re\-using source files originally intended for a different purpose, to produce skeleton HTML documentation at the early stages of a new project. -.TP 3 -\-sourcetab tabLength -Specify the number of spaces each tab takes up in the source. -.RE -.SH "COMMAND LINE ARGUMENT FILES" -.LP -To shorten or simplify the javadoc command line, you can specify one or more files that themselves contain arguments to the \f2javadoc\fP command (except \f2\-J\fP options). This enables you to create javadoc commands of any length on any operating system. -.LP -An argument file can include javac options and source filenames in any combination. The arguments within a file can be space\-separated or newline\-separated. If a filename contains embedded spaces, put the whole filename in double quotes. -.LP -Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying \f2*.java\fP). Use of the '\f2@\fP' character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -When executing javadoc, pass in the path and name of each argument file with the '\f2@\fP' leading character. When javadoc encounters an argument beginning with the character `\f2@\fP', it expands the contents of that file into the argument list. -.SS -Example \- Single Arg File -.LP -You could use a single argument file named "\f2argfile\fP" to hold all Javadoc arguments: -.nf -\f3 -.fl - % \fP\f3javadoc @argfile\fP -.fl -.fi -.LP -This argument file could contain the contents of both files shown in the next example. -.SS -Example \- Two Arg Files -.LP -You can create two argument files \-\- one for the Javadoc options and the other for the package names or source filenames: (Notice the following lists have no line\-continuation characters.) -.LP -Create a file named "\f2options\fP" containing: -.nf -\f3 -.fl - \-d docs\-filelist -.fl - \-use -.fl - \-splitindex -.fl - \-windowtitle 'Java SE 7 API Specification' -.fl - \-doctitle 'Java SE 7 API Specification' -.fl - \-header '<b>Java(TM) SE 7</b>' -.fl - \-bottom 'Copyright © 1993\-2011 Oracle and/or its affiliates. All rights reserved.' -.fl - \-group "Core Packages" "java.*" -.fl - \-overview /java/pubs/ws/1.7.0/src/share/classes/overview\-core.html -.fl - \-sourcepath /java/pubs/ws/1.7.0/src/share/classes -.fl -\fP -.fi -.LP -Create a file named "\f2packages\fP" containing: -.nf -\f3 -.fl - com.mypackage1 -.fl - com.mypackage2 -.fl - com.mypackage3 -.fl -\fP -.fi -.LP -You would then run javadoc with: -.nf -\f3 -.fl - % \fP\f3javadoc @options @packages\fP -.fl -.fi -.SS -Example \- Arg Files with Paths -.LP -The argument files can have paths, but any filenames inside the files are relative to the current working directory (not \f2path1\fP or \f2path2\fP): -.nf -\f3 -.fl - % \fP\f3javadoc @path1/options @path2/packages\fP -.fl -.fi -.SS -Example \- Option Arguments -.LP -Here's an example of saving just an argument to a javadoc option in an argument file. We'll use the \f2\-bottom\fP option, since it can have a lengthy argument. You could create a file named "\f2bottom\fP" containing its text argument: -.nf -\f3 -.fl -<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font> -.fl -\fP -.fi -.LP -Then run the Javadoc tool with: -.nf -\f3 -.fl - % \fP\f3javadoc \-bottom @bottom @packages\fP -.fl -.fi -.LP -Or you could include the \f2\-bottom\fP option at the start of the argument file, and then just run it as: -.nf -\f3 -.fl - % \fP\f3javadoc @bottom @packages\fP -.fl -.fi -.SH "Name" -Running -.SH "RUNNING JAVADOC" -.LP -\f3Version Numbers\fP \- The version number of javadoc can be determined using \f3javadoc \-J\-version\fP. The version number of the standard doclet appears in its output stream. It can be turned off with \f2\-quiet\fP. -.LP -\f3Public programmatic interface\fP \- To invoke the Javadoc tool from within programs written in the Java language. This interface is in \f2com.sun.tools.javadoc.Main\fP (and javadoc is re\-entrant). For more details, see -.na -\f2Standard Doclet\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/standard\-doclet.html#runningprogrammatically. -.LP -\f3Running Doclets\fP \- The instructions given below are for invoking the standard HTML doclet. To invoke a custom doclet, use the \-doclet and \-docletpath options. For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.SH "SIMPLE EXAMPLES" -.LP -You can run javadoc on entire packages or individual source files. Each package name has a corresponding directory name. In the following examples, the source files are located at \f2/home/src/java/awt/*.java\fP. The destination directory is \f2/home/html\fP. -.SS -Documenting One or More Packages -.LP -To document a package, the source files (\f2*.java\fP) for that package must be located in a directory having the same name as the package. If a package name is made up of several identifiers (separated by dots, such as \f2java.awt.color\fP), each subsequent identifier must correspond to a deeper subdirectory (such as \f2java/awt/color\fP). You may split the source files for a single package among two such directory trees located at different places, as long as \f2\-sourcepath\fP points to them both \-\- for example \f2src1/java/awt/color\fP and \f2src2/java/awt/color\fP. -.LP -You can run javadoc either by changing directories (with \f2cd\fP) or by using \f2\-sourcepath\fP option. The examples below illustrate both alternatives. -.RS 3 -.TP 2 -o -\f3Case 1 \- Run recursively starting from one or more packages\fP \- This example uses \-sourcepath so javadoc can be run from any directory and \-subpackages (a new 1.4 option) for recursion. It traverses the subpackages of the \f2java\fP directory excluding packages rooted at \f2java.net\fP and \f2java.lang\fP. Notice this excludes \f2java.lang.ref\fP, a subpackage of \f2java.lang\fP). -.nf -\f3 -.fl - % \fP\f3javadoc \fP\f3\-d\fP\f3 /home/html \fP\f3\-sourcepath\fP\f3 /home/src \fP\f3\-subpackages\fP\f3 java \fP\f3\-exclude\fP\f3 java.net:java.lang\fP -.fl -.fi -.LP -To also traverse down other package trees, append their names to the \f2\-subpackages\fP argument, such as \f2java:javax:org.xml.sax\fP. -.TP 2 -o -\f3Case 2 \- Run on explicit packages after changing to the "root" source directory\fP \- Change to the parent directory of the fully\-qualified package. Then run javadoc, supplying names of one or more packages you want to document: -.nf -\f3 -.fl - % \fP\f3cd /home/src/\fP -.fl - % \f3javadoc \-d /home/html java.awt java.awt.event\fP -.fl -.fi -.TP 2 -o -\f3Case 3 \- Run from any directory on explicit packages in a single directory tree\fP \- In this case, it doesn't matter what the current directory is. Run javadoc supplying \f2\-sourcepath\fP with the parent directory of the top\-level package, and supplying names of one or more packages you want to document: -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt java.awt.event\fP -.fl -.fi -.TP 2 -o -\f3Case 4 \- Run from any directory on explicit packages in multiple directory trees\fP \- This is the same as case 3, but for packages in separate directory trees. Run javadoc supplying \f2\-sourcepath\fP with the path to each tree's root (colon\-separated) and supply names of one or more packages you want to document. All source files for a given package do not need to be located under a single root directory \-\- they just need to be found somewhere along the sourcepath. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event\fP -.fl -.fi -.RE -.LP -Result: All cases generate HTML\-formatted documentation for the public and protected classes and interfaces in packages \f2java.awt\fP and \f2java.awt.event\fP and save the HTML files in the specified destination directory (\f2/home/html\fP). Because two or more packages are being generated, the document has three HTML frames \-\- for the list of packages, the list of classes, and the main class pages. -.SS -Documenting One or More Classes -.LP -The second way to run the Javadoc tool is by passing in one or more source files (\f2.java\fP). You can run javadoc either of the following two ways \-\- by changing directories (with \f2cd\fP) or by fully\-specifying the path to the \f2.java\fP files. Relative paths are relative to the current directory. The \f2\-sourcepath\fP option is ignored when passing in source files. You can use command line wildcards, such as asterisk (*), to specify groups of classes. -.RS 3 -.TP 2 -o -\f3Case 1 \- Changing to the source directory\fP \- Change to the directory holding the \f2.java\fP files. Then run javadoc, supplying names of one or more source files you want to document. -.nf -\f3 -.fl - % \fP\f3cd /home/src/java/awt\fP -.fl - % \f3javadoc \-d /home/html Button.java Canvas.java Graphics*.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the classes \f2Button\fP, \f2Canvas\fP and classes beginning with \f2Graphics\fP. Because source files rather than package names were passed in as arguments to javadoc, the document has two frames \-\- for the list of classes and the main page. -.TP 2 -o -\f3Case 2 \- Changing to the package root directory\fP \- This is useful for documenting individual source files from different subpackages off the same root. Change to the package root directory, and supply the source files with paths from the root. -.nf -\f3 -.fl - % \fP\f3cd /home/src/\fP -.fl - % \f3javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the classes \f2Button\fP and \f2Applet\fP. -.TP 2 -o -\f3Case 3 \- From any directory\fP \- In this case, it doesn't matter what the current directory is. Run javadoc supplying the absolute path (or path relative to the current directory) to the \f2.java\fP files you want to document. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the class \f2Button\fP and classes beginning with \f2Graphics\fP. -.RE -.SS -Documenting Both Packages and Classes -.LP -You can document entire packages and individual classes at the same time. Here's an example that mixes two of the previous examples. You can use \f2\-sourcepath\fP for the path to the packages but not for the path to the individual classes. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java\fP -.fl -.fi -.LP -This example generates HTML\-formatted documentation for the package \f2java.awt\fP and class \f2Applet\fP. (The Javadoc tool determines the package name for \f2Applet\fP from the package declaration, if any, in the \f2Applet.java\fP source file.) -.SH "REAL WORLD EXAMPLE" -.LP -The Javadoc tool has many useful options, some of which are more commonly used than others. Here is effectively the command we use to run the Javadoc tool on the Java platform API. We use 180MB of memory to generate the documentation for the 1500 (approx.) public and protected classes in the Java SE Platform, Standard Edition, v1.2. -.LP -The same example is shown twice \-\- first as executed on the command line, then as executed from a makefile. It uses absolute paths in the option arguments, which enables the same \f2javadoc\fP command to be run from any directory. -.SS -Command Line Example -.LP -The following example may be too long for some shells such as DOS. You can use a command line argument file (or write a shell script) to workaround this limitation. -.nf -\f3 -.fl -% javadoc \-sourcepath /java/jdk/src/share/classes \\ -.fl - \-overview /java/jdk/src/share/classes/overview.html \\ -.fl - \-d /java/jdk/build/api \\ -.fl - \-use \\ -.fl - \-splitIndex \\ -.fl - \-windowtitle 'Java Platform, Standard Edition 7 API Specification' \\ -.fl - \-doctitle 'Java Platform, Standard Edition 7 API Specification' \\ -.fl - \-header '<b>Java(TM) SE 7</b>' \\ -.fl - \-bottom '<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font>' \\ -.fl - \-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \\ -.fl - \-group "Extension Packages" "javax.*" \\ -.fl - \-J\-Xmx180m \\ -.fl - @packages -.fl -\fP -.fi -.LP -where \f2packages\fP is the name of a file containing the packages to process, such as \f2java.applet java.lang\fP. None of the options should contain any newline characters between the single quotes. (For example, if you copy and paste this example, delete the newline characters from the \f2\-bottom\fP option.) See the other notes listed below. -.SS -Makefile Example -.LP -This is an example of a GNU makefile. For an example of a Windows makefile, see -.na -\f2creating a makefile for Windows\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html#makefiles. -.nf -\f3 -.fl -javadoc \-\fP\f3sourcepath\fP\f3 $(SRCDIR) \\ /* Sets path for source files */ -.fl - \-\fP\f3overview\fP\f3 $(SRCDIR)/overview.html \\ /* Sets file for overview text */ -.fl - \-\fP\f3d\fP\f3 /java/jdk/build/api \\ /* Sets destination directory */ -.fl - \-\fP\f3use\fP\f3 \\ /* Adds "Use" files */ -.fl - \-\fP\f3splitIndex\fP\f3 \\ /* Splits index A\-Z */ -.fl - \-\fP\f3windowtitle\fP\f3 $(WINDOWTITLE) \\ /* Adds a window title */ -.fl - \-\fP\f3doctitle\fP\f3 $(DOCTITLE) \\ /* Adds a doc title */ -.fl - \-\fP\f3header\fP\f3 $(HEADER) \\ /* Adds running header text */ -.fl - \-\fP\f3bottom\fP\f3 $(BOTTOM) \\ /* Adds text at bottom */ -.fl - \-\fP\f3group\fP\f3 $(GROUPCORE) \\ /* 1st subhead on overview page */ -.fl - \-\fP\f3group\fP\f3 $(GROUPEXT) \\ /* 2nd subhead on overview page */ -.fl - \-\fP\f3J\fP\f3\-Xmx180m \\ /* Sets memory to 180MB */ -.fl - java.lang java.lang.reflect \\ /* Sets packages to document */ -.fl - java.util java.io java.net \\ -.fl - java.applet -.fl +.sp +.nf +\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp -.fl -WINDOWTITLE = 'Java(TM) SE 7 API Specification' -.fl -DOCTITLE = 'Java(TM) Platform Standard Edition 7 API Specification' -.fl -HEADER = '<b>Java(TM) SE 7</font>' -.fl -BOTTOM = '<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font>' -.fl -GROUPCORE = '"Core Packages" "java.*:com.sun.java.*:org.omg.*"' -.fl -GROUPEXT = '"Extension Packages" "javax.*"' -.fl -SRCDIR = '/java/jdk/1.7.0/src/share/classes' -.fl -\fP -.fi -.LP -Single quotes are used to surround makefile arguments. -.LP -\f3NOTES\fP -.RS 3 -.TP 2 -o -If you omit the \f2\-windowtitle\fP option, the Javadoc tool copies the doc title to the window title. The \f2\-windowtitle\fP text is basically the same as the \f2\-doctitle\fP but without HTML tags, to prevent those tags from appearing as raw text in the window title. -.TP 2 -o -If you omit the \f2\-footer\fP option, as done here, the Javadoc tool copies the header text to the footer. -.TP 2 -o -Other important options you might want to use but not needed in this example are \-\f2classpath\fP and \-\f2link\fP. +.TP +-classpath \fIclasspathlist\fR +.br +Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. + +If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. + +For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/libthen you would use the following command: +.sp +.nf +\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. + +For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. +.TP +-subpackages \fIpackage1:package2:\&.\&.\&.\fR +.br +Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. + +For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. +.sp +.nf +\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-exclude \fIpackagename1:packagename2:\&.\&.\&.\fR +.br +Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. + +The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. +.sp +.nf +\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP +.fi +.nf +\f3 java\&.net:java\&.lang\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-bootclasspath \fIclasspathlist\fR +.br +Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-extdirs \fIdirist\fR +.br +Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-verbose +.br +Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. +.TP +-quiet +.br +Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. +.TP +-breakiterator +.br +Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: +.RS +.TP 0.2i +\(bu +English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. +.TP 0.2i +\(bu +Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. .RE -.SH "TROUBLESHOOTING" -.SS -General Troubleshooting -.RS 3 -.TP 2 -o -\f3Javadoc FAQ\fP \- Commonly\-encountered bugs and troubleshooting tips can be found on the -.na -\f2Javadoc FAQ\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html#B -.TP 2 -o -\f3Bugs and Limitations\fP \- You can also see some bugs listed at Important Bug Fixes and Changes. -.TP 2 -o -\f3Version number\fP \- See version numbers. -.TP 2 -o -\f3Documents only legal classes\fP \- When documenting a package, javadoc only reads files whose names are composed of legal class names. You can prevent javadoc from parsing a file by including, for example, a hyphen "\-" in its filename. +.RS +In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. + .RE -.SS -Errors and Warnings -.LP -Error and warning messages contain the filename and line number to the declaration line rather than to the particular line in the doc comment. -.RS 3 -.TP 2 -o -\f2"error: cannot read: Class1.java"\fP the Javadoc tool is trying to load the class Class1.java in the current directory. The class name is shown with its path (absolute or relative), which in this case is the same as \f2./Class1.java\fP. +.TP +-locale \fIlanguage_country_variant\fR +.br +Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. + +\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. + +Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. +.TP +-encoding +.br +Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. + +There is no space between the \f3J\fR and the \f3flag\fR\&. + +Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. +.sp +.nf +\f3javadoc \-J\-version\fP +.fi +.nf +\f3java version "1\&.7\&.0_09"\fP +.fi +.nf +\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP +.fi +.nf +\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP +.fi +.nf +\f3\fR +.fi +.sp + +.SS STANDARD\ DOCLET\ OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. + +For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. +.TP +-use +.br +Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. +.TP +-version +.br +Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. +.TP +-author +.br +Includes the \f3@author\fR text in the generated docs\&. +.TP +-splitindex +.br +Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. +.TP +-windowtitle \fItitle\fR +.br +Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. +.TP +-doctitle \fItitle\fR +.br +Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-title \fItitle\fR +.br +No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. +.TP +-header \fIheader\fR +.br +Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-footer \fIfooter\fR +.br +Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. +.TP +-top +.br +Specifies the text to be placed at the top of each output file\&. +.TP +-bottom \fItext\fR +.br +Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. +.TP +-link \fIextdocURL\fR +.br +Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. + +The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.sp +.nf +\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Differences between the -linkoffline and -link options + +Use the \f3-link\fR option in the following cases: +.TP 0.2i +\(bu +When you use a relative path to the external API document\&. +.TP 0.2i +\(bu +When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. +.PP +Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. +.PP +\f3Example 1 Absolute Link to External Documents\fR +.PP +Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.sp +.nf +\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp +The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. +.PP +\f3Example 2 Relative Link to External Documents\fR +.PP +In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. +.PP +Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. +.PP +Notes + +The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. +.PP +How to Reference a Class + +For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: +.PP +\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. +.PP +In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. +.PP +\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR +.PP +The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. +.PP +An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. +.PP +Package List + +The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. +.PP +For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.PP +The package list starts as follows: +.sp +.nf +\f3java\&.applet\fP +.fi +.nf +\f3java\&.awt\fP +.fi +.nf +\f3java\&.awt\&.color\fP +.fi +.nf +\f3java\&.awt\&.datatransfer\fP +.fi +.nf +\f3java\&.awt\&.dnd\fP +.fi +.nf +\f3java\&.awt\&.event\fP +.fi +.nf +\f3java\&.awt\&.font\fP +.fi +.nf +\f3and so on \&.\&.\&.\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. +.PP +For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. +.PP +Multiple Links + +You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. +.PP +Cross Links + +Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. +.PP +In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. +.TP +-linkoffline \fIextdocURL packagelistLoc\fR +.br +This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: +.RS +.TP 0.2i +\(bu +The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. +.TP 0.2i +\(bu +The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. + +You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. +.RE + +.PP +Absolute Links to External Documents + +You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.PP +However, your shell does not have web access\&. In this case, do the following: +.TP 0.4i +1\&. +Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.TP 0.4i +2\&. +Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. +.PP +The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. +.sp +.nf +\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Relative Links to External Documents + +It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. +.PP +Create a package-list File Manually + +If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. +.PP +Link to Multiple Documents + +You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: +.sp +.nf +\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP +.fi +.nf +\f3packagelistLoc2 \&.\&.\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Update Documents + +You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. +.PP +First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: +.sp +.nf +\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp +When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. +.TP +-linksource +.br +Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. + +This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. + +Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: +.sp +.nf +\f3public class Button extends Component implements Accessible\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: +.sp +.nf +\f3public String getLabel()\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-group groupheading \fIpackagepattern:packagepattern\fR +.br +Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. +.RS +.TP 0.2i +\(bu +The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. +.TP 0.2i +\(bu +The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. .RE -.SH "ENVIRONMENT" -.RS 3 -.TP 3 +.RS +When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. + +For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. +.sp +.nf +\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP +.fi +.nf +\f3 \-group "Extension Packages" "javax\&.*"\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fICore Packages\fR + +\f3java\&.lang\fR + +\f3java\&.lang\&.reflect\fR + +\f3java\&.util\fR + +\fIExtension Packages\fR + +\f3javax\&.servlet\fR + +\fIOther Packages\fR + +\f3java\&.new\fR + +.RE +.TP +-nodeprecated +.br +Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. +.TP +-nodeprecatedlist +.br +Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. +.TP +-nosince +.br +Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. +.TP +-notree +.br +Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. +.TP +-noindex +.br +Omits the index from the generated documents\&. The index is produced by default\&. +.TP +-nohelp +.br +Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. +.TP +-nonavbar +.br +Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. +.TP +-helpfile \fIpath\efilename\fR +.br +Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: +.sp +.nf +\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-stylesheet \fIpath/filename\fR +.br +Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: +.sp +.nf +\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-serialwarn +.br +Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. +.TP +-charset \fIname\fR +.br +Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: +.sp +.nf +\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 + +See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-docencoding \fIname\fR +.br +Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding"iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-keywords +.br +Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: +.sp +.nf +\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="length()">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="charAt()">\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" +.br +Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. + +\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: + +\f3X\fR (disable tag) + +\f3a\fR (all) + +\f3o\fR (overview) + +\f3p\fR (packages) + +\f3t\fR (types, that is classes and interfaces) + +\f3c\fR (constructors) + +\f3m\fR (methods) + +\f3f\fR (fields) + +\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. + +If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. + +Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. + +\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @ejb:bean\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. + +\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. + +\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): +.sp +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag todo:a:"To Do:"\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\-tag example:X\fP +.fi +.nf +\f3\fR +.fi +.sp + + +When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. + +The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. + +\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. + +\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations + +You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. +.TP +-taglet \fIclass\fR +.br +Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html + +Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. +.sp +.nf +\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP +.fi +.nf +\f3\-tagletpath /home/taglets \fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag todo\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-tagletpath \fItagletpathlist\fR +.br +Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. +.TP +-docfilesubdirs +.br +Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. +.TP +-excludedocfilessubdir \fIname1:name2\fR +.br +Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. +.TP +-noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR +.br +Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. + +The following example omits all package qualifiers: \f3-noqualifier all\fR\&. + +The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. + +The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. + +Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. +.TP +-notimestamp +.br +Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. +.TP +-nocomment +.br +Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. +.TP +-sourcetab \fItablength\fR +.br +Specifies the number of spaces each tab uses in the source\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains: +.sp +.nf +\f3\-d docs\-filelist \fP +.fi +.nf +\f3\-use \fP +.fi +.nf +\f3\-splitindex\fP +.fi +.nf +\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-doctitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP +.fi +.nf +\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*"\fP +.fi +.nf +\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP +.fi +.nf +\f3\fR +.fi +.sp +Create a file named packages that contains: +.sp +.nf +\f3com\&.mypackage1\fP +.fi +.nf +\f3com\&.mypackage2\fP +.fi +.nf +\f3com\&.mypackage3\fP +.fi +.nf +\f3\fR +.fi +.sp +Run the \f3javadoc\fR command as follows: +.sp +.nf +\f3javadoc @options @packages\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javadoc @path1/options @path2/packages\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 4 Option Arguments\fR +.PP +The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: +.sp +.nf +\f3<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\fP +.fi +.nf +\f3\fR +.fi +.sp +Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. +.PP +You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. +.SH RUNNING\ THE\ JAVADOC\ COMMAND +The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. +.PP +Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically +.PP +The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.SS SIMPLE\ EXAMPLES +You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. +.PP +In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. +.PP +Document One or More Packages + +To document a package, the source files for that package must be located in a directory that has the same name as the package\&. +.PP +If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. +.PP +You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. +.PP +You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. +.PP +\f3Example 1 Recursive Run from One or More Packages\fR +.PP +This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Change to Root and Run Explicit Packages\fR +.PP +Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. +.PP +\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR +.PP +Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. +.PP +Document One or More Classes + +The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. +.PP +\f3Example 1 Change to the Source Directory\fR +.PP +Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. +.PP +This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. +.sp +.nf +\f3cd /home/src/java/awt\fP +.fi +.nf +\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Change to the Root Directory of the Package\fR +.PP +This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Document Files from Any Directory\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. +.sp +.nf +\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP +.fi +.nf +\f3/home/src/java/awt/Graphics*\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Document Packages and Classes + +You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP +.fi +.nf +\f3/home/src/java/applet/Applet\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS REAL-WORLD\ EXAMPLES +The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. +.PP +Command-Line Example + +The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. +.PP +In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. +.sp +.nf +\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP +.fi +.nf +\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP +.fi +.nf +\f3\-d /java/jdk/build/api \e\fP +.fi +.nf +\f3\-use \e\fP +.fi +.nf +\f3\-splitIndex \e\fP +.fi +.nf +\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP +.fi +.nf +\f3\-bottom \&'<font size="\-1">\fP +.fi +.nf +\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP +.fi +.nf +\f3\-group "Extension Packages" "javax\&.*" \e\fP +.fi +.nf +\f3\-J\-Xmx180m \e \fP +.fi +.nf +\f3@packages\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Programmatic Interface + +The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. +.PP +For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: +.sp +.nf +\f3import javax\&.tools\&.DocumentationTool;\fP +.fi +.nf +\f3import javax\&.tools\&.ToolProvider;\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3public class JavaAccessSample{\fP +.fi +.nf +\f3 public static void main(String[] args){\fP +.fi +.nf +\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP +.fi +.nf +\f3 int rc = javadoc\&.run( null, null, null,\fP +.fi +.nf +\f3 "\-d", "/home/html",\fP +.fi +.nf +\f3 "\-sourcepath", "home/src",\fP +.fi +.nf +\f3 "\-subpackages", "java",\fP +.fi +.nf +\f3 "\-exclude", "java\&.net:java\&.lang",\fP +.fi +.nf +\f3 "com\&.example");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fR +.fi +.sp +The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. +.SS THE\ MAKEFILE\ EXAMPLE +This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles +.sp +.nf +\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP +.fi +.nf +\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP +.fi +.nf +\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP +.fi +.nf +\f3 \-use \e /* Adds "Use" files */\fP +.fi +.nf +\f3 \-splitIndex \e /* Splits index A\-Z */\fP +.fi +.nf +\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP +.fi +.nf +\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP +.fi +.nf +\f3 \-header $(HEADER) \e /* Adds running header text */\fP +.fi +.nf +\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP +.fi +.nf +\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP +.fi +.nf +\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP +.fi +.nf +\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP +.fi +.nf +\f3 java\&.util java\&.io java\&.net \e\fP +.fi +.nf +\f3 java\&.applet\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP +.fi +.nf +\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP +.fi +.nf +\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP +.fi +.nf +\f3BOTTOM = \&'<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP +.fi +.nf +\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP +.fi +.nf +\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP +.fi +.nf +\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS NOTES +.TP 0.2i +\(bu +If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. +.TP 0.2i +\(bu +If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. +.TP 0.2i +\(bu +Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. +.SH GENERAL\ TROUBLESHOOTING +.TP 0.2i +\(bu +The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. +.TP 0.2i +\(bu +See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html +.SH ERRORS\ AND\ WARNINGS +Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. +.PP +For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. +.SH ENVIRONMENT +.TP CLASSPATH -Environment variable that provides the path which javadoc uses to find user class files. This environment variable is overridden by the \f2\-classpath\fP option. Separate directories with a colon, for example: -.:/home/classes:/usr/local/java/classes -.RE -.SH "SEE ALSO" -.RS 3 -.TP 2 -o -javac(1) -.TP 2 -o -java(1) -.TP 2 -o -jdb(1) -.TP 2 -o -javah(1) -.TP 2 -o -javap(1) -.TP 2 -o -.na -\f2Javadoc Home Page\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-jsp\-135444.html -.TP 2 -o -.na -\f2How to Write Doc Comments for Javadoc\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html -.TP 2 -o -.na -\f2Setting the Class Path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general -.TP 2 -o -.na -\f2How Javac and Javadoc Find Classes\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfiles (tools.jar) -.RE +\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. +\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR + +\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.SH RELATED\ DOCUMENTS +.TP 0.2i +\(bu +Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html +.TP 0.2i +\(bu +How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.TP 0.2i +\(bu +How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html +.TP 0.2i +\(bu +URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.TP 0.2i +\(bu +HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/javah.1 b/jdk/src/bsd/doc/man/javah.1 index 3a2badfc3c0..5b8979e55c3 100644 --- a/jdk/src/bsd/doc/man/javah.1 +++ b/jdk/src/bsd/doc/man/javah.1 @@ -1,138 +1,159 @@ -." Copyright (c) 1994, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javah 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javah.1 +.\" +.if n .pl 99999 +.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javah \- C Header and Stub File Generator -.LP -.LP -\f3javah\fP produces C header files and C source files from a Java class. These files provide the connective glue that allow your Java and C code to interact. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -javah [ \fP\f3options\fP\f3 ] fully\-qualified\-classname. . . -.fl -\fP -.fi +.SH NAME +javah \- Generates C header and source files from a Java class\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3javah\fP generates C header and source files that are needed to implement native methods. The generated header and source files are used by C programs to reference an object's instance variables from native source code. The .h file contains a struct definition whose layout parallels the layout of the corresponding class. The fields in the struct correspond to instance variables in the class. -.LP -.LP -The name of the header file and the structure declared within it are derived from the name of the class. If the class passed to \f3javah\fP is inside a package, the package name is prepended to both the header file name and the structure name. Underscores (_) are used as name delimiters. -.LP -.LP -By default \f3javah\fP creates a header file for each class listed on the command line and puts the files in the current directory. Use the \f2\-stubs\fP option to create source files. Use the \f2\-o\fP option to concatenate the results for all listed classes into a single file. -.LP -.LP -The new native method interface, Java Native Interface (JNI), does not require header information or stub files. \f3javah\fP can still be used to generate native method function proptotypes needed for JNI\-style native methods. \f3javah\fP produces JNI\-style output by default, and places the result in the .h file. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-o outputfile -Concatenates the resulting header or source files for all the classes listed on the command line into \f2outputfile\fP. Only one of \f3\-o\fP or \f3\-d\fP may be used. -.TP 3 -\-d directory -Sets the directory where \f3javah\fP saves the header files or the stub files. Only one of \f3\-d\fP or \f3\-o\fP may be used. -.TP 3 -\-stubs -Causes \f3javah\fP to generate C declarations from the Java object file. -.TP 3 -\-verbose -Indicates verbose output and causes \f3javah\fP to print a message to stdout concerning the status of the generated files. -.TP 3 -\-help -Print help message for \f3javah\fP usage. -.TP 3 -\-version -Print out \f3javah\fP version information. -.TP 3 -\-jni -Causes \f3javah\fP to create an output file containing JNI\-style native method function prototypes. This is the default output, so use of \f3\-jni\fP is optional. -.TP 3 -\-classpath path -Specifies the path \f3javah\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is: -.nf -\f3 -.fl - .:<your_path> -.fl -\fP -.fi -For example: -.nf -\f3 -.fl - .:/home/avh/classes:/usr/local/java/classes -.fl -\fP -.fi -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations). +\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIfully-qualified-class-name\fR +The fully qualified location of the classes to be converted to C header and source files\&. +.SH DESCRIPTION +The \f3javah\fR command generates C header and source files that are needed to implement native methods\&. The generated header and source files are used by C programs to reference an object\&'s instance variables from native source code\&. The \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. +.PP +The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. +.PP +By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. +.PP +The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. +.SH OPTIONS +.TP +-o \fIoutputfile\fR .br +Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. +.TP +-d \fIdirectory\fR .br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.TP 3 -\-bootclasspath path -Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java 2 platform located in \f2jre/lib/rt.jar\fP and several other jar files. -.TP 3 -\-old -Specifies that old JDK1.0\-style header files should be generated. -.TP 3 -\-force -Specifies that output files should always be written. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE +Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. +.TP +-stubs +.br +Causes the \f3javah\fR command to generate C declarations from the Java object file\&. +.TP +-verbose +.br +Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. +.TP +-help +.br +Prints a help message for \f3javah\fR usage\&. +.TP +-version +.br +Prints \f3javah\fR command release information\&. +.TP +-jni +.br +Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 -CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons, for example, -.nf -\f3 -.fl -.:/home/avh/classes:/usr/local/java/classes -.fl -\fP -.fi -.RE +\fIOracle Solaris\fR: -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), jdb(1), javap(1), javadoc(1) -.LP +\&.:\fIyour-path\fR +Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR + +\fIWindows\fR: + +\&.;\fIyour-path\fR + +Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR + +As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. +.TP +-old +.br +Specifies that old JDK 1\&.0-style header files should be generated\&. +.TP +-force +.br +Specifies that output files should always be written\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javap(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/javap.1 b/jdk/src/bsd/doc/man/javap.1 index 08fb9b4c22c..353a13fb0fd 100644 --- a/jdk/src/bsd/doc/man/javap.1 +++ b/jdk/src/bsd/doc/man/javap.1 @@ -1,317 +1,443 @@ -." Copyright (c) 1994, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javap 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javap.1 +.\" +.if n .pl 99999 +.TH javap 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javap \- The Java Class File Disassembler -.LP -.LP -Disassembles class files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -javap [ \fP\f3options\fP\f3 ] classes -.fl -\fP -.fi +.SH NAME +javap \- Disassembles one or more class files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3javap\fP command disassembles one or more class files. Its output depends on the options used. If no options are used, \f3javap\fP prints out the package, protected, and public fields and methods of the classes passed to it. \f3javap\fP prints its output to stdout. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -classes -List of one or more classes (separated by spaces) to be processed for annotations (such as \f2DocFooter.class\fP). You may specify a class that can be found in the class path, by its file name (for example, \f2/home/user/myproject/src/DocFooter.class\fP), or with a URL (for example, \f2file:///home/user/myproject/src/DocFooter.class\fP). -.RE +\fBjavap\fR [\fIoptions\fR] \fIclassfile\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassfile\fR +One or more classes separated by spaces to be processed for annotations such as DocFooter\&.class\&. You can specify a class that can be found in the class path, by its file name or with a URL such as \f3file:///home/user/myproject/src/DocFooter\&.class\fR\&. +.SH DESCRIPTION +The \f3javap\fR command disassembles one or more class files\&. The output depends on the options used\&. When no options are used, then the \f3javap\fR command prints the package, protected and public fields, and methods of the classes passed to it\&. The \f3javap\fR command prints its output to \f3stdout\fR\&. +.SH OPTIONS +.TP +-help, --help, -? +.br +Prints a help message for the \f3javap\fR command\&. +.TP +-version +.br +Prints release information\&. +.TP +-l +.br +Prints line and local variable tables\&. +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. +.TP +-private, -p +.br +Shows all classes and members\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the JVM\&. For example: +.sp +.nf +\f3javap \-J\-version\fP +.fi +.nf +\f3javap \-J\-Djava\&.security\&.manager \-J\-Djava\&.security\&.policy=MyPolicy MyClassName\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -For example, compile the following class declaration: -.LP -.nf -\f3 -.fl -import java.awt.*; -.fl -import java.applet.*; -.fl - -.fl -public class DocFooter extends Applet { -.fl - String date; -.fl - String email; -.fl - -.fl - public void init() { -.fl - resize(500,100); -.fl - date = getParameter("LAST_UPDATED"); -.fl - email = getParameter("EMAIL"); -.fl - } -.fl - -.fl - public void paint(Graphics g) { -.fl - g.drawString(date + " by ",100, 15); -.fl - g.drawString(email,290,15); -.fl - } -.fl -} -.fl -\fP -.fi - -.LP -.LP -The output from \f3javap DocFooter.class\fP yields: -.LP -.nf -\f3 -.fl -Compiled from "DocFooter.java" -.fl -public class DocFooter extends java.applet.Applet { -.fl - java.lang.String date; -.fl - java.lang.String email; -.fl - public DocFooter(); -.fl - public void init(); -.fl - public void paint(java.awt.Graphics); -.fl -} -.fl -\fP -.fi - -.LP -.LP -The output from \f3javap \-c DocFooter.class\fP yields: -.LP -.nf -\f3 -.fl -Compiled from "DocFooter.java" -.fl -public class DocFooter extends java.applet.Applet { -.fl - java.lang.String date; -.fl - -.fl - java.lang.String email; -.fl - -.fl - public DocFooter(); -.fl - Code: -.fl - 0: aload_0 -.fl - 1: invokespecial #1 // Method java/applet/Applet."<init>":()V -.fl - 4: return -.fl - -.fl - public void init(); -.fl - Code: -.fl - 0: aload_0 -.fl - 1: sipush 500 -.fl - 4: bipush 100 -.fl - 6: invokevirtual #2 // Method resize:(II)V -.fl - 9: aload_0 -.fl - 10: aload_0 -.fl - 11: ldc #3 // String LAST_UPDATED -.fl - 13: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String; -.fl - 16: putfield #5 // Field date:Ljava/lang/String; -.fl - 19: aload_0 -.fl - 20: aload_0 -.fl - 21: ldc #6 // String EMAIL -.fl - 23: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String; -.fl - 26: putfield #7 // Field email:Ljava/lang/String; -.fl - 29: return -.fl - -.fl - public void paint(java.awt.Graphics); -.fl - Code: -.fl - 0: aload_1 -.fl - 1: new #8 // class java/lang/StringBuilder -.fl - 4: dup -.fl - 5: invokespecial #9 // Method java/lang/StringBuilder."<init>":()V -.fl - 8: aload_0 -.fl - 9: getfield #5 // Field date:Ljava/lang/String; -.fl - 12: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder; -.fl - 15: ldc #11 // String by -.fl - 17: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder; -.fl - 20: invokevirtual #12 // Method java/lang/StringBuilder.toString:()Ljava/lang/String; -.fl - 23: bipush 100 -.fl - 25: bipush 15 -.fl - 27: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V -.fl - 30: aload_1 -.fl - 31: aload_0 -.fl - 32: getfield #7 // Field email:Ljava/lang/String; -.fl - 35: sipush 290 -.fl - 38: bipush 15 -.fl - 40: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V -.fl - 43: return -.fl -} -.fl -\fP -.fi - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-help \-\-help \-? -Prints out help message for \f3javap\fP. -.TP 3 -\-version -Prints out version information. -.TP 3 -\-l -Prints out line and local variable tables. -.TP 3 -\-public -Shows only public classes and members. -.TP 3 -\-protected -Shows only protected and public classes and members. -.TP 3 -\-package -Shows only package, protected, and public classes and members. This is the default. -.TP 3 -\-private \-p -Shows all classes and members. -.TP 3 -\-Jflag -Pass \f2flag\fP directly to the runtime system. Some examples: -.nf -\f3 -.fl -javap \-J\-version -.fl -javap \-J\-Djava.security.manager \-J\-Djava.security.policy=MyPolicy MyClassName -.fl -\fP -.fi -.TP 3 -\-s -Prints internal type signatures. -.TP 3 -\-sysinfo -Shows system information (path, size, date, MD5 hash) of the class being processed. -.TP 3 -\-constants -Shows static final constants. -.TP 3 -\-c -Prints out disassembled code, i.e., the instructions that comprise the Java bytecodes, for each of the methods in the class. These are documented in the -.na -\f2Java Virtual Machine Specification\fP @ -.fi -http://java.sun.com/docs/books/vmspec/. -.TP 3 -\-verbose -Prints stack size, number of \f2locals\fP and \f2args\fP for methods. -.TP 3 -\-classpath path -Specifies the path \f3javap\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. -.TP 3 -\-bootclasspath path -Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java platform located in \f2jre/lib/rt.jar\fP and several other jar files. -.TP 3 -\-extdirs dirs -Overrides location at which installed extensions are searched for. The default location for extensions is the value of \f2java.ext.dirs\fP. -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), jdb(1), javah(1), javadoc(1) -.LP +For more information about JVM options, see the \f3java(1)\fR command documentation\&. +.TP +-s +.br +Prints internal type signatures\&. +.TP +-sysinfo +.br +Shows system information (path, size, date, MD5 hash) of the class being processed\&. +.TP +-constants +.br +Shows \f3static final\fR constants\&. +.TP +-c +.br +Prints disassembled code, for example, the instructions that comprise the Java bytecodes, for each of the methods in the class\&. +.TP +-verbose +.br +Prints stack size, number of locals and arguments for methods\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javap\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre/lib/rt\&.jar\fR and several other JAR files\&. +.TP +-extdir \fIdirs\fR +.br +Overrides the location at which installed extensions are searched for\&. The default location for extensions is the value of \f3java\&.ext\&.dirs\fR\&. +.SH EXAMPLE +Compile the following \f3DocFooter\fR class: +.sp +.nf +\f3import java\&.awt\&.*;\fP +.fi +.nf +\f3import java\&.applet\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class DocFooter extends Applet {\fP +.fi +.nf +\f3 String date;\fP +.fi +.nf +\f3 String email;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void init() {\fP +.fi +.nf +\f3 resize(500,100);\fP +.fi +.nf +\f3 date = getParameter("LAST_UPDATED");\fP +.fi +.nf +\f3 email = getParameter("EMAIL");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void paint(Graphics g) {\fP +.fi +.nf +\f3 g\&.drawString(date + " by ",100, 15);\fP +.fi +.nf +\f3 g\&.drawString(email,290,15);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +The output from the \f3javap DocFooter\&.class\fR command yields the following: +.sp +.nf +\f3Compiled from "DocFooter\&.java"\fP +.fi +.nf +\f3public class DocFooter extends java\&.applet\&.Applet {\fP +.fi +.nf +\f3 java\&.lang\&.String date;\fP +.fi +.nf +\f3 java\&.lang\&.String email;\fP +.fi +.nf +\f3 public DocFooter();\fP +.fi +.nf +\f3 public void init();\fP +.fi +.nf +\f3 public void paint(java\&.awt\&.Graphics);\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +The output from \f3javap -c DocFooter\&.class\fR command yields the following: +.sp +.nf +\f3Compiled from "DocFooter\&.java"\fP +.fi +.nf +\f3public class DocFooter extends java\&.applet\&.Applet {\fP +.fi +.nf +\f3 java\&.lang\&.String date;\fP +.fi +.nf +\f3 java\&.lang\&.String email;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public DocFooter();\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_0 \fP +.fi +.nf +\f3 1: invokespecial #1 // Method\fP +.fi +.nf +\f3java/applet/Applet\&."<init>":()V\fP +.fi +.nf +\f3 4: return \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void init();\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_0 \fP +.fi +.nf +\f3 1: sipush 500\fP +.fi +.nf +\f3 4: bipush 100\fP +.fi +.nf +\f3 6: invokevirtual #2 // Method resize:(II)V\fP +.fi +.nf +\f3 9: aload_0 \fP +.fi +.nf +\f3 10: aload_0 \fP +.fi +.nf +\f3 11: ldc #3 // String LAST_UPDATED\fP +.fi +.nf +\f3 13: invokevirtual #4 // Method\fP +.fi +.nf +\f3 getParameter:(Ljava/lang/String;)Ljava/lang/String;\fP +.fi +.nf +\f3 16: putfield #5 // Field date:Ljava/lang/String;\fP +.fi +.nf +\f3 19: aload_0 \fP +.fi +.nf +\f3 20: aload_0 \fP +.fi +.nf +\f3 21: ldc #6 // String EMAIL\fP +.fi +.nf +\f3 23: invokevirtual #4 // Method\fP +.fi +.nf +\f3 getParameter:(Ljava/lang/String;)Ljava/lang/String;\fP +.fi +.nf +\f3 26: putfield #7 // Field email:Ljava/lang/String;\fP +.fi +.nf +\f3 29: return \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void paint(java\&.awt\&.Graphics);\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_1 \fP +.fi +.nf +\f3 1: new #8 // class java/lang/StringBuilder\fP +.fi +.nf +\f3 4: dup \fP +.fi +.nf +\f3 5: invokespecial #9 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&."<init>":()V\fP +.fi +.nf +\f3 8: aload_0 \fP +.fi +.nf +\f3 9: getfield #5 // Field date:Ljava/lang/String;\fP +.fi +.nf +\f3 12: invokevirtual #10 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;\fP +.fi +.nf +\f3 15: ldc #11 // String by \fP +.fi +.nf +\f3 17: invokevirtual #10 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;\fP +.fi +.nf +\f3 20: invokevirtual #12 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.toString:()Ljava/lang/String;\fP +.fi +.nf +\f3 23: bipush 100\fP +.fi +.nf +\f3 25: bipush 15\fP +.fi +.nf +\f3 27: invokevirtual #13 // Method\fP +.fi +.nf +\f3 java/awt/Graphics\&.drawString:(Ljava/lang/String;II)V\fP +.fi +.nf +\f3 30: aload_1 \fP +.fi +.nf +\f3 31: aload_0 \fP +.fi +.nf +\f3 32: getfield #7 // Field email:Ljava/lang/String;\fP +.fi +.nf +\f3 35: sipush 290\fP +.fi +.nf +\f3 38: bipush 15\fP +.fi +.nf +\f3 40: invokevirtual #13 // Method\fP +.fi +.nf +\f3java/awt/Graphics\&.drawString:(Ljava/lang/String;II)V\fP +.fi +.nf +\f3 43: return \fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jcmd.1 b/jdk/src/bsd/doc/man/jcmd.1 new file mode 100644 index 00000000000..f789bdc5286 --- /dev/null +++ b/jdk/src/bsd/doc/man/jcmd.1 @@ -0,0 +1,114 @@ +'\" t +.\" Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jcmd.1 +.\" +.if n .pl 99999 +.TH jcmd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jcmd \- Sends diagnostic command requests to a running Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf + +\fBjcmd\fR [\fB\-l\fR|\fB\-h\fR|\fB\-help\fR] +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fBPerfCounter\&.print\fR +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fB\-f\fR \fIfilename\fR +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fIcommand\fR[ \fIarguments\fR] +.fi +.sp +.SH DESCRIPTION +The \f3jcmd\fR utility is used to send diagnostic command requests to the JVM\&. It must be used on the same machine on which the JVM is running, and have the same effective user and group identifiers that were used to launch the JVM\&. +.PP +\fINote:\fR To invoke diagnostic commands from a remote machine or with different identiers, you can use the \f3com\&.sun\&.management\&.DiagnosticCommandMBean\fR interface\&. For more information about the \f3DiagnosticCommandMBean\fR interface, see the API documentation at http://download\&.java\&.net/jdk8/docs/jre/api/management/extension/com/sun/management/DiagnosticCommandMBean\&.html +.PP +If you run \f3jcmd\fR without arguments or with the \f3-l\fR option, it prints the list of running Java process identifiers with the main class and command-line arguments that were used to launch the process\&. Running \f3jcmd\fR with the \f3-h\fR or \f3-help\fR option prints the tool\(cqs help message\&. +.PP +If you specify the processes identifier (\fIpid\fR) or the main class (\fImain-class\fR) as the first argument, \f3jcmd\fR sends the diagnostic command request to the Java process with the specified identifier or to all Java processes with the specified name of the main class\&. You can also send the diagnostic command request to all available Java processes by specifying \f30\fR as the process identifier\&. Use one of the following as the diagnostic command request: +.TP +Perfcounter\&.print +Prints the performance counters available for the specified Java process\&. The list of performance counters might vary with the Java process\&. +.TP +-f \fIfilename\fR +.br +The name of the file from which to read diagnostic commands and send them to the specified Java process\&. Used only with the \f3-f\fR option\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. +.TP +\fIcommand\fR [\fIarguments\fR] +The command to be sent to the specified Java process\&. The list of available diagnostic commands for a given process can be obtained by sending the \f3help\fR command to this process\&. Each diagnostic command has its own set of arguments\&. To see the description, syntax, and a list of available arguments for a command, use the name of the command as the argument for the \f3help\fR command\&. + +\fINote:\fR If any arguments contain spaces, you must surround them with single or double quotation marks (\f3\&'\fR or \f3"\fR)\&. In addition, you must escape single or double quotation marks with a backslash (\f3\e\fR) to prevent the operating system shell from processing quotation marks\&. Alternatively, you can surround these arguments with single quotation marks and then with double quotation marks (or with double quotation marks and then with single quotation marks)\&. +.SH OPTIONS +Options are mutually exclusive\&. +.TP +-f \fIfilename\fR +.br +Reads commands from the specified file\&. This option can be used only if you specify the process identifier or the main class as the first argument\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. +.TP +-h, -help +.br +Prints a help message\&. +.TP +-l +.br +Prints the list of running Java processes identifiers with the main class and command-line arguments\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jconsole.1 b/jdk/src/bsd/doc/man/jconsole.1 index 01b5cd6b157..8afd342a36b 100644 --- a/jdk/src/bsd/doc/man/jconsole.1 +++ b/jdk/src/bsd/doc/man/jconsole.1 @@ -1,137 +1,113 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jconsole 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools +.\" Title: jconsole.1 +.\" +.if n .pl 99999 +.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jconsole \- Java Monitoring and Management Console -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ] -.fl +.SH NAME +jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi +\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR +The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -connection = pid | host:port | jmxUrl -.RS 3 -.TP 2 -o -\f2pid\fP Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See -.na -\f2JMX Monitoring and Management\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. -.TP 2 -o -\f2host\fP:\f2port\fP Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See -.na -\f2JMX Monitoring and Management\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. -.TP 2 -o -\f2jmxUrl\fP Address of the JMX agent to be connected to as described in -.na -\f2JMXServiceURL\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html. -.RE -.RE +For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jconsole\fP command launches a graphical console tool that enables you to monitor and manage Java applications and virtual machines on a local or remote machine. -.LP -.LP -On Windows, \f3jconsole\fP does not associate with a console window. It will, however, display a dialog box with error information if the \f3jconsole\fP command fails for some reason. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-interval=n -Set the update interval to \f2n\fP seconds (default is 4 seconds). -.TP 3 -\-notile -Do not tile windows initially (for two or more connections). -.TP 3 -\-pluginpath plugins -Specify a list of directories or JAR files which are searched for JConsole plugins. The \f2plugins\fP path should contain a provider\-configuration file named: +See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.SH DESCRIPTION +The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. +.PP +On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. +.SH OPTIONS +.TP +-interval\fI=n\fR .br -.nf -\f3 -.fl - META\-INF/services/com.sun.tools.jconsole.JConsolePlugin -.fl -\fP -.fi -containing one line for each plugin specifying the fully qualified class name of the class implementing the -.na -\f2com.sun.tools.jconsole.JConsolePlugin\fP @ -.fi -http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. -.TP 3 -\-version -Output version information and exit. -.TP 3 -\-help -Output help message and exit. -.TP 3 -\-J<flag> -Pass <flag> to the Java virtual machine on which jconsole is run. -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -.na -\f2Using JConsole\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html -.TP 2 -o -.na -\f2Monitoring and Management for Java Platform\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html -.RE - -.LP - +Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. +.TP +-notile +.br +Does not tile windows initially (for two or more connections)\&. +.TP +-pluginpath \fIplugins\fR +.br +Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. +.TP +-version +.br +Displays release information and exits\&. +.TP +-help +.br +Displays a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html +.TP 0.2i +\(bu +Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html +.TP 0.2i +\(bu +The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jdb.1 b/jdk/src/bsd/doc/man/jdb.1 index c746a0ee2b6..4304f15e8a9 100644 --- a/jdk/src/bsd/doc/man/jdb.1 +++ b/jdk/src/bsd/doc/man/jdb.1 @@ -1,330 +1,271 @@ -." Copyright (c) 1995, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jdb 1 "10 May 2011" +'\" t +.\" Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdb.1 +.\" +.if n .pl 99999 +.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jdb \- The Java Debugger -.LP -.LP -\f3jdb\fP helps you find and fix bugs in Java language programs. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jdb\fP [ options ] [ class ] [ arguments ] -.fl -.fi +.SH NAME +jdb \- Finds and fixes bugs in Java platform programs\&. +.SH SYNOPSIS +.sp +.nf -.LP -.RS 3 -.TP 3 -options -Command\-line options, as specified below. -.TP 3 -class -Name of the class to begin debugging. -.TP 3 -arguments -Arguments passed to the \f2main()\fP method of \f2class\fP. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The Java Debugger, \f3jdb\fP, is a simple command\-line debugger for Java classes. It is a demonstration of the -.na -\f2Java Platform Debugger Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/index.html that provides inspection and debugging of a local or remote Java Virtual Machine. -.LP -.SS -Starting a jdb Session -.LP -.LP -There are many ways to start a jdb session. The most frequently used way is to have \f3jdb\fP launch a new Java Virtual Machine (VM) with the main class of the application to be debugged. This is done by substituting the command \f3jdb\fP for \f3java\fP in the command line. For example, if your application's main class is MyClass, you use the following command to debug it under JDB: -.LP -.nf -\f3 -.fl - % jdb MyClass -.fl -\fP -.fi - -.LP -.LP -When started this way, \f3jdb\fP invokes a second Java VM with any specified parameters, loads the specified class, and stops the VM before executing that class's first instruction. -.LP -.LP -Another way to use \f3jdb\fP is by attaching it to a Java VM that is already running. Syntax for Starting a VM to which jdb will attach when the VM is running is as follows. This loads in\-process debugging libraries and specifies the kind of connection to be made. -.LP -.nf -\f3 -.fl -\-agentlib:jdwp=transport=dt_socket,server=y,suspend=n -.fl -\fP -.fi - -.LP -.LP -For example, the following command will run the MyClass application, and allow \f3jdb\fP to connect to it at a later time. -.LP -.nf -\f3 -.fl - % java \-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n MyClass -.fl -\fP -.fi - -.LP -.LP -You can then attach \f3jdb\fP to the VM with the following commmand: -.LP -.nf -\f3 -.fl - % jdb \-attach 8000 -.fl -\fP -.fi - -.LP -.LP -Note that "MyClass" is not specified in the \f3jdb\fP command line in this case because \f3jdb\fP is connecting to an existing VM instead of launching a new one. -.LP -.LP -There are many other ways to connect the debugger to a VM, and all of them are supported by \f3jdb\fP. The Java Platform Debugger Architecture has additional -.na -\f2documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection options. For information on starting a J2SE 1.4.2 or early VM for use with \f3jdb\fP see the -.na -\f21.4.2 documentation\fP @ -.fi -http://java.sun.com/j2se/1.4.2/docs/guide/jpda/conninv.html -.LP -.SS -Basic jdb Commands -.LP -.LP -The following is a list of the basic \f3jdb\fP commands. The Java debugger supports other commands which you can list using \f3jdb\fP's \f2help\fP command. -.LP -.RS 3 -.TP 3 -help, or ? -The most important \f3jdb\fP command, \f2help\fP displays the list of recognized commands with a brief description. -.TP 3 +\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fRname +Name of the main class to debug\&. +.TP +\fIarguments\fR +Arguments passed to the \f3main()\fR method of the class\&. +.SH DESCRIPTION +The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.SS START\ A\ JDB\ SESSION +There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: +.sp +.nf +\f3jdb MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. +.PP +Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. +.sp +.nf +\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +You can then attach the \f3jdb\fR command to the JVM with the following command: +.sp +.nf +\f3jdb \-attach 8000\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. +.PP +There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. +.SS BASIC\ JDB\ COMMANDS +The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. +.TP +help or ? +The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. +.TP run -After starting \f3jdb\fP, and setting any necessary breakpoints, you can use this command to start the execution the debugged application. This command is available only when \f3jdb\fP launches the debugged application (as opposed to attaching to an existing VM). -.TP 3 +After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. +.TP cont -Continues execution of the debugged application after a breakpoint, exception, or step. -.TP 3 +Continues execution of the debugged application after a breakpoint, exception, or step\&. +.TP print -Displays Java objects and primitive values. For variables or fields of primitive types, the actual value is printed. For objects, a short description is printed. See the \f2dump\fP command below for getting more information about an object. -.br -.br -\f2NOTE: To display local variables, the containing class must have been compiled with the \fP\f2javac(1)\fP\f2 \fP\f2\-g\fP option. -.br -.br -\f2print\fP supports many simple Java expressions including those with method invocations, for example: -.RS 3 -.TP 2 -o -\f2print MyClass.myStaticField\fP -.TP 2 -o -\f2print myObj.myInstanceField\fP -.TP 2 -o -\f2print i + j + k\fP \f2(i, j, k are primities and either fields or local variables)\fP -.TP 2 -o -\f2print myObj.myMethod()\fP \f2(if myMethod returns a non\-null)\fP -.TP 2 -o -\f2print new java.lang.String("Hello").length()\fP -.RE -.TP 3 +Displays Java objects and primitive values\&. For variables or fields of primitive types, the actual value is printed\&. For objects, a short description is printed\&. See the dump command to find out how to get more information about an object\&. + +\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. + +The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: +.sp +.nf +\f3print MyClass\&.myStaticField\fP +.fi +.nf +\f3print myObj\&.myInstanceField\fP +.fi +.nf +\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP +.fi +.nf +\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP +.fi +.nf +\f3print new java\&.lang\&.String("Hello")\&.length()\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP dump -For primitive values, this command is identical to \f2print\fP. For objects, it prints the current value of each field defined in the object. Static and instance fields are included. -.br -.br -The \f2dump\fP command supports the same set of expressions as the \f2print\fP command. -.TP 3 +For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. +.TP threads -List the threads that are currently running. For each thread, its name and current status are printed, as well as an index that can be used for other commands, for example: -.nf -\f3 -.fl -4. (java.lang.Thread)0x1 main running -.fl -\fP -.fi -In this example, the thread index is 4, the thread is an instance of java.lang.Thread, the thread name is "main", and it is currently running, -.TP 3 +List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. +.sp +.nf +\f34\&. (java\&.lang\&.Thread)0x1 main running\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP thread -Select a thread to be the current thread. Many \f3jdb\fP commands are based on the setting of the current thread. The thread is specified with the thread index described in the \f2threads\fP command above. -.TP 3 +Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. +.TP where -\f2where\fP with no arguments dumps the stack of the current thread. \f2where all\fP dumps the stack of all threads in the current thread group. \f2where\fP \f2threadindex\fP dumps the stack of the specified thread. +The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. + +If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. +.SS BREAKPOINTS +Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: +.TP 0.2i +\(bu +The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. +.TP 0.2i +\(bu +The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. +.TP 0.2i +\(bu +The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. +.PP +When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. +.PP +The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. +.SS STEPPING +The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. +.SS EXCEPTIONS +When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. +.PP +Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. +.PP +The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. +.SH OPTIONS +When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. +.PP +Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.TP +-help .br +Displays a help message\&. +.TP +-sourcepath \fIdir1:dir2: \&. \&. \&.\fR .br -If the current thread is suspended (either through an event such as a breakpoint or through the \f2suspend\fP command), local variables and fields can be displayed with the \f2print\fP and \f2dump\fP commands. The \f2up\fP and \f2down\fP commands select which stack frame is current. -.RE - -.LP -.SS -Breakpoints -.LP -.LP -Breakpoints can be set in \f3jdb\fP at line numbers or at the first instruction of a method, for example: -.LP -.RS 3 -.TP 2 -o -\f2stop at MyClass:22\fP \f2(sets a breakpoint at the first instruction for line 22 of the source file containing MyClass)\fP -.TP 2 -o -\f2stop in java.lang.String.length\fP \f2(sets a breakpoint at the beginnig of the method \fP\f2java.lang.String.length\fP) -.TP 2 -o -\f2stop in MyClass.<init>\fP \f2(<init> identifies the MyClass constructor)\fP -.TP 2 -o -\f2stop in MyClass.<clinit>\fP \f2(<clinit> identifies the static initialization code for MyClass)\fP -.RE - -.LP -.LP -If a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint. For example, "\f2MyClass.myMethod(int,java.lang.String)\fP", or "\f2MyClass.myMethod()\fP". -.LP -.LP -The \f2clear\fP command removes breakpoints using a syntax as in "\f2clear\ MyClass:45\fP". Using the \f2clear\fP or command with no argument displays a list of all breakpoints currently set. The \f2cont\fP command continues execution. -.LP -.SS -Stepping -.LP -.LP -The \f2step\fP commands advances execution to the next line whether it is in the current stack frame or a called method. The \f2next\fP command advances execution to the next line in the current stack frame. -.LP -.SS -Exceptions -.LP -.LP -When an exception occurs for which there isn't a catch statement anywhere in the throwing thread's call stack, the VM normally prints an exception trace and exits. When running under \f3jdb\fP, however, control returns to \f3jdb\fP at the offending throw. You can then use \f3jdb\fP to diagnose the cause of the exception. -.LP -.LP -Use the \f2catch\fP command to cause the debugged application to stop at other thrown exceptions, for example: "\f2catch java.io.FileNotFoundException\fP" or "\f2catch mypackage.BigTroubleException\fP. Any exception which is an instance of the specifield class (or of a subclass) will stop the application at the point where it is thrown. -.LP -.LP -The \f2ignore\fP command negates the effect of a previous \f2catch\fP command. -.LP -.LP -\f2NOTE: The \fP\f2ignore\fP command does not cause the debugged VM to ignore specific exceptions, only the debugger. -.LP -.SH "Command Line Options" -.LP -.LP -When you use \f3jdb\fP in place of the Java application launcher on the command line, \f3jdb\fP accepts many of the same options as the java command, including \f2\-D\fP, \f2\-classpath\fP, and \f2\-X<option>\fP. -.LP -.LP -The following additional options are accepted by \f3jdb\fP: -.LP -.RS 3 -.TP 3 -\-help -Displays a help message. -.TP 3 -\-sourcepath <dir1:dir2:...> -Uses the given path in searching for source files in the specified path. If this option is not specified, the default path of "." is used. -.TP 3 -\-attach <address> -Attaches the debugger to previously running VM using the default connection mechanism. -.TP 3 -\-listen <address> -Waits for a running VM to connect at the specified address using standard connector. -.TP 3 -\-listenany -Waits for a running VM to connect at any available address using standard connector. -.TP 3 -\-launch -Launches the debugged application immediately upon startup of jdb. This option removes the need for using the \f2run\fP command. The debuged application is launched and then stopped just before the initial application class is loaded. At that point you can set any necessary breakpoints and use the \f2cont\fP to continue execution. -.TP 3 -\-listconnectors -List the connectors available in this VM -.TP 3 -\-connect <connector\-name>:<name1>=<value1>,... -Connects to target VM using named connector with listed argument values. -.TP 3 -\-dbgtrace [flags] -Prints info for debugging jdb. -.TP 3 -\-tclient -Runs the application in the Java HotSpot(tm) VM (Client). -.TP 3 -\-tserver -Runs the application in the Java HotSpot(tm) VM (Server). -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine used to run jdb. (Options for the application Java virtual machine are passed to the \f3run\fP command.) For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.LP -Other options are supported for alternate mechanisms for connecting the debugger and the VM it is to debug. The Java Platform Debugger Architecture has additional -.na -\f2documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection alternatives. -.LP -.SS -Options Forwarded to Debuggee Process -.LP -.RS 3 -.TP 3 -\-v \-verbose[:class|gc|jni] -Turns on verbose mode. -.TP 3 -\-D<name>=<value> -Sets a system property. -.TP 3 -\-classpath <directories separated by ":"> -Lists directories in which to look for classes. -.TP 3 -\-X<option> -Non\-standard target VM option -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), javah(1), javap(1), javadoc(1). -.LP - +Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. +.TP +-attach \fIaddress\fR +.br +Attaches the debugger to a running JVM with the default connection mechanism\&. +.TP +-listen \fIaddress\fR +.br +Waits for a running JVM to connect to the specified address with a standard connector\&. +.TP +-launch +.br +Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. +.TP +-listconnectors +.br +List the connectors available in this JVM\&. +.TP +-connect connector-name:\fIname1=value1\fR +.br +Connects to the target JVM with the named connector and listed argument values\&. +.TP +-dbgtrace [\fIflags\fR] +.br +Prints information for debugging the \f3jdb\fR command\&. +.TP +-tclient +.br +Runs the application in the Java HotSpot VM client\&. +.TP +-tserver +.br +Runs the application in the Java HotSpot VM server\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS +.TP +-v -verbose[:\fIclass\fR|gc|jni] +.br +Turns on verbose mode\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property\&. +.TP +-classpath \fIdir\fR +.br +Lists directories separated by colons in which to look for classes\&. +.TP +-X\fIoption\fR +.br +Nonstandard target JVM option\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jdeps.1 b/jdk/src/bsd/doc/man/jdeps.1 new file mode 100644 index 00000000000..9b8f698f6a2 --- /dev/null +++ b/jdk/src/bsd/doc/man/jdeps.1 @@ -0,0 +1,532 @@ +'\" t +.\" Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdeps.1 +.\" +.if n .pl 99999 +.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdeps \- Java class dependency analyzer\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fR\fIes\fR +Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. +.SH DESCRIPTION +The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. +.SH OPTIONS +.TP +-dotoutput <\fIdir\fR> +.br +Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. +.TP +-s, -summary +.br +Prints dependency summary only\&. +.TP +-v, -verbose +.br +Prints all class-level dependencies\&. +.TP +-verbose:package +.br +Prints package-level dependencies excluding dependencies within the same archive\&. +.TP +-verbose:class +.br +Prints class-level dependencies excluding dependencies within the same archive\&. +.TP +-cp <\fIpath\fR>, -classpath <\fIpath\fR> +.br +Specifies where to find class files\&. + +See also Setting the Class Path\&. +.TP +-p <\fIpkg name\fR>, -package <\fIpkg name\fR> +.br +Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-e <\fIregex\fR>, -regex <\fIregex\fR> +.br +Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-include <\fIregex\fR> +.br +Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. +.TP +-P, -profile +.br +Shows profile or the file containing a package\&. +.TP +-apionly +.br +Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. +.TP +-R, -recursive +.br +Recursively traverses all dependencies\&. +.TP +-version +.br +Prints version information\&. +.TP +-h, -?, -help +.br +Prints help message for \f3jdeps\fR\&. +.SH EXAMPLES +Analyzing the dependencies of Notepad\&.jar\&. +.sp +.nf +\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt \fP +.fi +.nf +\f3 \-> java\&.awt\&.event \fP +.fi +.nf +\f3 \-> java\&.beans \fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.logging \fP +.fi +.nf +\f3 \-> javax\&.swing \fP +.fi +.nf +\f3 \-> javax\&.swing\&.border \fP +.fi +.nf +\f3 \-> javax\&.swing\&.event \fP +.fi +.nf +\f3 \-> javax\&.swing\&.text \fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree \fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo \fP +.fi +.nf +\f3\fP +.fi +.sp +Use -P or -profile option to show on which profile that Notepad depends\&. +.sp +.nf +\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt Full JRE\fP +.fi +.nf +\f3 \-> java\&.awt\&.event Full JRE\fP +.fi +.nf +\f3 \-> java\&.beans Full JRE\fP +.fi +.nf +\f3 \-> java\&.io compact1\fP +.fi +.nf +\f3 \-> java\&.lang compact1\fP +.fi +.nf +\f3 \-> java\&.net compact1\fP +.fi +.nf +\f3 \-> java\&.util compact1\fP +.fi +.nf +\f3 \-> java\&.util\&.logging compact1\fP +.fi +.nf +\f3 \-> javax\&.swing Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.border Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.event Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.text Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo Full JRE\fP +.fi +.nf +\f3\fP +.fi +.sp +Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. +.sp +.nf +\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. +.sp +.nf +\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io\&.PrintWriter \fP +.fi +.nf +\f3 \-> java\&.lang\&.Exception \fP +.fi +.nf +\f3 \-> java\&.lang\&.Object \fP +.fi +.nf +\f3 \-> java\&.lang\&.String \fP +.fi +.nf +\f3 \-> java\&.lang\&.System \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. +.sp +.nf +\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.nio\&.charset \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.nio\&.file\&.attribute \fP +.fi +.nf +\f3 \-> java\&.text \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 javax\&.crypto (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.nio \fP +.fi +.nf +\f3 \-> java\&.security \fP +.fi +.nf +\f3 \-> java\&.security\&.cert \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.concurrent \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3 \-> javax\&.security\&.auth \fP +.fi +.nf +\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 javax\&.crypto\&.spec (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP +.fi +.nf +\f3 java\&.security (rt\&.jar)\fP +.fi +.nf +\f3 \-> javax\&.crypto\fP +.fi +.nf +\f3\fP +.fi +.sp +Generate dot files of the dependencies of Notepad demo\&. +.sp +.nf +\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files +.sp +.nf +\f3$ cat dot/Notepad\&.jar\&.dot \fP +.fi +.nf +\f3digraph "Notepad\&.jar" {\fP +.fi +.nf +\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.beans";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.io";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.lang";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.net";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3$ cat dot/summary\&.dot\fP +.fi +.nf +\f3digraph "summary" {\fP +.fi +.nf +\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jhat.1 b/jdk/src/bsd/doc/man/jhat.1 index 7e0c7db97ca..c53dc0fce38 100644 --- a/jdk/src/bsd/doc/man/jhat.1 +++ b/jdk/src/bsd/doc/man/jhat.1 @@ -1,141 +1,137 @@ -." Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jhat 1 "10 May 2011" +'\" t +.\" Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jhat.1 +.\" +.if n .pl 99999 +.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jhat \- Java Heap Analysis Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jhat\fP [ \f2options\fP ] <heap\-dump\-file> -.fl +.SH NAME +jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -heap\-dump\-file -Java binary heap dump file to be browsed. For a dump file that contains multiple heap dumps, you may specify which dump in the file by appending "#<number> to the file name, i.e. "foo.hprof#3". -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jhat\fP command parses a java heap dump file and launches a webserver. jhat enables you to browse heap dumps using your favorite webbrowser. jhat supports pre\-designed queries (such as 'show all instances of a known class "Foo"') as well as \f3OQL\fP (\f3O\fPbject \f3Q\fPuery \f3L\fPanguage) \- a SQL\-like query language to query heap dumps. Help on OQL is available from the OQL help page shown by jhat. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ -.LP -.LP -There are several ways to generate a java heap dump: -.LP -.RS 3 -.TP 2 -o -Use jmap(1) \-dump option to obtain a heap dump at runtime; -.TP 2 -o -Use jconsole(1) option to obtain a heap dump via -.na -\f2HotSpotDiagnosticMXBean\fP @ -.fi -http://download.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime; -.TP 2 -o -Heap dump will be generated when OutOfMemoryError is thrown by specifying \-XX:+HeapDumpOnOutOfMemoryError VM option; -.TP 2 -o -Use -.na -\f2hprof\fP @ -.fi -http://java.sun.com/developer/technicalArticles/Programming/HPROF.html. -.RE - -.LP -.LP -\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-stack false/true -Turn off tracking object allocation call stack. Note that if allocation site information is not available in the heap dump, you have to set this flag to false. Default is true. -.TP 3 -\-refs false/true -Turn off tracking of references to objects. Default is true. By default, back pointers (objects pointing to a given object a.k.a referrers or in\-coming references) are calculated for all objects in the heap. -.TP 3 -\-port port\-number -Set the port for the jhat's HTTP server. Default is 7000. -.TP 3 -\-exclude exclude\-file -Specify a file that lists data members that should be excluded from the "reachable objects" query. For example, if the file lists \f2java.lang.String.value\fP, then, whenever list of objects reachable from a specific object "o" are calculated, reference paths involving \f2java.lang.String.value\fP field will not considered. -.TP 3 -\-baseline baseline\-dump\-file -Specify a baseline heap dump. Objects in both heap dumps with the same object ID will be marked as not being "new". Other objects will be marked as "new". This is useful while comparing two different heap dumps. -.TP 3 -\-debug int -Set debug level for this tool. 0 means no debug output. Set higher values for more verbose modes. -.TP 3 -\-version -Report version number and exit. -.TP 3 -\-h -Output help message and exit. -.TP 3 -\-help -Output help message and exit. -.TP 3 -\-J<flag> -Pass <flag> to the Java virtual machine on which jhat is run. For example, \-J\-Xmx512m to use a maximum heap size of 512MB. -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o +\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIheap-dump-file\fR +Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. +.SH DESCRIPTION +The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ +.PP +There are several ways to generate a Java heap dump: +.TP 0.2i +\(bu +Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. +.TP 0.2i +\(bu +Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html +.TP 0.2i +\(bu +Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. +.TP 0.2i +\(bu +Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.SH OPTIONS +.TP +-stack false|true +.br +Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. +.TP +-refs false|true +.br +Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. +.TP +-port \fIport-number\fR +.br +Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. +.TP +-exclude \fIexclude-file\fR +.br +Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. +.TP +-baseline \fIexclude-file\fR +.br +Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. +.TP +-debug \fIint\fR +.br +Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. +.TP +-version +.br +Reports the release number and exits +.TP +-h +.br +Dsiplays a help message and exits\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu jmap(1) -.TP 2 -o +.TP 0.2i +\(bu jconsole(1) -.TP 2 -o -.na -\f2hprof \- Heap and CPU profiling tool\fP @ -.fi -http://java.sun.com/developer/technicalArticles/Programming/HPROF.html -.RE - -.LP - +.TP 0.2i +\(bu +HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jinfo.1 b/jdk/src/bsd/doc/man/jinfo.1 index 974c84637c4..42a5ebd3b18 100644 --- a/jdk/src/bsd/doc/man/jinfo.1 +++ b/jdk/src/bsd/doc/man/jinfo.1 @@ -1,147 +1,133 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jinfo 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jinfo.1 +.\" +.if n .pl 99999 +.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jinfo \- Configuration Info -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jinfo\fP [ option ] pid -.fl -\f3jinfo\fP [ option ] executable core -.fl -\f3jinfo\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi +.SH NAME +jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -option -Options are mutually exclusive. Option, if used, should follow immediately after the command name. -.RE +\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR +.fi +.nf -.LP -.RS 3 -.TP 3 -pid -process id for which the configuration info is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.RE +\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR +.fi +.nf -.LP -.RS 3 -.TP 3 -executable -Java executable from which the core dump was produced. -.RE - -.LP -.RS 3 -.TP 3 -core -core file for which the configuration info is to be printed. -.RE - -.LP -.RS 3 -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. -.RE - -.LP -.RS 3 -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jinfo\fP prints Java configuration information for a given Java process or core file or a remote debug server. Configuration information includes Java System properties and Java virtual machine command line flags. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: +\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoption\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the configuration information is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. +.PP +This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. +.SH OPTIONS +.TP +no-option +Prints both command-line flags and system property name-value pairs\&. +.TP +-flag \fIname\fR .br -jinfo \-J\-d64 \-sysprops pid -.LP -.LP -\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' need to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP -.LP -.LP -\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -<no option> -prints both command line flags as well as System properties name, value pairs. +Prints the name and value of the specified command-line flag\&. +.TP +-flag \fI[+|-]name\fR .br -.TP 3 -\-flag name -prints the name and value of the given command line flag. +enables or disables the specified Boolean command-line flag\&. +.TP +-flag \fIname=value\fR .br -.TP 3 -\-flag [+|\-]name -enables or disables the given boolean command line flag. +Sets the specified command-line flag to the specified value\&. +.TP +-flags .br -.TP 3 -\-flag name=value -sets the given command line flag to the specified value. +Prints command-line flags passed to the JVM\&. +.TP +-sysprops .br -.TP 3 -\-flags -prints command line flags passed to the JVM. pairs. +Prints Java system properties as name-value pairs\&. +.TP +-h .br -.TP 3 -\-sysprops -prints Java System properties as name, value pairs. +Prints a help message\&. +.TP +-help .br -.TP 3 -\-h -prints a help message -.TP 3 -\-help -prints a help message -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o +Prints a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu jps(1) -.TP 2 -o +.TP 0.2i +\(bu jsadebugd(1) -.RE - -.LP - +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jjs.1 b/jdk/src/bsd/doc/man/jjs.1 new file mode 100644 index 00000000000..47b5602ac10 --- /dev/null +++ b/jdk/src/bsd/doc/man/jjs.1 @@ -0,0 +1,352 @@ +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jjs.1 +.\" +.if n .pl 99999 +.TH jjs 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jjs \- Invokes the Nashorn engine\&. +.SH SYNOPSIS +.sp +.nf +\f3\fBjjs\fR [\fIoptions\fR] [\fIscript\-files\fR] [\-\- \fIarguments\fR]\fP +.fi +.sp +.TP +\fIoptions\fR +One or more options of the \f3jjs\fR command, separated by spaces\&. For more information, see Options\&. +.TP +\fIscript-files\fR +One or more script files which you want to interpret using Nashorn, separated by spaces\&. If no files are specified, an interactive shell is started\&. +.TP +\fIarguments\fR +All values after the double hyphen marker (\f3--\fR) are passed through to the script or the interactive shell as arguments\&. These values can be accessed by using the \f3arguments\fR property (see )\&. +.SH DESCRIPTION +The \f3jjs\fR command-line tool is used to invoke the Nashorn engine\&. You can use it to interpret one or several script files, or to run an interactive shell\&. +.SH OPTIONS +The options of the \f3jjs\fR command control the conditions under which scripts are interpreted by Nashorn\&. +.TP +-ccs=\fIsize\fR , --class-cache-size=\fIsize\fR +.br +Sets the class cache size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes (KB), \f3m\fR or \f3M\fR to indicate megabytes (MB), \f3g\fR or \f3G\fR to indicate gigabytes (GB)\&. By default, the class cache size is set to 50 bytes\&. The following example shows how to set it to 1024 bytes (1 KB): +.sp +.nf +\f3\-css=100\fP +.fi +.nf +\f3\-css=1k\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-co, --compile-only +.br +Compiles the script without running it\&. +.TP +-cp \fIpath\fR , --classpath \fIpath\fR +.br +Specifies the path to the supporting class files To set multiple paths, the option can be repeated, or you can separate each path with a colon (:)\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property to be passed to the script by assigning a value to a property name\&. The following example shows how to invoke Nashorn in interactive mode and assign \f3myValue\fR to the property named \f3myKey\fR: +.sp +.nf +\f3>> \fIjjs \-DmyKey=myValue\fR\fP +.fi +.nf +\f3jjs> \fIjava\&.lang\&.System\&.getProperty("myKey")\fR\fP +.fi +.nf +\f3myValue\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This option can be repeated to set multiple properties\&. +.TP +-d=\fIpath\fR , --dump-debug-dir=\fIpath\fR +.br +Specifies the path to the directory where class files are dumped\&. +.TP +--debug-lines +.br +Generates a line number table in the class file\&. By default, this option is enabled\&. To disable it, specify \f3--debug-lines=false\fR\&. +.TP +--debug-locals +.br +Generates a local variable table in the class file\&. +.TP +-doe, --dump-on-error +.br +Provides a full stack trace when an arror occurs\&. By default, only a brief error message is printed\&. +.TP +--early-lvalue-error +.br +Reports invalid lvalue expressions as early errors (that is, when the code is parsed)\&. By default, this option is enabled\&. To disable it, specify \f3--early-lvalue-error=false\fR\&. When disabled, invalid lvalue expressions will not be reported until the code is executed\&. +.TP +--empty-statements +.br +Preserves empty statements in the Java abstract syntax tree\&. +.TP +-fv, --fullversion +.br +Prints the full Nashorn version string\&. +.TP +--function-statement-error +.br +Prints an error message when a function declaration is used as a statement\&. +.TP +--function-statement-warning +.br +Prints a warning message when a function declaration is used as a statement\&. +.TP +-fx +.br +Launches the script as a JavaFX application\&. +.TP +-h, -help +.br +Prints the list of options and their descriptions\&. +.TP +-J\fIoption\fR +.br +Passes the specified \f3java\fR launcher option to the JVM\&. The following example shows how to invoke Nashorn in interactive mode and set the maximum memory used by the JVM to 4 GB: +.sp +.nf +\f3>> \fIjjs \-J\-Xmx4g\fR\fP +.fi +.nf +\f3jjs> \fIjava\&.lang\&.Runtime\&.getRuntime()\&.maxMemory()\fR\fP +.fi +.nf +\f33817799680\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This option can be repeated to pass multiple \f3java\fR command options\&. +.TP +--lazy-compilation +.br +Enables lazy code generation strategies (that is, the entire script is not compiled at once)\&. This option is experimental\&. +.TP +--loader-per-compile +.br +Creates a new class loader per compile\&. By default, this option is enabled\&. To disable it, specify \f3--loader-per-compile=false\fR\&. +.TP +--log=\fIsubsystem\fR:\fIlevel\fR +.br +Performs logging at a given level for the specified subsystems\&. You can specify logging levels for multiple subsystems separating them with commas\&. For example: +.sp +.nf +\f3\-\-log=fields:finest,codegen:info\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +--package=\fIname\fR +.br +Specifies the package to which generated class files are added\&. +.TP +--parse-only +.br +Parses the code without compiling\&. +.TP +--print-ast +.br +Prints the abstract syntax tree\&. +.TP +--print-code +.br +Prints bytecode\&. +.TP +--print-lower-ast +.br +Prints the lowered abstract syntax tree\&. +.TP +--print-lower-parse +.br +Prints the lowered parse tree\&. +.TP +--print-no-newline +.br +Forces other \f3--print*\fR options to print the output on one line\&. +.TP +--print-parse +.br +Prints the parse tree\&. +.TP +--print-symbols +.br +Prints the symbol table\&. +.TP +-pcs, --profile-callsites +.br +Dumps callsite profile data\&. +.TP +-scripting +.br +Enables shell scripting features\&. +.TP +--stderr=\fIfilename\fR|\fIstream\fR|\fItty\fR +.br +Redirects the standard error stream to the specified file, stream (for example, to \f3stdout\fR), or text terminal\&. +.TP +--stdout=\fIfilename\fR|\fIstream\fR|\fItty\fR +.br +Redirects the standard output stream to the specified file, stream (for example, to \f3stderr\fR), or text terminal\&. +.TP +-strict +.br +Enables strict mode, which enforces stronger adherence to the standard (ECMAScript Edition 5\&.1), making it easier to detect common coding errors\&. +.TP +-t=\fIzone\fR , -timezone=\fIzone\fR +.br +Sets the specified time zone for script execution\&. It overrides the time zone set in the OS and used by the \f3Date\fR object\&. +.TP +-tcs=\fIparameter\fR , --trace-callsites=\fIparameter\fR +.br +Enables callsite trace mode\&. Possible parameters are the following: +.RS +.TP +miss +Trace callsite misses\&. +.TP +enterexit +Trace callsite enter/exit\&. +.TP +objects +Print object properties\&. +.RE + +.TP +--verify-code +.br +Verifies bytecode before running\&. +.TP +-v, -version +.br +Prints the Nashorn version string\&. +.TP +-xhelp +.br +Prints extended help for command-line options\&. +.SH EXAMPLES +\f3Example 1 Running a Script with Nashorn\fR +.sp +.nf +\f3jjs script\&.js\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Running Nashorn in Interactive Mode\fR +.sp +.nf +\f3>> \fIjjs\fR\fP +.fi +.nf +\f3jjs> \fIprintln("Hello, World!")\fR\fP +.fi +.nf +\f3Hello, World!\fP +.fi +.nf +\f3jjs> \fIquit()\fR\fP +.fi +.nf +\f3>>\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Passing Arguments to Nashorn\fR +.sp +.nf +\f3>> \fIjjs \-\- a b c\fR\fP +.fi +.nf +\f3jjs> \fIarguments\&.join(", ")\fR\fP +.fi +.nf +\f3a, b, c\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp +.SH SEE\ ALSO +\f3jrunscript\fR +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jmap.1 b/jdk/src/bsd/doc/man/jmap.1 index 9bba65ba23d..cada22c54fd 100644 --- a/jdk/src/bsd/doc/man/jmap.1 +++ b/jdk/src/bsd/doc/man/jmap.1 @@ -1,160 +1,144 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jmap 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jmap.1 +.\" +.if n .pl 99999 +.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jmap \- Memory Map -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jmap\fP [ option ] pid -.fl -\f3jmap\fP [ option ] executable core -.fl -\f3jmap\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi +.SH NAME +jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -option -Options are mutually exclusive. Option, if used, should follow immediately after the command name. -.TP 3 -pid -process id for which the memory map is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.br -.TP 3 -executable -Java executable from which the core dump was produced. -.br -.TP 3 -core -core file for which the memory map is to be printed. -.br -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. -.br -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.br -.RE +\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jmap\fP prints shared object memory maps or heap memory details of a given process or core file or a remote debug server. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: -.LP -.nf -\f3 -.fl -jmap \-J\-d64 \-heap pid -.fl -\fP -.fi +\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf -.LP -.LP -\f3NOTE: This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP -.LP -.LP -\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.br - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 +\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the memory map is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH OPTIONS +.TP <no option> -When no option is used jmap prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility. +When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. +.TP +-dump:[live,] format=b, file=\fIfilename\fR .br -.TP 3 -\-dump:[live,]format=b,file=<filename> -Dumps the Java heap in hprof binary format to filename. The \f2live\fP suboption is optional. If specified, only the live objects in the heap are dumped. To browse the heap dump, you can use jhat(1) (Java Heap Analysis Tool) to read the generated file. +Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. +.TP +-finalizerinfo .br -.TP 3 -\-finalizerinfo -Prints information on objects awaiting finalization. +Prints information about objects that are awaiting finalization\&. +.TP +-heap .br -.TP 3 -\-heap -Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed. +Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. +.TP +-histo[:live] .br -.TP 3 -\-histo[:live] -Prints a histogram of the heap. For each Java class, number of objects, memory size in bytes, and fully qualified class names are printed. VM internal class names are printed with '*' prefix. If the \f2live\fP suboption is specified, only live objects are counted. +Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. +.TP +-clstats .br -.TP 3 -\-permstat -Prints class loader wise statistics of permanent generation of Java heap. For each class loader, its name, liveness, address, parent class loader, and the number and size of classes it has loaded are printed. In addition, the number and size of interned Strings are printed. +Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. +.TP +-F .br -.TP 3 -\-F -Force. Use with jmap \-dump or jmap \-histo option if the pid does not respond. The \f2live\fP suboption is not supported in this mode. +Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. +.TP +-h .br -.TP 3 -\-h -Prints a help message. +Prints a help message\&. +.TP +-help .br +Prints a help message\&. +.TP +-J\fIflag\fR .br -.TP 3 -\-help -Prints a help message. -.br -.br -.TP 3 -\-J<flag> -Passes <flag> to the Java virtual machine on which jmap is run. -.br -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -pmap(1) -.TP 2 -o +Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu jhat(1) -.TP 2 -o +.TP 0.2i +\(bu jps(1) -.TP 2 -o +.TP 0.2i +\(bu jsadebugd(1) -.RE - -.LP - +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jps.1 b/jdk/src/bsd/doc/man/jps.1 index 38995a8b608..f03c31d9755 100644 --- a/jdk/src/bsd/doc/man/jps.1 +++ b/jdk/src/bsd/doc/man/jps.1 @@ -1,250 +1,205 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jps 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jps.1 +.\" +.if n .pl 99999 +.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jps \- Java Virtual Machine Process Status Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jps\fP [ \f2options\fP ] [ \f2hostid\fP ] +.SH NAME +jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIhostid\fR +The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. +.SH DESCRIPTION +The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. +.PP +If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. +.PP +The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. +.PP +The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. +.PP +The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. +.SH OPTIONS +The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. +.TP +-q .br - -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -hostid -The host identifier of the host for which the process report should be generated. The \f2hostid\fP may include optional components that indicate the communications protocol, port number, and other implementation specific data. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jps\fP tool lists the instrumented HotSpot Java Virtual Machines (JVMs) on the target system. The tool is limited to reporting information on JVMs for which it has the access permissions. -.LP -.LP -If \f3jps\fP is run without specifying a \f2hostid\fP, it will look for instrumented JVMs on the local host. If started with a \f2hostid\fP, it will look for JVMs on the indicated host, using the specified protocol and port. A \f3jstatd\fP process is assumed to be running on the target host. -.LP -.LP -The \f3jps\fP command will report the local VM identifier, or \f2lvmid\fP, for each instrumented JVM found on the target system. The \f3lvmid\fP is typically, but not necessarily, the operating system's process identifier for the JVM process. With no options, \f3jps\fP will list each Java application's \f2lvmid\fP followed by the short form of the application's class name or jar file name. The short form of the class name or JAR file name omits the class's package information or the JAR files path information. -.LP -.LP -The \f3jps\fP command uses the \f3java\fP launcher to find the class name and arguments passed to the \f2main\fP method. If the target JVM is started with a custom launcher, the class name (or JAR file name) and the arguments to the \f2main\fP method will not be available. In this case, the \f3jps\fP command will output the string \f2Unknown\fP for the class name or JAR file name and for the arguments to the main method. -.LP -.LP -The list of JVMs produced by the \f3jps\fP command may be limited by the permissions granted to the principal running the command. The command will only list the JVMs for which the principle has access rights as determined by operating system specific access control mechanisms. -.LP -.LP -\f3NOTE:\fP This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME platforms. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jps\fP command supports a number of options that modify the output of the command. These options are subject to change or removal in the future. -.LP -.RS 3 -.TP 3 -\-q -Suppress the output of the class name, JAR file name, and arguments passed to the \f2main\fP method, producing only a list of local VM identifiers. -.TP 3 -\-m -Output the arguments passed to the main method. The output may be null for embedded JVMs. -.TP 3 -\-l -Output the full package name for the application's main class or the full path name to the application's JAR file. -.TP 3 -\-v -Output the arguments passed to the JVM. -.TP 3 -\-V -Output the arguments passed to the JVM through the flags file (the .hotspotrc file or the file specified by the \-XX:Flags=<\f2filename\fP> argument). -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3jps\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.RE - -.LP -.SS -HOST IDENTIFIER -.LP -.LP -The host identifier, or \f2hostid\fP is a string that indicates the target system. The syntax of the \f2hostid\fP string largely corresponds to the syntax of a URI: -.LP -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][[//]\fP\f4hostname\fP\f3][:\fP\f4port\fP\f3][/\fP\f4servername\fP\f3]\fP +Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. +.TP +-m .br -\f3 -.fl -\fP -.fi - -.LP -.RS 3 -.TP 3 -protocol -The communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific, optimized, local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP. -.TP 3 +Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. +.TP +-l +.br +Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. +.TP +-v +.br +Displays the arguments passed to the JVM\&. +.TP +-V +.br +Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. +.TP +-J\f3option\fR +.br +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH HOST\ IDENTIFIER +The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][[//]hostname][:port][/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP hostname -A hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host. -.TP 3 +A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. +.TP port -The default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used. -.TP 3 +The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP servername -The treatment of this parameter depends on the implementation. For the optimized, local protocol, this field is ignored. For the \f3rmi\fP protocol, this parameter is a string representing the name of the RMI remote object on the remote host. See the \f3\-n\fP option for the jstatd(1) command. -.RE - -.LP -.SH "OUTPUT FORMAT" -.LP -.LP -The output of the \f3jps\fP command follows the following pattern: -.LP -.nf -\f3 -.fl -\fP\f4lvmid\fP\f3 [ [ \fP\f4classname\fP\f3 | \fP\f4JARfilename\fP\f3 | "Unknown"] [ \fP\f4arg\fP\f3* ] [ \fP\f4jvmarg\fP\f3* ] ]\fP -.br -\f3 -.fl -\fP -.fi - -.LP -.LP -Where all output tokens are separated by white space. An \f2arg\fP that includes embedded white space will introduce ambiguity when attempting to map arguments to their actual positional parameters. -.br -.br -\f3NOTE\fP: You are advised not to write scripts to parse \f3jps\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jps\fP output, expect to modify them for future releases of this tool. -.br - -.LP -.SH "EXAMPLES" -.LP -.LP -This section provides examples of the \f3jps\fP command. -.LP -.LP -Listing the instrumented JVMs on the local host: -.LP -.nf -\f3 -.fl -\fP\f3jps\fP -.br - -.fl -18027 Java2Demo.JAR -.br - -.fl -18032 jps -.br - -.fl -18005 jstat -.br - -.fl -.fi - -.LP -.LP -Listing the instrumented JVMs on a remote host: -.LP -.LP -This example assumes that the \f3jstat\fP server and either the its internal RMI registry or a separate external \f3rmiregistry\fP process are running on the remote host on the default port (port 1099). It also assumes that the local host has appropriate permissions to access the remote host. This example also includes the \f2\-l\fP option to output the long form of the class names or JAR file names. -.LP -.nf -\f3 -.fl -\fP\f3jps \-l remote.domain\fP -.br - -.fl -3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR -.br - -.fl -2857 sun.tools.jstatd.jstatd -.br - -.fl -.fi - -.LP -.LP -Listing the instrumented JVMs on a remote host with a non\-default port for the RMI registry -.LP -.LP -This example assumes that the \f3jstatd\fP server, with an internal RMI registry bound to port 2002, is running on the remote host. This example also uses the \f2\-m\fP option to include the arguments passed to the \f2main\fP method of each of the listed Java applications. -.LP -.nf -\f3 -.fl -\fP\f3jps \-m remote.domain:2002\fP -.br - -.fl -3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR -.br - -.fl -3102 sun.tools.jstatd.jstatd \-p 2002 -.fl -.fi - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jstat(1) \- the Java virtual machine Statistics Monitoring Tool -.TP 2 -o -jstatd(1) \- the jstat daemon -.TP 2 -o -rmiregistry(1) \- the Java Remote Object Registry -.RE - -.LP - +The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. +.SH OUTPUT\ FORMAT +The output of the \f3jps\fR command follows the following pattern: +.sp +.nf +\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP +.fi +.nf +\f3\fP +.fi +.sp +All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. +.PP +\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. +.SH EXAMPLES +This section provides examples of the \f3jps\fR command\&. +.PP +List the instrumented JVMs on the local host: +.sp +.nf +\f3jps\fP +.fi +.nf +\f318027 Java2Demo\&.JAR\fP +.fi +.nf +\f318032 jps\fP +.fi +.nf +\f318005 jstat\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. +.sp +.nf +\f3jps \-l remote\&.domain\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f32857 sun\&.tools\&.jstatd\&.jstatd\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. +.sp +.nf +\f3jps \-m remote\&.domain:2002\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jrunscript.1 b/jdk/src/bsd/doc/man/jrunscript.1 index f9fac184325..981be31bf1a 100644 --- a/jdk/src/bsd/doc/man/jrunscript.1 +++ b/jdk/src/bsd/doc/man/jrunscript.1 @@ -1,187 +1,196 @@ -." Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jrunscript 1 "10 May 2011" +'\" t +.\" Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Scripting Tools +.\" Title: jrunscript.1 +.\" +.if n .pl 99999 +.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jrunscript \- command line script shell -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jrunscript\fP [ \f2options\fP ] [ arguments... ] -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -arguments -Arguments, if used, should follow immediately after options or command name. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jrunscript\fP is a command line script shell. jrunscript supports both an interactive (read\-eval\-print) mode and a batch (\-f option) mode of script execution. This is a scripting language independent shell. By default, JavaScript is the language used, but the \-l option can be used to specify a different language. Through Java to scripting language communication, jrunscript supports "exploratory programming" style. -.LP -.LP -\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-classpath path -Specify where to find the user's .class files that are accessed by the script. -.TP 3 -\-cp path -This is a synonym for \-classpath \f2path\fP -.TP 3 -\-Dname=value -Set a Java system property. -.TP 3 -\-J<flag> -Pass <flag> directly to the Java virtual machine on which jrunscript is run. -.TP 3 -\-l language -Use the specified scripting language. By default, JavaScript is used. Note that to use other scripting languages, you also need to specify the corresponding script engine's jar file using \-cp or \-classpath option. -.TP 3 -\-e script -Evaluate the given script. This option can be used to run "one liner" scripts specified completely on the command line. -.TP 3 -\-encoding encoding -Specify the character encoding used while reading script files. -.TP 3 -\-f script\-file -Evaluate the given script file (batch mode). -.TP 3 -\-f \- -Read and evaluate a script from standard input (interactive mode). -.TP 3 -\-help\ -Output help message and exit. -.TP 3 -\-?\ -Output help message and exit. -.TP 3 -\-q\ -List all script engines available and exit. -.RE - -.LP -.SH "ARGUMENTS" -.LP -.LP -If [arguments...] are present and if no \f3\-e\fP or \f3\-f\fP option is used, then the first argument is the script file and the rest of the arguments, if any, are passed as script arguments. If [arguments..] and \f3\-e\fP or \f3\-f\fP option are used, then all [arguments..] are passed as script arguments. If [arguments..], \f3\-e\fP and \f3\-f\fP are missing, interactive mode is used. Script arguments are available to a script in an engine variable named "arguments" of type String array. -.LP -.SH "EXAMPLES" -.LP -.SS -Executing inline scripts -.LP -.nf -\f3 -.fl -jrunscript \-e "print('hello world')" -.fl -jrunscript \-e "cat('http://java.sun.com')" -.fl -\fP -.fi - -.LP -.SS -Use specified language and evaluate given script file -.LP -.nf -\f3 -.fl -jrunscript \-l js \-f test.js -.fl -\fP -.fi - -.LP -.SS -Interactive mode -.LP -.nf -\f3 -.fl -jrunscript -.fl -js> print('Hello World\\n'); -.fl -Hello World -.fl -js> 34 + 55 -.fl -89.0 -.fl -js> t = new java.lang.Thread(function() { print('Hello World\\n'); }) -.fl -Thread[Thread\-0,5,main] -.fl -js> t.start() -.fl -js> Hello World -.fl - -.fl -js> -.fl -\fP -.fi - -.LP -.SS -Run script file with script arguments -.LP -.nf -\f3 -.fl -jrunscript test.js arg1 arg2 arg3 -.fl -\fP -.fi - -.LP -test.js is script file to execute and arg1, arg2 and arg3 are passed to script as script arguments. Script can access these using "arguments" array. -.SH "SEE ALSO" -.LP -.LP -If JavaScript is used, then before evaluating any user defined script, jrunscript initializes certain built\-in functions and objects. These JavaScript built\-ins are documented in -.na -\f2jsdocs\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/share/jsdocs/allclasses\-noframe.html. -.LP +.SH NAME +jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf +\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIarguments\fR +Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. +.SH DESCRIPTION +The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +Indicate where any class files are that the script needs to access\&. +.TP +-cp \fIpath\fR +.br +Same as \f3-classpath\fR\f3path\fR\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a Java system property\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. +.TP +-I \fIlanguage\fR +.br +Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. +.TP +-e \fIscript\fR +.br +Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the character encoding used to read script files\&. +.TP +-f \fIscript-file\fR +.br +Evaluates the specified script file (batch mode)\&. +.TP +-f - +.br +Reads and evaluates a script from standard input (interactive mode)\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-? +.br +Displays a help message and exits\&. +.TP +-q +.br +Lists all script engines available and exits\&. +.SH ARGUMENTS +If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. +.SH EXAMPLES +.SS EXECUTE\ INLINE\ SCRIPTS +.sp +.nf +\f3jrunscript \-e "print(\&'hello world\&')"\fP +.fi +.nf +\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE +.sp +.nf +\f3jrunscript \-l js \-f test\&.js\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INTERACTIVE\ MODE +.sp +.nf +\f3jrunscript\fP +.fi +.nf +\f3js> print(\&'Hello World\en\&');\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3js> 34 + 55\fP +.fi +.nf +\f389\&.0\fP +.fi +.nf +\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP +.fi +.nf +\f3Thread[Thread\-0,5,main]\fP +.fi +.nf +\f3js> t\&.start()\fP +.fi +.nf +\f3js> Hello World\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3js>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS +The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. +.sp +.nf +\f3jrunscript test\&.js arg1 arg2 arg3\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jsadebugd.1 b/jdk/src/bsd/doc/man/jsadebugd.1 index 8648e74d9f6..a559377caff 100644 --- a/jdk/src/bsd/doc/man/jsadebugd.1 +++ b/jdk/src/bsd/doc/man/jsadebugd.1 @@ -1,109 +1,109 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jsadebugd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jsadebugd.1 +.\" +.if n .pl 99999 +.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jsadebugd \- Serviceability Agent Debug Daemon -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jsadebugd\fP pid [ server\-id ] -.fl -\f3jsadebugd\fP executable core [ server\-id ] -.fl -.fi +.SH NAME +jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -pid -process id of the process to which the debug server should attach. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. At most one instance of the debug server may be attached to a single process. -.TP 3 -executable -Java executable from which the core dump was produced -.TP 3 -core -Core file to which the debug server should attach. -.TP 3 -server\-id -Optional unique id, needed if multiple debug servers are started on the same machine. This ID must be used by remote clients to identify the particular debug server to attach. Within a single machine, this ID must be unique. -.RE +\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] +.fi +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jsadebugd\fP attaches to a Java process or core file and acts as a debug server. Remote clients such as jstack(1), jmap(1), and jinfo(1) can attach to the server using Java Remote Method Invocation (RMI). Before starting \f2jsadebugd\fP, -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi must be started with: -.LP -.nf -\f3 -.fl -\fP\f4rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi.jar\fP\f3 -.fl -\fP -.fi - -.LP -.LP -where \f2$JAVA_HOME\fP is the JDK installation directory. If rmiregistry was not started, jsadebugd will start an rmiregistry in a standard (1099) port internally. Debug server may be stopped by sending SIGINT (pressing Ctrl\-C) to it. -.LP -.LP -\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced. -.LP -.LP -For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o +\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] +.fi +.sp +.TP +\fIpid\fR +The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file to which the debug server should attach\&. +.TP +\fIserver-id\fR +An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. +.SH DESCRIPTION +The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: +.sp +.nf +\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. +.PP +\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu jinfo(1) -.TP 2 -o +.TP 0.2i +\(bu jmap(1) -.TP 2 -o +.TP 0.2i +\(bu jps(1) -.TP 2 -o +.TP 0.2i +\(bu jstack(1) -.TP 2 -o -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi -.RE - -.LP - +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jstack.1 b/jdk/src/bsd/doc/man/jstack.1 index b22cade8d9b..e91f2ef0bbe 100644 --- a/jdk/src/bsd/doc/man/jstack.1 +++ b/jdk/src/bsd/doc/man/jstack.1 @@ -1,148 +1,138 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstack 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jstack.1 +.\" +.if n .pl 99999 +.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstack \- Stack Trace -.br +.SH NAME +jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jstack\fP [ option ] pid -.fl -\f3jstack\fP [ option ] executable core -.fl -\f3jstack\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi +\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf -.LP -.SH "PARAMETERS" -.LP -.LP -Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS. -.LP -.RS 3 -.TP 3 -pid -process id for which the stack trace is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.RE +\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf -.LP -.RS 3 -.TP 3 -executable -Java executable from which the core dump was produced. +\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the stack trace is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: +.sp +.nf +\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-F .br -.TP 3 -core -core file for which the stack trace is to be printed. +Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. +.TP +-l .br -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. +Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html +.TP +-m .br -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jstack\fP prints Java stack traces of Java threads for a given Java process or core file or a remote debug server. For each Java frame, the full class name, method name, 'bci' (byte code index) and line number, if available, are printed. With the \-m option, jstack prints both Java and native frames of all threads along with the 'pc' (program counter). For each native frame, the closest native symbol to 'pc', if available, is printed. C++ mangled names are not demangled. To demangle C++ names, the output of this command may be piped to \f3c++filt\fP. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: +Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. +.TP +-h .br - -.LP -.nf -\f3 -.fl -jstack \-J\-d64 \-m pid -.fl -\fP -.fi - -.LP -.LP -\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced. -.LP -.LP -For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-F -Force a stack dump when 'jstack [\-l] pid' does not respond. -.TP 3 -\-l -Long listing. Prints additional information about locks such as list of owned java.util.concurrent -.na -\f2ownable synchronizers\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html. -.TP 3 -\-m -prints mixed mode (both Java and native C/C++ frames) stack trace. -.TP 3 -\-h -prints a help message. +Prints a help message\&. +.TP +-help .br -.br -.TP 3 -\-help -prints a help message -.br -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o +Prints a help message\&. +.SH KNOWN\ BUGS +In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu pstack(1) -.TP 2 -o -c++filt(1) -.TP 2 -o +.TP 0.2i +\(bu +C++filt(1) +.TP 0.2i +\(bu jps(1) -.TP 2 -o +.TP 0.2i +\(bu jsadebugd(1) -.RE - -.LP -.SH "KNOWN BUGS" -.LP -.LP -Mixed mode stack trace, the \-m option, does not work with the remote debug server. -.LP - +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jstat.1 b/jdk/src/bsd/doc/man/jstat.1 index 9c6fe7b536d..405df264980 100644 --- a/jdk/src/bsd/doc/man/jstat.1 +++ b/jdk/src/bsd/doc/man/jstat.1 @@ -1,5329 +1,568 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstat 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 10 May 2011 +.\" SectDesc: Monitoring Tools +.\" Title: jstat.1 +.\" +.if n .pl 99999 +.TH jstat 1 "10 May 2011" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstat \- Java Virtual Machine Statistics Monitoring Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jstat\fP [ \f2generalOption\fP | \f2outputOptions\fP \f2vmid\fP [\f2interval\fP[s|ms] [\f2count\fP]] ] -.fl -.fi +.SH NAME +jstat \- Monitors Java Virtual Machine (JVM) statistics\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -generalOption -A single general command\-line option (\-help, \-options, or \-version) -.TP 3 -outputOptions -One or more output options, consisting of a single \f2statOption\fP, plus any of the \-t, \-h, and \-J options. -.TP 3 -vmid -Virtual machine identifier, a string indicating the target Java virtual machine (JVM). The general syntax is -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][//]\fP\f4lvmid\fP[@\f2hostname\fP[:\f2port\fP]/\f2servername\fP] -.fl -.fi -The syntax of the vmid string largely corresponds to the syntax of a URI. The \f2vmid\fP can vary from a simple integer representing a local JVM to a more complex construction specifying a communications protocol, port number, and other implementation\-specific values. See Virtual Machine Identifier for details. -.TP 3 -interval[s|ms] -Sampling interval in the specified units, seconds (s) or milliseconds (ms). Default units are milliseconds. Must be a positive integer. If specified, \f3jstat\fP will produce its output at each interval. -.TP 3 -count -Number of samples to display. Default value is infinity; that is, \f3jstat\fP displays statistics until the target JVM terminates or the \f3jstat\fP command is terminated. Must be a positive integer. -.RE +\fBjstat\fR [ \fIgeneralOption\fR | \fIoutputOptions vmid\fR [ \fIinterval\fR[s|ms] [ \fIcount \fR] ] +.fi +.sp +.TP +\fIgeneralOption\fR +A single general command-line option \f3-help\fR or \f3-options\fR\&. See General Options\&. +.TP +\fIoutputOptions\fR +One or more output options that consist of a single \f3statOption\fR, plus any of the \f3-t\fR, \f3-h\fR, and \f3-J\fR options\&. See Output Options\&. +.TP +\fIvmid\fR +Virtual machine identifier, which is a string that indicates the target JVM\&. The general syntax is the following: +.sp +.nf +\f3[protocol:][//]lvmid[@hostname[:port]/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jstat\fP tool displays performance statistics for an instrumented HotSpot Java virtual machine (JVM). The target JVM is identified by its virtual machine identifier, or \f2vmid\fP option described below. -.LP -.LP -\f3NOTE\fP: This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME. platforms. -.br -.LP -.SS -VIRTUAL MACHINE IDENTIFIER -.LP -.LP -The syntax of the \f2vmid\fP string largely corresponds to the syntax of a URI: -.LP -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][//]\fP\f4lvmid\fP[@\f2hostname\fP][:\f2port\fP][/\f2servername\fP] -.fl -.fi +The syntax of the \f3vmid\fR string corresponds to the syntax of a URI\&. The \f3vmid\fR string can vary from a simple integer that represents a local JVM to a more complex construction that specifies a communications protocol, port number, and other implementation-specific values\&. See Virtual Machine Identifier\&. +.TP +\fIinterval\fR [s|ms] +Sampling interval in the specified units, seconds (s) or milliseconds (ms)\&. Default units are milliseconds\&. Must be a positive integer\&. When specified, the \f3jstat\fR command produces its output at each interval\&. +.TP +\fIcount\fR +Number of samples to display\&. The default value is infinity which causes the \f3jstat\fR command to display statistics until the target JVM terminates or the \f3jstat\fR command is terminated\&. This value must be a positive integer\&. +.SH DESCRIPTION +The \f3jstat\fR command displays performance statistics for an instrumented Java HotSpot VM\&. The target JVM is identified by its virtual machine identifier, or \f3vmid\fR option\&. +.SH VIRTUAL\ MACHINE\ IDENTIFIER +The syntax of the \f3vmid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][//]lvmid[@hostname[:port]/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \fIprotocol\fR value is omitted and a host name is not specified, then the default protocol is a platform-specific optimized local protocol\&. If the \fIprotocol\fR value is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +\fIlvmid\fR +The local virtual machine identifier for the target JVM\&. The \f3lvmid\fR is a platform-specific value that uniquely identifies a JVM on a system\&. The \f3lvmid\fR is the only required component of a virtual machine identifier\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the target JVM process\&. You can use the \f3jps\fR command to determine the \f3lvmid\fR\&. Also, you can determine the \f3lvmid\fR on UNIX platforms with the \f3ps\fR command, and on Windows with the Windows Task Manager\&. +.TP +\fIhostname\fR +A hostname or IP address that indicates the target host\&. If the \fIhostname\fR value is omitted, then the target host is the local host\&. +.TP +\fIport\fR +The default port for communicating with the remote server\&. If the \fIhostname\fR value is omitted or the \fIprotocol\fR value specifies an optimized, local protocol, then the \fIport\fR value is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation-specific\&. For the default \f3rmi\fR protocol, the port value indicates the port number for the rmiregistry on the remote host\&. If the \fIport\fR value is omitted and the \fIprotocol\fR value indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +\fIservername\fR +The treatment of the \f3servername\fR parameter depends on implementation\&. For the optimized local protocol, this field is ignored\&. For the \f3rmi\fR protocol, it represents the name of the RMI remote object on the remote host\&. +.SH OPTIONS +The \f3jstat\fR command supports two types of options, general options and output options\&. General options cause the \f3jstat\fR command to display simple usage and version information\&. Output options determine the content and format of the statistical output\&. +.PP +All options and their functionality are subject to change or removal in future releases\&. +.SS GENERAL\ OPTIONS +If you specify one of the general options, then you cannot specify any other option or parameter\&. +.TP +-help +.br +Displays a help message\&. +.TP +-options +.br +Displays a list of static options\&. See Output Options\&. +.SS OUTPUT\ OPTIONS +If you do not specify a general option, then you can specify output options\&. Output options determine the content and format of the \f3jstat\fR command\&'s output, and consist of a single \f3statOption\fR, plus any of the other output options (\f3-h\fR, \f3-t\fR, and \f3-J\fR)\&. The \f3statOption\fR must come first\&. +.PP +Output is formatted as a table, with columns that are separated by spaces\&. A header row with titles describes the columns\&. Use the \f3-h\fR option to set the frequency at which the header is displayed\&. Column header names are consistent among the different options\&. In general, if two options provide a column with the same name, then the data source for the two columns is the same\&. +.PP +Use the \f3-t\fR option to display a time stamp column, labeled Timestamp as the first column of output\&. The Timestamp column contains the elapsed time, in seconds, since the target JVM started\&. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems\&. +.PP +Use the interval and count parameters to determine how frequently and how many times, respectively, the \f3jstat\fR command displays its output\&. +.PP +\fINote:\fR Do not to write scripts to parse the \f3jstat\fR command\&'s output because the format might change in future releases\&. If you write scripts that parse \f3jstat\fR command output, then expect to modify them for future releases of this tool\&. +.TP +-\fIstatOption\fR +.br +Determines the statistics information the \f3jstat\fR command displays\&. The following lists the available options\&. Use the \f3-options\fR general option to display the list of options for a particular platform installation\&. See Stat Options and Output\&. -.LP -.RS 3 -.TP 3 -protocol -The communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific optimized local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP. -.TP 3 -lvmid -The local virtual machine identifier for the target JVM. The \f2lvmid\fP is a platform\-specific value that uniquely identifies a JVM on a system. The \f2lvmid\fP is the only required component of a virtual machine identifier. The \f2lvmid\fP is typically, but not necessarily, the operating system's process identifier for the target JVM process. You can use the jps(1) command to determine the \f2lvmid\fP. Also, you can determine \f2lvmid\fP on Unix platforms with the \f3ps\fP command, and on Windows with the Windows Task Manager. -.TP 3 -hostname -A hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host. -.TP 3 -port -The default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol, the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used. -.TP 3 -servername -The treatment of this parameter depends on implementation. For the optimized local protocol, this field is ignored. For the \f3rmi\fP protocol, it represents the name of the RMI remote object on the remote host. -.RE +\f3class\fR: Displays statistics about the behavior of the class loader\&. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jstat\fP command supports two types of options, general options and output options. General options cause \f3jstat\fP to display simple usage and version information. Output options determine the content and format of the statistical output. -.br +\f3compiler\fR: Displays statistics about the behavior of the Java HotSpot VM Just-in-Time compiler\&. -.LP -.LP -\f3NOTE\fP: All options, and their functionality are subject to change or removal in future releases. -.LP -.SS -GENERAL OPTIONS -.LP -.LP -If you specify one of the general options, you cannot specify any other option or parameter. -.LP -.RS 3 -.TP 3 -\-help -Display help message. -.TP 3 -\-version -Display version information. -.TP 3 -\-options -Display list of statistics options. See the Output Options section below. -.RE +\f3gc\fR: Displays statistics about the behavior of the garbage collected heap\&. -.LP -.SS -OUTPUT OPTIONS -.LP -.LP -If you do not specify a general option, then you can specify output options. Output options determine the content and format of \f3jstat\fP's output, and consist of a single \f2statOption\fP, plus any of the other output options (\-h, \-t, and \-J). The \f2statOption\fP must come first. -.LP -.LP -Output is formatted as a table, with columns are separated by spaces. A header row with titles describes the columns. Use the \f3\-h\fP option to set the frequency at which the header is displayed. Column header names are generally consistent between the different options. In general, if two options provide a column with the same name, then the data source for the two columns are the same. -.LP -.LP -Use the \f3\-t\fP option to display a time stamp column, labeled \f2Timestamp\fP as the first column of output. The \f2Timestamp\fP column contains the elapsed time, in seconds, since startup of the target JVM. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems. -.LP -.LP -Use the \f2interval\fP and \f2count\fP parameters to determine how frequently and how many times, respectively, \f3jstat\fP displays its output. -.LP -.LP -\f3NOTE\fP: You are advised not to write scripts to parse \f3jstat's\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jstat\fP output, expect to modify them for future releases of this tool. -.LP -.RS 3 -.TP 3 -\-statOption -Determines the statistics information that \f3jstat\fP displays. The following table lists the available options. Use the \f3\-options\fP general option to display the list of options for a particular platform installation. -.br -.br -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics on the behavior of the class loader. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the HotSpot Just\-in\-Time compiler. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the garbage collected heap. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the capacities of the generations and their corresponding spaces. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Summary of garbage collection statistics (same as \f3\-gcutil\fP), with the cause of the last and current (if applicable) garbage collection events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the new generation. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the new generations and its corresponding spaces. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the old and permanent generations. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the old generation. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the permanent generation. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Summary of garbage collection statistics. -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -HotSpot compilation method statistics. -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wclass -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wcompiler -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgc -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgccapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgccause -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcnew -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcnewcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcold -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcoldcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcpermcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcutil -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wprintcompilation -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Displays...\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 215 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Displays...\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'class\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'compiler\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gc\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gccapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gccause\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcnew\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcnewcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcold\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcoldcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcpermcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcutil\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'printcompilation\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-52 -.TP 3 -\-h n -Display a column header every \f2n\fP samples (output rows), where \f2n\fP is a positive integer. Default value is 0, which displays the column header above the first row of data. -.TP 3 -\-t n -Display a timestamp column as the first column of output. The timestamp is the time since the start time of the target JVM. -.TP 3 -\-JjavaOption -Pass \f2javaOption\fP to the \f3java\fP application launcher. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. For a complete list of options, see java(1) -.RE +\f3gccapacity\fR: Displays statistics about the capacities of the generations and their corresponding spaces\&. -.LP -.SS -STATOPTIONS AND OUTPUT -.LP -.LP -The following tables summarize the columns that \f3jstat\fP outputs for each \f2statOption\fP. -.br +\f3gccause\fR: Displays a summary about garbage collection statistics (same as \f3-gcutil\fR), with the cause of the last and current (when applicable) garbage collection events\&. -.LP -.SS -\-class Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of classes unloaded. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of Kbytes unloaded. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Time spent performing class load and unload operations. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wClass Loader Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wLoaded -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBytes -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wUnloaded -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBytes -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTime -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of classes loaded. -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Kbytes loaded. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 261 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Class Loader Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Loaded\h'|\n(41u'Number of classes loaded. -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Bytes\h'|\n(41u'Number of Kbytes loaded. -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Unloaded\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Bytes\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Time\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-21 +\f3gcnew\fR: Displays statistics of the behavior of the new generation\&. -.LP -.SS -\-compiler Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks performed. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks that failed. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks that were invalidated. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Time spent performing compilation tasks. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Compile type of the last failed compilation. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Class name and method for the last failed compilation. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wHotSpot Just\-In\-Time Compiler Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wCompiled -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailed -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wInvalid -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTime -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailedType -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailedMethod -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 297 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'HotSpot Just\-In\-Time Compiler Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Compiled\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Failed\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Invalid\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Time\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FailedType\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FailedMethod\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-29 +\f3gcnewcapacity\fR: Displays statistics about the sizes of the new generations and its corresponding spaces\&. -.LP -.SS -\-gc Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Old space utilization (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization (KB). -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC Events. -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wGarbage\-collected heap statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 367 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Garbage\-collected heap statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(m|u+\n(.Vu -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-63 +\f3gcold\fR: Displays statistics about the behavior of the old generation and Metaspace Statistics\&. -.LP -.SS -\-gccapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum new generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum new generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current new generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum old generation capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum old generation capacity (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old generation capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum permanent generation capacity (KB). -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum Permanent generation capacity (KB). -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current Permanent generation capacity (KB). -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current Permanent space capacity (KB). -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di o+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of Young generation GC Events. -.br -.di -.nr o| \n(dn -.nr o- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wMemory Pool Generation and Space Capacities -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Full GC Events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(o- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 441 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Memory Pool Generation and Space Capacities\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(m|u+\n(.Vu -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(o|u+\n(.Vu -.if (\n(o|+\n(#^-1v)>\n(#- .nr #- +(\n(o|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.o+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of Full GC Events. -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.rm o+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-67 +\f3gcoldcapacity\fR: Displays statistics about the sizes of the old generation\&. -.LP -.SS -\-gccause Option -.LP -.LP -This option displays the same summary of garbage collection statistics as the \f3\-gcutil\fP option, but includes the causes of the last garbage collection event and (if applicable) the current garbage collection event. In addition to the columns listed for \f3\-gcutil\fP, this option adds the following columns: -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Cause of last Garbage Collection. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Cause of current Garbage Collection. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wGarbage Collection Statistics, Including GC Events -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wLGCC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 464 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Garbage Collection Statistics, Including GC Events\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'LGCC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-13 +\f3gcmetacapacity\fR: Displays statistics about the sizes of the metaspace\&. -.LP -.SS -\-gcnew Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum tenuring threshold. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Desired survivor size (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wNew Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wMTT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wDSS -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wTenuring threshold. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 518 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'New Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'TT\h'|\n(41u'Tenuring threshold. -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'MTT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'DSS\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-47 +\f3gcutil\fR: Displays a summary about garbage collection statistics\&. -.LP -.SS -\-gcnewcapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\f3printcompilation\fR: Displays Java HotSpot VM compilation method statistics\&. +.TP +-h \fIn\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum new generation capacity (KB). +Displays a column header every \fIn\fR samples (output rows), where \fIn\fR is a positive integer\&. Default value is 0, which displays the column header the first row of data\&. +.TP +-t .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Display sa timestamp column as the first column of output\&. The time stamp is the time since the start time of the target JVM\&. +.TP +-J\fIjavaOption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum new generation capacity (KB). +Passes \f3javaOption\fR to the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. For a complete list of options, see java(1)\&. +.SS STAT\ OPTIONS\ AND\ OUTPUT +The following information summarizes the columns that the \f3jstat\fR command outputs for each \fIstatOption\fR\&. +.TP +-class \fIoption\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current new generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum survivor space 0 capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum survivor space 1 capacity (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum eden space capacity (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wNew Generation Space Size Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0CMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1CMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wECMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Full GC Events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 572 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'New Generation Space Size Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0CMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1CMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'ECMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of Full GC Events. -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-47 +Class loader statistics\&. -.LP -.SS -\-gcold Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -old space utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wOld and Permanent Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 614 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Old and Permanent Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Loaded\fR: Number of classes loaded\&. -.LP -.SS -\-gcoldcapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum old generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum old generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wOld Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 656 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Old Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Bytes\fR: Number of KBs loaded\&. -.LP -.SS -\-gcpermcapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum permanent generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum permanent generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wPermanent Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 698 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Permanent Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Unloaded\fR: Number of classes unloaded\&. -.LP -.SS -\-gcutil Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization as a percentage of the space's current capacity. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization as a percentage of the space's current capacity. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization as a percentage of the space's current capacity. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Old space utilization as a percentage of the space's current capacity. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization as a percentage of the space's current capacity. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wSummary of Garbage Collection Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0 -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1 -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wE -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wO -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 748 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Summary of Garbage Collection Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'E\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'O\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'P\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-43 +\f3Bytes\fR: Number of Kbytes unloaded\&. -.LP -.SS -\-printcompilation Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\f3Time\fR: Time spent performing class loading and unloading operations\&. +.TP +-compiler \fIoption\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks performed. +Java HotSpot VM Just-in-Time compiler statistics\&. + +\f3Compiled\fR: Number of compilation tasks performed\&. + +\f3Failed\fR: Number of compilations tasks failed\&. + +\f3Invalid\fR: Number of compilation tasks that were invalidated\&. + +\f3Time\fR: Time spent performing compilation tasks\&. + +\f3FailedType\fR: Compile type of the last failed compilation\&. + +\f3FailedMethod\fR: Class name and method of the last failed compilation\&. +.TP +-gc \fIoption\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Garbage-collected heap statistics\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3S0U\fR: Survivor space 0 utilization (KB)\&. + +\f3S1U\fR: Survivor space 1 utilization (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3EU\fR: Eden space utilization (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3OU\fR: Old space utilization (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3MU\fR: Metacspace utilization (KB)\&. + +\f3YGC\fR: Number of young generation garbage collection events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gccapacity \fIoption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of bytes of bytecode for the method. +Memory pool generation and space capacities\&. + +\f3NGCMN\fR: Minimum new generation capacity (KB)\&. + +\f3NGCMX\fR: Maximum new generation capacity (KB)\&. + +\f3NGC\fR: Current new generation capacity (KB)\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3OGCMN\fR: Minimum old generation capacity (KB)\&. + +\f3OGCMX\fR: Maximum old generation capacity (KB)\&. + +\f3OGC\fR: Current old generation capacity (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3MCMN\fR: Minimum metaspace capacity (KB)\&. + +\f3MCMX\fR: Maximum metaspace capacity (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3YGC\fR: Number of Young generation GC Events\&. + +\f3FGC\fR: Number of Full GC Events\&. +.TP +-gccause \fIoption\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +This option displays the same summary of garbage collection statistics as the \f3-gcutil\fR option, but includes the causes of the last garbage collection event and (when applicable) the current garbage collection event\&. In addition to the columns listed for \f3-gcutil\fR, this option adds the following columns\&. + +Garbage collection statistics, including garbage collection Events\&. + +\f3LGCC\fR: Cause of last garbage collection\&. + +\f3GCC\fR: Cause of current garbage collection\&. +.TP +-gcnew \fIoption\fR .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Class name and method name identifying the compiled method. Class name uses "/" instead of "." as namespace separator. Method name is the method within the given class. The format for these two fields is consistent with the HotSpot \- \f3XX:+PrintComplation\fP option. +New generation statistics\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3S0U\fR: Survivor space 0 utilization (KB)\&. + +\f3S1U\fR: Survivor space 1 utilization (KB)\&. + +\f3TT\fR: Tenuring threshold\&. + +\f3MTT\fR: Maximum tenuring threshold\&. + +\f3DSS\fR: Desired survivor size (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3EU\fR: Eden space utilization (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. +.TP +-gcnewcapacity \fIoption\fR .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wHotSpot Compiler Method Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wCompiled -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSize -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wType -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wMethod -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wCompilation type. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 774 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'HotSpot Compiler Method Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Compiled\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Size\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Type\h'|\n(41u'Compilation type. -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Method\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-19 +New generation space size statistics\&. -.LP -.SH "EXAMPLES" -.LP -.LP -This section presents some examples of monitoring a local JVM with a \f2lvmid\fP of 21891. -.LP -.SS -Using the gcutil option -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes 7 samples at 250 millisecond intervals and displays the output as specified by the \f3\-gcutil\fP option. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcutil 21891 250 7\fP +NGCMN: Minimum new generation capacity (KB)\&. + +\f3NGCMX\fR: Maximum new generation capacity (KB)\&. + +\f3NGC\fR: Current new generation capacity (KB)\&. + +\f3S0CMX\fR: Maximum survivor space 0 capacity (KB)\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1CMX\fR: Maximum survivor space 1 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3ECMX\fR: Maximum eden space capacity (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of Full GC Events\&. +.TP +-gcold \fIoption\fR .br +old and permanent generation statistics\&. -.fl - S0 S1 E O P YGC YGCT FGC FGCT GCT +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3MU\fR: Metaspace utilization (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3OU\fR: old space utilization (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcoldcapacity \fIoption\fR .br +Old generation statistics\&. -.fl - 12.44 0.00 27.20 9.49 96.70 78 0.176 5 0.495 0.672 +\f3OGCMN\fR: Minimum old generation capacity (KB)\&. + +\f3OGCMX\fR: Maximum old generation capacity (KB)\&. + +\f3OGC\fR: Current old generation capacity (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcmetacapacity \fIoption\fR .br +Permanent generation statistics\&. -.fl - 12.44 0.00 62.16 9.49 96.70 78 0.176 5 0.495 0.672 +\f3MCMN\fR: Minimum metaspace capacity (KB)\&. + +\f3MCMX\fR: Maximum metaspace capacity (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcutil \fIoption\fR .br +Summary of garbage collection statistics\&. -.fl - 12.44 0.00 83.97 9.49 96.70 78 0.176 5 0.495 0.672 +\f3S0\fR: Survivor space 0 utilization as a percentage of the space\&'s current capacity\&. + +\f3S1\fR: Survivor space 1 utilization as a percentage of the space\&'s current capacity\&. + +\f3E\fR: Eden space utilization as a percentage of the space\&'s current capacity\&. + +\f3O\fR: Old space utilization as a percentage of the space\&'s current capacity\&. + +\f3M\fR: Metaspace utilization as a percentage of the space\&'s current capacity\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-printcompilation \fIoption\fR .br +Java HotSpot VM compiler method statistics\&. -.fl - 0.00 7.74 0.00 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Compiled\fR: Number of compilation tasks performed by the most recently compiled method\&. -.fl - 0.00 7.74 23.37 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Size\fR: Number of bytes of byte code of the most recently compiled method\&. -.fl - 0.00 7.74 43.82 9.51 96.70 79 0.177 5 0.495 0.673 -.br - -.fl - 0.00 7.74 58.11 9.51 96.71 79 0.177 5 0.495 0.673 -.br - -.fl -.fi - -.LP -.LP -The output of this example shows that a young generation collection occurred between the 3rd and 4th sample. The collection took 0.001 seconds and promoted objects from the eden space (E) to the old space (O), resulting in an increase of old space utilization from 9.49% to 9.51%. Before the collection, the survivor space was 12.44% utilized, but after this collection it is only 7.74% utilized. -.LP -.SS -Repeating the column header string -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes samples at 250 millisecond intervals and displays the output as specified by \f3\-gcutil\fP option. In addition, it uses the \f3\-h3\fP option to output the column header after every 3 lines of data. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcnew \-h3 21891 250\fP -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 0.0 31.7 31 31 32.0 512.0 178.6 249 0.203 -.br - -.fl - 64.0 64.0 0.0 31.7 31 31 32.0 512.0 355.5 249 0.203 -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 21.9 250 0.204 -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 245.9 250 0.204 -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 421.1 250 0.204 -.br - -.fl - 64.0 64.0 0.0 19.0 31 31 32.0 512.0 84.4 251 0.204 -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 0.0 19.0 31 31 32.0 512.0 306.7 251 0.204 -.br - -.fl -.fi - -.LP -.LP -In addition to showing the repeating header string, this example shows that between the 2nd and 3rd samples, a young GC occurred. Its duration was 0.001 seconds. The collection found enough live data that the survivor space 0 utilization (S0U) would would have exceeded the desired survivor Size (DSS). As a result, objects were promoted to the old generation (not visible in this output), and the tenuring threshold (TT) was lowered from 31 to 2. -.LP -.LP -Another collection occurs between the 5th and 6th samples. This collection found very few survivors and returned the tenuring threshold to 31. -.LP -.SS -Including a time stamp for each sample -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes 3 samples at 250 millisecond intervals. The \f3\-t\fP option is used to generate a time stamp for each sample in the first column. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcoldcapacity \-t 21891 250 3\fP -.br - -.fl -Timestamp OGCMN OGCMX OGC OC YGC FGC FGCT GCT -.br - -.fl - 150.1 1408.0 60544.0 11696.0 11696.0 194 80 2.874 3.799 -.br - -.fl - 150.4 1408.0 60544.0 13820.0 13820.0 194 81 2.938 3.863 -.br - -.fl - 150.7 1408.0 60544.0 13820.0 13820.0 194 81 2.938 3.863 -.br - -.fl -.fi - -.LP -.LP -The \f2Timestamp\fP column reports the elapsed time in seconds since the start of the target JVM. In addition, the \f3\-gcoldcapacity\fP output shows the old generation capacity (OGC) and the old space capacity (OC) increasing as the heap expands to meet allocation and/or promotion demands. The old generation capacity (OGC) has grown to from 11696 KB to 13820 KB after the 81st Full GC (FGC). The maximum capacity of the generation (and space) is 60544 KB (OGCMX), so it still has room to expand. -.LP -.SS -Monitor instrumentation for a remote JVM -.LP -.LP -This example attaches to \f2lvmid\fP 40496 on the system named \f2remote.domain\fP using the \f3\-gcutil\fP option, with samples taken every second indefinitely. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcutil 40496@remote.domain 1000\fP -.br - -.fl -... \f2output omitted\fP -.br - -.fl -.fi - -.LP -.LP -The \f2lvmid\fP is combined with the name of the remote host to construct a \f2vmid\fP of \f240496@remote.domain\fP. This \f2vmid\fP results in the use of the \f3rmi\fP protocol to communicate to the default \f3jstatd\fP server on the remote host. The \f3jstatd\fP server is located using the \f3rmiregistry\fP on \f2remote.domain\fP that is bound to the default \f3rmiregistry\fP port (port 1099). -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jps(1) \- the Java Process Status Application -.TP 2 -o -jstatd(1) \- the jvmstat daemon -.TP 2 -o -rmiregistry(1) \- the Java Remote Object Registry -.RE - -.LP +\f3Type\fR: Compilation type of the most recently compiled method\&. +\f3Method\fR: Class name and method name identifying the most recently compiled method\&. Class name uses slash (/) instead of dot (\&.) as a name space separator\&. Method name is the method within the specified class\&. The format for these two fields is consistent with the HotSpot \f3-XX:+PrintComplation\fR option\&. +.SH EXAMPLES +This section presents some examples of monitoring a local JVM with an \fIlvmid\fR of 21891\&. +.SS THE\ GCUTIL\ OPTION +This example attaches to lvmid 21891 and takes 7 samples at 250 millisecond intervals and displays the output as specified by the -\f3gcutil\fR option\&. +.PP +The output of this example shows that a young generation collection occurred between the third and fourth sample\&. The collection took 0\&.001 seconds and promoted objects from the eden space (E) to the old space (O), resulting in an increase of old space utilization from 9\&.49% to 9\&.51%\&. Before the collection, the survivor space was 12\&.44% utilized, but after this collection it is only 7\&.74% utilized\&. +.sp +.nf +\f3jstat \-gcutil 21891 250 7\fP +.fi +.nf +\f3 S0 S1 E O M YGC YGCT FGC FGCT GCT\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS REPEAT\ THE\ COLUMN\ HEADER\ STRING +This example attaches to lvmid 21891 and takes samples at 250 millisecond intervals and displays the output as specified by \f3-gcutil\fR option\&. In addition, it uses the \f3-h3\fR option to output the column header after every 3 lines of data\&. +.PP +In addition to showing the repeating header string, this example shows that between the second and third samples, a young GC occurred\&. Its duration was 0\&.001 seconds\&. The collection found enough active data that the survivor space 0 utilization (S0U) would have exceeded the desired survivor Size (DSS)\&. As a result, objects were promoted to the old generation (not visible in this output), and the tenuring threshold (TT) was lowered from 31 to 2\&. +.PP +Another collection occurs between the fifth and sixth samples\&. This collection found very few survivors and returned the tenuring threshold to 31\&. +.sp +.nf +\f3jstat \-gcnew \-h3 21891 250\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 31\&.7 31 31 32\&.0 512\&.0 178\&.6 249 0\&.203\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 31\&.7 31 31 32\&.0 512\&.0 355\&.5 249 0\&.203\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 21\&.9 250 0\&.204\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 245\&.9 250 0\&.204\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 421\&.1 250 0\&.204\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 19\&.0 31 31 32\&.0 512\&.0 84\&.4 251 0\&.204\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 19\&.0 31 31 32\&.0 512\&.0 306\&.7 251 0\&.204\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INCLUDE\ A\ TIME\ STAMP\ FOR\ EACH\ SAMPLE +This example attaches to lvmid 21891 and takes 3 samples at 250 millisecond intervals\&. The \f3-t\fR option is used to generate a time stamp for each sample in the first column\&. +.PP +The Timestamp column reports the elapsed time in seconds since the start of the target JVM\&. In addition, the \f3-gcoldcapacity\fR output shows the old generation capacity (OGC) and the old space capacity (OC) increasing as the heap expands to meet allocation or promotion demands\&. The old generation capacity (OGC) has grown to from 11,696 KB to 13820 KB after the eighty-first full garbage collection (FGC)\&. The maximum capacity of the generation (and space) is 60,544 KB (OGCMX), so it still has room to expand\&. +.sp +.nf +\f3Timestamp OGCMN OGCMX OGC OC YGC FGC FGCT GCT\fP +.fi +.nf +\f3 150\&.1 1408\&.0 60544\&.0 11696\&.0 11696\&.0 194 80 2\&.874 3\&.799\fP +.fi +.nf +\f3 150\&.4 1408\&.0 60544\&.0 13820\&.0 13820\&.0 194 81 2\&.938 3\&.863\fP +.fi +.nf +\f3 150\&.7 1408\&.0 60544\&.0 13820\&.0 13820\&.0 194 81 2\&.938 3\&.863\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS MONITOR\ INSTRUMENTATION\ FOR\ A\ REMOTE\ JVM +This example attaches to lvmid 40496 on the system named remote\&.domain using the \f3-gcutil\fR option, with samples taken every second indefinitely\&. +.PP +The lvmid is combined with the name of the remote host to construct a \fIvmid\fR of \f340496@remote\&.domain\fR\&. This vmid results in the use of the \f3rmi\fR protocol to communicate to the default \f3jstatd\fR server on the remote host\&. The \f3jstatd\fR server is located using the rmiregistry on \f3remote\&.domain\fR that is bound to the default rmiregistry port (port 1099)\&. +.sp +.nf +\f3jstat \-gcutil 40496@remote\&.domain 1000\fP +.fi +.nf +\f3\fI\&.\&.\&. output omitted\fR\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/jstatd.1 b/jdk/src/bsd/doc/man/jstatd.1 index 5b8aa4d7e4a..8db6e9678a2 100644 --- a/jdk/src/bsd/doc/man/jstatd.1 +++ b/jdk/src/bsd/doc/man/jstatd.1 @@ -1,257 +1,210 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstatd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jstatd.1 +.\" +.if n .pl 99999 +.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstatd \- Virtual Machine jstat Daemon -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -jstatd [ \fP\f4options\fP\f3 ]\fP +.SH NAME +jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstatd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. +.PP +The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. +.SH OPTIONS +.TP +-nr .br -\f3 -.fl -\fP -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Command\-line options. The options may be in any order. If there are redundant or contradictory options, the last option specified will take precedence. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jstatd\fP tool is an RMI server application that monitors for the creation and termination of instrumented HotSpot Java virtual machines (JVMs) and provides a interface to allow remote monitoring tools to attach to JVMs running on the local host. -.LP -.LP -The \f3jstatd\fP server requires the presence of an RMI registry on the local host. The \f3jstatd\fP server will attempt to attach to the RMI registry on the default port, or on the port indicated by the \f2\-p port\fP option. If an RMI registry is not found, one will be created within the \f3jstatd\fP application bound to the port indicated by the \f2\-p port\fP option or to the default RMI registry port if \f2\-p port\fP is omitted. Creation of an internal RMI registry can be inhibited by specifying the \f2\-nr\fP option. -.LP -.LP -\f3NOTE:\fP This utility is unsupported and may or may not be available in future versions of the JDK. It is not currently available on the Windows 98 and Windows ME platforms. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jstatd\fP command supports the following options: -.LP -.RS 3 -.TP 3 -\-nr -Do not attempt to create an internal RMI registry within the \f2jstatd\fP process when an existing RMI registry is not found. -.TP 3 -\-p\ port -Port number where the RMI registry is expected to be found, or, if not found, created if \f2\-nr\fP is not specified. -.TP 3 -\-n\ rminame -Name to which the remote RMI object is bound in the RMI registry. The default name is \f2JStatRemoteHost\fP. If multiple \f3jstatd\fP servers are started on the same host, the name of the exported RMI object for each server can be made unique by specifying this option. However, doing so will require that the unique server name be included in the monitoring client's \f2hostid\fP and \f2vmid\fP strings. -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.RE - -.LP -.SH "SECURITY" -.LP -.LP -The \f3jstatd\fP server can only monitor JVMs for which it has the appropriate native access permissions. Therefor the \f3jstatd\fP process must be running with the same user credentials as the target JVMs. Some user credentials, such as the \f2root\fP user in UNIX(TM) based systems, have permission to access the instrumentation exported by any JVM on the system. A \f3jstatd\fP process running with such credentials can monitor any JVM on the system, but introduces additional security concerns. -.LP -.LP -The \f3jstatd\fP server does not provide any authentication of remote clients. Therefore, running a \f3jstatd\fP server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fP process has access permissions to any user on the network. This exposure may be undesireable in your environment and local security policies should be considered before starting the \f3jstatd\fP process, particularly in production environments or on unsecure networks. -.LP -.LP -The \f3jstatd\fP server installs an instance of RMISecurityPolicy if no other security manager has been installed and therefore requires a security policy file to be specified. The policy file must conform to the default policy implementation's -.na -\f2Policy File Syntax\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html. -.LP -.LP -The following policy file will allow the \f3jstatd\fP server to run without any security exceptions. This policy is less liberal then granting all permissions to all codebases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fP server. -.LP -.nf -\f3 -.fl -grant codebase "file:${java.home}/../lib/tools.jar" {\fP +Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. +.TP +-p \fIport\fR .br -\f3 -.fl - permission java.security.AllPermission;\fP +The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. +.TP +-n \fIrminame\fR .br -\f3 -.fl -};\fP +Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. +.TP +-J\fIoption\fR .br -\f3 -.fl -\fP -.fi - -.LP -.LP -To use this policy, copy the text into a file called \f2jstatd.all.policy\fP and run the \f3jstatd\fP server as follows: -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=jstatd.all.policy\fP -.br -\f3 -.fl -\fP -.fi - -.LP -.LP -For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP addreess spoofing attacks. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fP server and use the \f3jstat\fP and \f3jps\fP tools locally. -.LP -.SH "REMOTE INTERFACE" -.LP -.LP -The interface exported by the \f3jstatd\fP process is proprietary and is guaranteed to change. Users and developers are discouraged from writing to this interface. -.LP -.SH "EXAMPLES" -.LP -.LP -Here are some examples of starting \f3jstatd\fP. Note that the \f3jstatd\fP scripts automatically start the server in the background. -.LP -.SS -Using Internal RMI Registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an internal RMI registry. This example assumes that no other server is bound to the default RMI Registry port (port 1099). -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy -.fl -\fP -.fi - -.LP -.SS -Using External RMI Registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP with a external RMI registry. -.LP -.nf -\f3 -.fl -rmiregistry& -.fl -jstatd \-J\-Djava.security.policy=all.policy -.fl -\fP -.fi - -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an external RMI registry server on port 2020. -.LP -.nf -\f3 -.fl -rmiregistry 2020& -.fl -jstatd \-J\-Djava.security.policy=all.policy \-p 2020 -.fl -\fP -.fi - -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an external RMI registry on port 2020, bound to name AlternateJstatdServerName. -.LP -.nf -\f3 -.fl -rmiregistry 2020& -.fl -jstatd \-J\-Djava.security.policy=all.policy \-p 2020 \-n AlternateJstatdServerName -.fl -\fP -.fi - -.LP -.SS -Inhibiting creation of an in\-process RMI registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP such that it will not create a RMI registry if one is not found. This example assumes an RMI registry is already running. If it is not, an appropriate error message is emitted. -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy \-nr -.fl -\fP -.fi - -.LP -.SS -Enabling RMI logging capabilities. -.LP -.LP -This example demonstrates starting \f3jstatd\fP with RMI logging capabilities enabled. This technique is useful as a troubleshooting aid or for monitoring server activities. -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy \-J\-Djava.rmi.server.logCalls=true -.fl -\fP -.fi - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jps(1) \- the Java Process Status Application -.TP 2 -o -jstat(1) \- the Java Virtual Machine Statistics Monitoring Tool -.TP 2 -o -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry -.RE - -.LP - +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SECURITY +The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. +.PP +The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. +.PP +The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.PP +The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. +.sp +.nf +\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP +.fi +.nf +\f3 permission java\&.security\&.AllPermission;\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp +To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. +.SH REMOTE\ INTERFACE +The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. +.SH EXAMPLES +The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background +.SS INTERNAL\ RMI\ REGISTRY +This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXTERNAL\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session with a external RMI registry\&. +.sp +.nf +\f3rmiregistry&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. +.sp +.nf +\f3jrmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. +.sp +.nf +\f3rmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3 \-n AlternateJstatdServerName\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS ENABLE\ RMI\ LOGGING +This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/keytool.1 b/jdk/src/bsd/doc/man/keytool.1 index c5f6229bd44..72758893e3a 100644 --- a/jdk/src/bsd/doc/man/keytool.1 +++ b/jdk/src/bsd/doc/man/keytool.1 @@ -1,1765 +1,1300 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH keytool 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 6 August 2013 +.\" SectDesc: Security Tools +.\" Title: keytool.1 +.\" +.if n .pl 99999 +.TH keytool 1 "6 August 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -keytool \- Key and Certificate Management Tool -.LP -.LP -Manages a keystore (database) of cryptographic keys, X.509 certificate chains, and trusted certificates. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3keytool\fP [ commands ] -.fl -.fi +.SH NAME +keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -The keytool command interface has changed in Java SE 6. See the Changes Section for a detailed description. Note that previously defined commands are still supported. -.LP -.SH "DESCRIPTION" -.LP -\f3keytool\fP is a key and certificate management utility. It allows users to administer their own public/private key pairs and associated certificates for use in self\-authentication (where the user authenticates himself/herself to other users/services) or data integrity and authentication services, using digital signatures. It also allows users to cache the public keys (in the form of certificates) of their communicating peers. -.LP -A \f2certificate\fP is a digitally signed statement from one entity (person, company, etc.), saying that the public key (and some other information) of some other entity has a particular value. (See Certificates.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity. \f2Integrity\fP means that the data has not been modified or tampered with, and \f2authenticity\fP means the data indeed comes from whoever claims to have created and signed it. -.LP -.LP -\f3keytool\fP also enables users to administer secret keys used in symmetric encryption/decryption (e.g. DES). -.LP -.LP -\f3keytool\fP stores the keys and certificates in a \f2keystore\fP. -.LP -.SH "COMMAND AND OPTION NOTES" -.LP -.LP -The various commands and their options are listed and described below. Note: -.LP -.RS 3 -.TP 2 -o -All command and option names are preceded by a minus sign (\-). -.TP 2 -o -The options for each command may be provided in any order. -.TP 2 -o -All items not italicized or in braces or square brackets are required to appear as is. -.TP 2 -o -Braces surrounding an option generally signify that a default value will be used if the option is not specified on the command line. Braces are also used around the \f2\-v\fP, \f2\-rfc\fP, and \f2\-J\fP options, which only have meaning if they appear on the command line (that is, they don't have any "default" values other than not existing). -.TP 2 -o -Brackets surrounding an option signify that the user is prompted for the value(s) if the option is not specified on the command line. (For a \f2\-keypass\fP option, if you do not specify the option on the command line, \f3keytool\fP will first attempt to use the keystore password to recover the private/secret key, and if this fails, will then prompt you for the private/secret key password.) -.TP 2 -o -Items in italics (option values) represent the actual values that must be supplied. For example, here is the format of the \f2\-printcert\fP command: -.nf -\f3 -.fl - keytool \-printcert {\-file \fP\f4cert_file\fP\f3} {\-v} -.fl -\fP -.fi -.LP -When specifying a \f2\-printcert\fP command, replace \f2cert_file\fP with the actual file name, as in: -.nf -\f3 -.fl - keytool \-printcert \-file VScert.cer -.fl -\fP -.fi -.TP 2 -o -Option values must be quoted if they contain a blank (space). -.TP 2 -o -The \f2\-help\fP command is the default. Thus, the command line -.nf -\f3 -.fl - keytool -.fl -\fP -.fi -.LP -is equivalent to -.nf -\f3 -.fl - keytool \-help -.fl -\fP -.fi -.RE +\fBkeytool\fR [\fIcommands\fR] +.fi +.sp +.TP +\fIcommands\fR +See Commands\&. These commands are categorized by task as follows: +.RS +.TP 0.2i +\(bu +Create or Add Data to the Keystore +.RS +.TP 0.2i +\(bu +-gencert +.TP 0.2i +\(bu +-genkeypair +.TP 0.2i +\(bu +-genseckey +.TP 0.2i +\(bu +-importcert +.TP 0.2i +\(bu +-importpassword +.RE -.LP -.SS -Option Defaults -.LP -.LP -Below are the defaults for various option values. -.LP -.nf -\f3 -.fl -\-alias "mykey" -.fl +.TP 0.2i +\(bu +Import Contents From Another Keystore +.RS +.TP 0.2i +\(bu +-importkeystore +.RE -.fl -\-keyalg -.fl - "DSA" (when using \fP\f3\-genkeypair\fP\f3) -.fl - "DES" (when using \fP\f3\-genseckey\fP\f3) -.fl +.TP 0.2i +\(bu +Generate Certificate Request +.RS +.TP 0.2i +\(bu +-certreq +.RE -.fl -\-keysize -.fl - 2048 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "RSA") -.fl - 1024 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "DSA") -.fl - 256 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "EC") -.fl - 56 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DES") -.fl - 168 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DESede") -.fl +.TP 0.2i +\(bu +Export Data +.RS +.TP 0.2i +\(bu +-exportcert +.RE -.fl +.TP 0.2i +\(bu +Display Data +.RS +.TP 0.2i +\(bu +-list +.TP 0.2i +\(bu +-printcert +.TP 0.2i +\(bu +-printcertreq +.TP 0.2i +\(bu +-printcrl +.RE -.fl -\-validity 90 -.fl +.TP 0.2i +\(bu +Manage the Keystore +.RS +.TP 0.2i +\(bu +-storepasswd +.TP 0.2i +\(bu +-keypasswd +.TP 0.2i +\(bu +-delete +.TP 0.2i +\(bu +-changealias +.RE -.fl -\-keystore the file named \fP\f4.keystore\fP\f3 in the user's home directory -.fl +.TP 0.2i +\(bu +Get Help +.RS +.TP 0.2i +\(bu +-help +.RE -.fl -\-storetype the value of the "keystore.type" property in the security properties file, -.fl - which is returned by the static \fP\f4getDefaultType\fP\f3 method in -.fl - \fP\f4java.security.KeyStore\fP\f3 -.fl +.RE -.fl -\-file stdin if reading, stdout if writing -.fl +.SH DESCRIPTION +The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. +.PP +A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. +.PP +The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. +.PP +The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. +.SH COMMAND\ AND\ OPTION\ NOTES +See Commands for a listing and description of the various commands\&. +.TP 0.2i +\(bu +All command and option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options for each command can be provided in any order\&. +.TP 0.2i +\(bu +All items not italicized or in braces or brackets are required to appear as is\&. +.TP 0.2i +\(bu +Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. +.TP 0.2i +\(bu +Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. +.TP 0.2i +\(bu +Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: -.fl -\-protected false -.fl -\fP -.fi +\f3keytool -printcert {-file cert_file} {-v}\fR -.LP -.LP -In generating a public/private key pair, the signature algorithm (\f2\-sigalg\fP option) is derived from the algorithm of the underlying private key: -.LP -.RS 3 -.TP 2 -o -If the underlying private key is of type "DSA", the \f2\-sigalg\fP option defaults to "SHA1withDSA" -.TP 2 -o -If the underlying private key is of type "RSA", the \f2\-sigalg\fP option defaults to "SHA256withRSA". -.TP 2 -o -If the underlying private key is of type "EC", the \f2\-sigalg\fP option defaults to "SHA256withECDSA". -.RE - -.LP -.LP -Please consult the -.na -\f2Java Cryptography Architecture API Specification & Reference\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA for a full list of \f2\-keyalg\fP and \f2\-sigalg\fP you can choose from. -.LP -.SS -Common Options -.LP -.LP -The \f2\-v\fP option can appear for all commands except \f2\-help\fP. If it appears, it signifies "verbose" mode; more information will be provided in the output. -.LP -.LP -There is also a \f2\-J\fP\f2javaoption\fP option that may appear for any command. If it appears, the specified \f2javaoption\fP string is passed through directly to the Java interpreter. This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line. -.LP -.LP -These options may appear for all commands operating on a keystore: -.LP -.RS 3 -.TP 3 -\-storetype storetype -.LP -This qualifier specifies the type of keystore to be instantiated. -.TP 3 -\-keystore keystore -.LP -The keystore location. -.LP -If the JKS storetype is used and a keystore file does not yet exist, then certain \f3keytool\fP commands may result in a new keystore file being created. For example, if \f2keytool \-genkeypair\fP is invoked and the \f2\-keystore\fP option is not specified, the default keystore file named \f2.keystore\fP in the user's home directory will be created if it does not already exist. Similarly, if the \f2\-keystore \fP\f2ks_file\fP option is specified but \f2ks_file\fP does not exist, then it will be created -.LP -Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based (for example, if it resides on a hardware token device). -.TP 3 -\-storepass[:env|:file] argument -.LP -The password which is used to protect the integrity of the keystore. -.LP -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP, which must be at least 6 characters long. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -.LP -\f3Note\fP: All other options that require passwords, such as \f2\-keypass\fP, \f2\-srckeypass\fP, \f2\-destkeypass\fP \f2\-srcstorepass\fP, and \f2\-deststorepass\fP, accept the \f2env\fP and \f2file\fP modifiers. (Remember to separate the password option and the modifier with a colon, (\f2:\fP).) -.LP -The password must be provided to all commands that access the keystore contents. For such commands, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for it. -.LP -When retrieving information from the keystore, the password is optional; if no password is given, the integrity of the retrieved information cannot be checked and a warning is displayed. -.TP 3 -\-providerName provider_name -.LP -Used to identify a cryptographic service provider's name when listed in the security properties file. -.TP 3 -\-providerClass provider_class_name -.LP -Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file. -.TP 3 -\-providerArg provider_arg -.LP -Used in conjunction with \f2\-providerClass\fP. Represents an optional string input argument for the constructor of \f2provider_class_name\fP. -.TP 3 -\-protected -.LP -Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader. -.LP -Note: Since there are two keystores involved in \f2\-importkeystore\fP command, two options, namely, \f2\-srcprotected\fP and \f2\-destprotected\fP are provided for the source keystore and the destination keystore respectively. -.TP 3 -\-ext {name{:critical}{=value}} -.LP -Denotes an X.509 certificate extension. The option can be used in \-genkeypair and \-gencert to embed extensions into the certificate generated, or in \f2\-certreq\fP to show what extensions are requested in the certificate request. The option can appear multiple times. name can be a supported extension name (see below) or an arbitrary OID number. value, if provided, denotes the parameter for the extension; if omitted, denotes the default value (if defined) of the extension or the extension requires no parameter. The \f2:critical\fP modifier, if provided, means the extension's isCritical attribute is true; otherwise, false. You may use \f2:c\fP in place of \f2:critical\fP. -.RE - -.LP -.LP -Currently keytool supports these named extensions (case\-insensitive): -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +When you specify a \f3-printcert\fR command, replace \f3cert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR +.TP 0.2i +\(bu +Option values must be put in quotation marks when they contain a blank (space)\&. +.TP 0.2i +\(bu +The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. +.SH OPTION\ DEFAULTS +The following examples show the defaults for various option values\&. +.sp +.nf +\f3\-alias "mykey"\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keyalg\fP +.fi +.nf +\f3 "DSA" (when using \-genkeypair)\fP +.fi +.nf +\f3 "DES" (when using \-genseckey)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keysize\fP +.fi +.nf +\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP +.fi +.nf +\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP +.fi +.nf +\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP +.fi +.nf +\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP +.fi +.nf +\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-validity 90\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-storetype <the value of the "keystore\&.type" property in the\fP +.fi +.nf +\f3 security properties file, which is returned by the static\fP +.fi +.nf +\f3 getDefaultType method in java\&.security\&.KeyStore>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-file\fP +.fi +.nf +\f3 stdin (if reading)\fP +.fi +.nf +\f3 stdout (if writing)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-protected false\fP +.fi +.nf +\f3\fP +.fi +.sp +In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: +.TP 0.2i +\(bu +If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. +.PP +For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA +.SH COMMON\ OPTIONS +The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. +.PP +There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.PP +These options can appear for all commands operating on a keystore: +.TP +-storetype \fIstoretype\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -The full form: "ca:{true|false}[,pathlen:<len>]"; or, <len>, a shorthand for "ca:true,pathlen:<len>"; or omitted, means "ca:true" +This qualifier specifies the type of keystore to be instantiated\&. +.TP +-keystore \fIkeystore\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +The keystore location\&. + +If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. + +Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. +.TP +-storepass[:\fIenv\fR| :\fIfile\fR] argument .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -usage(,usage)*, usage can be one of digitalSignature, nonRepudiation (contentCommitment), keyEncipherment, dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly, decipherOnly. Usage can be abbreviated with the first few letters (say, dig for digitalSignature) or in camel\-case style (say, dS for digitalSignature, cRLS for cRLSign), as long as no ambiguity is found. Usage is case\-insensitive. +The password that is used to protect the integrity of the keystore\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named argument\&. +.RE + + +\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. + +The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. + +When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. +.TP +-providerName \fIprovider_name\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. +.TP +-providerClass \fIprovider_class_name\fR .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -usage(,usage)*, usage can be one of anyExtendedKeyUsage, serverAuth, clientAuth, codeSigning, emailProtection, timeStamping, OCSPSigning, or any OID string. Named usage can be abbreviated with the first few letters or in camel\-case style, as long as no ambiguity is found. Usage is case\-insensitive. +Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. +.TP +-providerArg \fIprovider_arg\fR .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 +Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. +.TP +-protected .br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. +.TP +-ext \fI{name{:critical} {=value}}\fR +.br +Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. +.SH NAMED\ EXTENSIONS +The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. +.TP +BC or BasicContraints +\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. +.TP +KU or KeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +EKU or ExtendedKeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP SAN or SubjectAlternativeName -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -type:value(,type:value)*, type can be EMAIL, URI, DNS, IP, or OID, value is the string format value for the type. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. +.TP IAN or IssuerAlternativeName -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -same as SubjectAlternativeName -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -method:location\-type:location\-value (,method:location\-type:location\-value)*, method can be "timeStamping", "caRepository" or any OID. location\-type and location\-value can be any type:value supported by the SubjectAlternativeName extension. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. +.TP +SIA or SubjectInfoAccess +\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. +.TP AIA or AuthorityInfoAccess +\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. +.PP +When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. +.PP +A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. +.PP +If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. +.PP +The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. +.PP +\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. +.SH COMMANDS +.TP +-gencert .br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -same as SubjectInfoAccess. method can be "ocsp","caIssuers" or any OID. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Name\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBC or BasicConstraints -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wKU or KeyUsage -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEKU or ExtendedkeyUsage -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSIA or SubjectInfoAccess -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(f- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(i- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Value\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 319 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Name\fP\h'|\n(41u'\f3Value\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'BC or BasicConstraints\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'KU or KeyUsage\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EKU or ExtendedkeyUsage\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.ne \n(g|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'SIA or SubjectInfoAccess\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.ne \n(j|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-38 +\f3{-rfc} {-infile infile} {-outfile outfile} {-alias alias} {-sigalg sigalg} {-dname dname} {-startdate startdate {-ext ext}* {-validity valDays} [-keypass keypass] {-keystore keystore} [-storepass storepass] {-storetype storetype} {-providername provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. + +When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. + +The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. + +The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. + +The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: +.sp +.nf +\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: +.sp +.nf +\f3keytool \-alias ca1 \-certreq |\fP +.fi +.nf +\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP +.fi +.nf +\f3 keytool \-alias ca1 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-alias ca2 \-certreq |\fP +.fi +.nf +\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP +.fi +.nf +\f3 $KT \-alias ca2 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: +.sp +.nf +\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-genkeypair +.br +\f3{-alias alias} {-keyalg keyalg} {-keysize keysize} {-sigalg sigalg} [-dname dname] [-keypass keypass] {-startdate value} {-ext ext}* {-validity valDays} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. + +The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. + +The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. + +The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. + +The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. -.LP -.LP -For name as OID, value is the HEX dumped DER encoding of the extnValue for the extension excluding the OCTET STRING type and length bytes. Any extra character other than standard HEX numbers (0\-9, a\-f, A\-F) are ignored in the HEX string. Therefore, both \f2"01:02:03:04"\fP and \f2"01020304"\fP are accepted as identical values. If there's no value, the extension has an empty value field then. -.LP -.LP -A special name \f2'honored'\fP, used in \f2\-gencert\fP only, denotes how the extensions included in the certificate request should be honored. The value for this name is a comma separated list of \f2"all"\fP (all requested extensions are honored), \f2"name{:[critical|non\-critical]}"\fP (the named extension is honored, but using a different isCritical attribute) and \f2"\-name"\fP (used with all, denotes an exception). Requested extensions are not honored by default. -.LP -.LP -If, besides the \-ext honored option, another named or OID \-ext option is provided, this extension will be added to those already honored. However, if this name (or OID) also appears in the honored value, its value and criticality overrides the one in the request. -.LP -.LP -The subjectKeyIdentifier extension is always created. For non self\-signed certificates, the authorityKeyIdentifier is always created. -.LP -.LP -\f3Note:\fP Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard. See Warning Regarding Certificate Conformance for details. -.LP -.SH "COMMANDS" -.LP -.SS -Creating or Adding Data to the Keystore -.LP -.RS 3 -.TP 3 -\-gencert {\-rfc} {\-infile infile} {\-outfile outfile} {\-alias alias} {\-sigalg sigalg} {\-dname dname} {\-startdate startdate {\-ext ext}* {\-validity valDays} [\-keypass keypass] {\-keystore keystore} [\-storepass storepass] {\-storetype storetype} {\-providername provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a certificate as a response to a certificate request file (which can be created by the \f2keytool \-certreq\fP command). The command reads the request from \f2infile\fP (if omitted, from the standard input), signs it using alias's private key, and output the X.509 certificate into \f2outfile\fP (if omitted, to the standard output). If \f2\-rfc\fP is specified, output format is BASE64\-encoded PEM; otherwise, a binary DER is created. -.LP -\f2sigalg\fP specifies the algorithm that should be used to sign the certificate. \f2startdate\fP is the start time/date that the certificate is valid. \f2valDays\fP tells the number of days for which the certificate should be considered valid. -.LP -If \f2dname\fP is provided, it's used as the subject of the generated certificate. Otherwise, the one from the certificate request is used. -.LP -\f2ext\fP shows what X.509 extensions will be embedded in the certificate. Read Common Options for the grammar of \f2\-ext\fP. -.LP -The \f2\-gencert\fP command enables you to create certificate chains. The following example creates a certificate, \f2e1\fP, that contains three certificates in its certificate chain. -.LP -The following commands creates four key pairs named \f2ca\fP, \f2ca1\fP, \f2ca2\fP, and \f2e1\fP: -.nf -\f3 -.fl -keytool \-alias ca \-dname CN=CA \-genkeypair -.fl -keytool \-alias ca1 \-dname CN=CA \-genkeypair -.fl -keytool \-alias ca2 \-dname CN=CA \-genkeypair -.fl -keytool \-alias e1 \-dname CN=E1 \-genkeypair -.fl -\fP -.fi -.LP -The following two commands create a chain of signed certificates; \f2ca\fP signs ca1 and \f2ca1 signs ca2\fP, all of which are self\-issued: -.nf -\f3 -.fl -keytool \-alias ca1 \-certreq | keytool \-alias ca \-gencert \-ext san=dns:ca1 | keytool \-alias ca1 \-importcert -.fl -keytool \-alias ca2 \-certreq | $KT \-alias ca1 \-gencert \-ext san=dns:ca2 | $KT \-alias ca2 \-importcert -.fl -\fP -.fi -.LP -The following command creates the certificate \f2e1\fP and stores it in the file \f2e1.cert\fP, which is signed by \f2ca2\fP. As a result, \f2e1\fP should contain \f2ca\fP, \f2ca1\fP, and \f2ca2\fP in its certificate chain: -.nf -\f3 -.fl -keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1.cert -.fl -\fP -.fi -.TP 3 -\-genkeypair {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} {\-sigalg sigalg} [\-dname dname] [\-keypass keypass] {\-startdate value} {\-ext ext}* {\-validity valDays} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a key pair (a public key and associated private key). Wraps the public key into an X.509 v3 self\-signed certificate, which is stored as a single\-element certificate chain. This certificate chain and the private key are stored in a new keystore entry identified by \f2alias\fP. -.LP -\f2keyalg\fP specifies the algorithm to be used to generate the key pair, and \f2keysize\fP specifies the size of each key to be generated. \f2sigalg\fP specifies the algorithm that should be used to sign the self\-signed certificate; this algorithm must be compatible with \f2keyalg\fP. -.LP -\f2dname\fP specifies the X.500 Distinguished Name to be associated with \f2alias\fP, and is used as the \f2issuer\fP and \f2subject\fP fields in the self\-signed certificate. If no distinguished name is provided at the command line, the user will be prompted for one. -.LP -\f2keypass\fP is a password used to protect the private key of the generated key pair. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long. -.LP -\f2startdate\fP specifies the issue time of the certificate, also known as the "Not Before" value of the X.509 certificate's Validity field. -.LP The option value can be set in one of these two forms: -.RS 3 -.TP 3 -1. -([+\-]\f2nnn\fP[ymdHMS])+ -.TP 3 -2. -[yyyy/mm/dd] [HH:MM:SS] -.RE -.LP -With the first form, the issue time is shifted by the specified value from the current time. The value is a concatenation of a sequence of sub values. Inside each sub value, the plus sign ("+") means shifting forward, and the minus sign ("\-") means shifting backward. The time to be shifted is \f2nnn\fP units of years, months, days, hours, minutes, or seconds (denoted by a single character of "y", "m", "d", "H", "M", or "S" respectively). The exact value of the issue time is calculated using the \f2java.util.GregorianCalendar.add(int field, int amount)\fP method on each sub value, from left to right. For example, by specifying \f2"\-startdate \-1y+1m\-1d"\fP, the issue time will be: -.nf -\f3 -.fl - Calendar c = new GregorianCalendar(); -.fl - c.add(Calendar.YEAR, \-1); -.fl - c.add(Calendar.MONTH, 1); -.fl - c.add(Calendar.DATE, \-1); -.fl - return c.getTime() -.fl -\fP -.fi -.LP -With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone). The user may provide only one part, which means the other part is the same as the current date (or time). User must provide the exact number of digits as shown in the format definition (padding with 0 if shorter). When both the date and time are provided, there is one (and only one) space character between the two parts. The hour should always be provided in 24 hour format. -.LP -When the option is not provided, the start date is the current time. The option can be provided at most once. -.LP -\f2valDays\fP specifies the number of days (starting at the date specified by \f2\-startdate\fP, or the current date if \f2\-startdate\fP is not specified) for which the certificate should be considered valid. -.LP -This command was named \f2\-genkey\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarity the new name, \f2\-genkeypair\fP, is preferred going forward. -.TP 3 -\-genseckey {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a secret key and stores it in a new \f2KeyStore.SecretKeyEntry\fP identified by \f2alias\fP. -.LP -\f2keyalg\fP specifies the algorithm to be used to generate the secret key, and \f2keysize\fP specifies the size of the key to be generated. \f2keypass\fP is a password used to protect the secret key. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long. -.TP 3 -\-importcert {\-alias alias} {\-file cert_file} [\-keypass keypass] {\-noprompt} {\-trustcacerts} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X.509 certificates) from the file \f2cert_file\fP, and stores it in the keystore entry identified by \f2alias\fP. If no file is given, the certificate or certificate chain is read from stdin. -.LP -\f3keytool\fP can import X.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type. The data to be imported must be provided either in binary encoding format, or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard. In the latter case, the encoding must be bounded at the beginning by a string that starts with "\-\-\-\-\-BEGIN", and bounded at the end by a string that starts with "\-\-\-\-\-END". -.LP -You import a certificate for two reasons: -.RS 3 -.TP 3 -1. -to add it to the list of trusted certificates, or -.TP 3 -2. -to import a certificate reply received from a CA as the result of submitting a Certificate Signing Request (see the \-certreq command) to that CA. -.RE -.LP -Which type of import is intended is indicated by the value of the \f2\-alias\fP option: -.RS 3 -.TP 3 -1. -\f3If the alias does not point to a key entry\fP, then \f3keytool\fP assumes you are adding a trusted certificate entry. In this case, the alias should not already exist in the keystore. If the alias does already exist, then \f3keytool\fP outputs an error, since there is already a trusted certificate for that alias, and does not import the certificate. -.TP 3 -2. -\f3If the alias points to a key entry\fP, then \f3keytool\fP assumes you are importing a certificate reply. -.RE -\f3Importing a New Trusted Certificate\fP -.LP -Before adding the certificate to the keystore, \f3keytool\fP tries to verify it by attempting to construct a chain of trust from that certificate to a self\-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore. -.LP -If the \f2\-trustcacerts\fP option has been specified, additional certificates are considered for the chain of trust, namely the certificates in a file named "cacerts". -.LP -If \f3keytool\fP fails to establish a trust path from the certificate to be imported up to a self\-signed certificate (either from the keystore or the "cacerts" file), the certificate information is printed out, and the user is prompted to verify it, e.g., by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner himself/herself. Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! \-\- see WARNING Regarding Importing Trusted Certificates. The user then has the option of aborting the import operation. If the \f2\-noprompt\fP option is given, however, there will be no interaction with the user. -\f3Importing a Certificate Reply\fP -.LP -When importing a certificate reply, the certificate reply is validated using trusted certificates from the keystore, and optionally using the certificates configured in the "cacerts" keystore file (if the \f2\-trustcacerts\fP option was specified). -.LP -The methods of determining whether the certificate reply is trusted are described in the following: -.RS 3 -.TP 2 -o -\f3If the reply is a single X.509 certificate\fP, \f3keytool\fP attempts to establish a trust chain, starting at the certificate reply and ending at a self\-signed certificate (belonging to a root CA). The certificate reply and the hierarchy of certificates used to authenticate the certificate reply form the new certificate chain of \f2alias\fP. If a trust chain cannot be established, the certificate reply is not imported. In this case, \f3keytool\fP does not print out the certificate and prompt the user to verify it, because it is very hard (if not impossible) for a user to determine the authenticity of the certificate reply. -.TP 2 -o -\f3If the reply is a PKCS#7 formatted certificate chain or a sequence of X.509 certificates\fP, the chain is ordered with the user certificate first followed by zero or more CA certificates. If the chain ends with a self\-signed root CA certificate and \f2\-trustcacerts\fP option was specified, \f3keytool\fP will attempt to match it with any of the trusted certificates in the keystore or the "cacerts" keystore file. If the chain does not end with a self\-signed root CA certificate and the \f2\-trustcacerts\fP option was specified, \f3keytool\fP will try to find one from the trusted certificates in the keystore or the "cacerts" keystore file and add it to the end of the chain. If the certificate is not found and \f2\-noprompt\fP option is not specified, the information of the last certificate in the chain is printed out, and the user is prompted to verify it. -.RE -.LP -If the public key in the certificate reply matches the user's public key already stored with under \f2alias\fP, the old certificate chain is replaced with the new certificate chain in the reply. The old chain can only be replaced if a valid \f2keypass\fP, the password used to protect the private key of the entry, is supplied. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it. -.LP -This command was named \f2\-import\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-importcert\fP, is preferred going forward. -.TP 3 -\-importkeystore \-srckeystore srckeystore \-destkeystore destkeystore {\-srcstoretype srcstoretype} {\-deststoretype deststoretype} [\-srcstorepass srcstorepass] [\-deststorepass deststorepass] {\-srcprotected} {\-destprotected} {\-srcalias srcalias {\-destalias destalias} [\-srckeypass srckeypass] [\-destkeypass destkeypass] } {\-noprompt} {\-srcProviderName src_provider_name} {\-destProviderName dest_provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Imports a single entry or all entries from a source keystore to a destination keystore. -.LP -When the \f2srcalias\fP option is provided, the command imports the single entry identified by the alias to the destination keystore. If a destination alias is not provided with \f2destalias\fP, then \f2srcalias\fP is used as the destination alias. If the source entry is protected by a password, \f2srckeypass\fP will be used to recover the entry. If \f2srckeypass\fP is not provided, then \f3keytool\fP will attempt to use \f2srcstorepass\fP to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. The destination entry will be protected using \f2destkeypass\fP. If \f2destkeypass\fP is not provided, the destination entry will be protected with the source entry password. -.LP -If the \f2srcalias\fP option is not provided, then all entries in the source keystore are imported into the destination keystore. Each destination entry will be stored under the alias from the source entry. If the source entry is protected by a password, \f2srcstorepass\fP will be used to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, the user will be prompted whether to skip the entry and continue, or to quit. The destination entry will be protected with the source entry password. -.LP -If the destination alias already exists in the destination keystore, the user is prompted to either overwrite the entry, or to create a new entry under a different alias name. -.LP -Note that if \f2\-noprompt\fP is provided, the user will not be prompted for a new destination alias. Existing entries will automatically be overwritten with the destination alias name. Finally, entries that can not be imported are automatically skipped and a warning is output. -.TP 3 -\-printcertreq {\-file file} -.LP -Prints the content of a PKCS #10 format certificate request, which can be generated by the keytool \-certreq command. The command reads the request from file; if omitted, from the standard input. -.RE -.LP -.SS -Exporting Data -.LP -.RS 3 -.TP 3 -\-certreq {\-alias alias} {\-dname dname} {\-sigalg sigalg} {\-file certreq_file} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a Certificate Signing Request (CSR), using the PKCS#10 format. -.LP -A CSR is intended to be sent to a certificate authority (CA). The CA will authenticate the certificate requestor (usually off\-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self\-signed certificate) in the keystore. -.LP -The private key associated with \f2alias\fP is used to create the PKCS#10 certificate request. In order to access the private key, the appropriate password must be provided, since private keys are protected in the keystore with a password. If \f2keypass\fP is not provided at the command line, and is different from the password used to protect the integrity of the keystore, the user is prompted for it. If dname is provided, it's used as the subject in the CSR. Otherwise, the X.500 Distinguished Name associated with alias is used. -.LP -\f2sigalg\fP specifies the algorithm that should be used to sign the CSR. -.LP -The CSR is stored in the file \f2certreq_file\fP. If no file is given, the CSR is output to stdout. -.LP -Use the \f2importcert\fP command to import the response from the CA. -.TP 3 -\-exportcert {\-alias alias} {\-file cert_file} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-rfc} {\-v} {\-protected} {\-Jjavaoption} -.LP -Reads (from the keystore) the certificate associated with \f2alias\fP, and stores it in the file \f2cert_file\fP. -.LP -If no file is given, the certificate is output to stdout. -.LP -The certificate is by default output in binary encoding, but will instead be output in the printable encoding format, as defined by the Internet RFC 1421 standard, if the \f2\-rfc\fP option is specified. -.LP -If \f2alias\fP refers to a trusted certificate, that certificate is output. Otherwise, \f2alias\fP refers to a key entry with an associated certificate chain. In that case, the first certificate in the chain is returned. This certificate authenticates the public key of the entity addressed by \f2alias\fP. -.LP -This command was named \f2\-export\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-exportcert\fP, is preferred going forward. -.RE +\f3([+-]nnn[ymdHMS])+\fR -.LP -.SS -Displaying Data -.LP -.RS 3 -.TP 3 -\-list {\-alias alias} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v | \-rfc} {\-protected} {\-Jjavaoption} -.LP -Prints (to stdout) the contents of the keystore entry identified by \f2alias\fP. If no alias is specified, the contents of the entire keystore are printed. -.LP -This command by default prints the SHA1 fingerprint of a certificate. If the \f2\-v\fP option is specified, the certificate is printed in human\-readable format, with additional information such as the owner, issuer, serial number, and any extensions. If the \f2\-rfc\fP option is specified, certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 standard -.LP -You cannot specify both \f2\-v\fP and \f2\-rfc\fP. -.TP 3 -\-printcert {\-file cert_file | \-sslserver host[:port]} {\-jarfile JAR_file {\-rfc} {\-v} {\-Jjavaoption} -.LP -Reads the certificate from the file \f2cert_file\fP, the SSL server located at \f2host:port\fP, or the signed JAR file \f2JAR_file\fP (with the option \f2\-jarfile\fP and prints its contents in a human\-readable format. When no port is specified, the standard HTTPS port 443 is assumed. Note that \f2\-sslserver\fP and \f2\-file\fP options cannot be provided at the same time. Otherwise, an error is reported. If neither option is given, the certificate is read from stdin. -.LP -If \f2\-rfc\fP is specified, keytool prints the certificate in PEM mode as defined by the Internet RFC 1421 standard. -.LP -If the certificate is read from a file or stdin, it may be either binary encoded or in printable encoding format, as defined by the Internet RFC 1421 standard -.LP -If the SSL server is behind a firewall, \f2\-J\-Dhttps.proxyHost=proxyhost\fP and \f2\-J\-Dhttps.proxyPort=proxyport\fP can be specified on the command line for proxy tunneling. See the -.na -\f2JSSE Reference Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html for more information. -.LP -\f3Note\fP: This option can be used independently of a keystore. -.TP 3 -\-printcrl \-file crl_ {\-v} -.LP -Reads the certificate revocation list (CRL) from the file \f2crl_file\fP. -.LP -A Certificate Revocation List (CRL) is a list of digital certificates which have been revoked by the Certificate Authority (CA) that issued them. The CA generates \f2crl_file\fP. -.LP -\f3Note\fP: This option can be used independently of a keystore. -.RE +\f3[yyyy/mm/dd] [HH:MM:SS]\fR -.LP -.SS -Managing the Keystore -.LP -.RS 3 -.TP 3 -\-storepasswd [\-new new_storepass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption} -.LP -Changes the password used to protect the integrity of the keystore contents. The new password is \f2new_storepass\fP, which must be at least 6 characters long. -.TP 3 -\-keypasswd {\-alias alias} [\-keypass old_keypass] [\-new new_keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption} -.LP -Changes the password under which the private/secret key identified by \f2alias\fP is protected, from \f2old_keypass\fP to \f2new_keypass\fP, which must be at least 6 characters long. -.LP -If the \f2\-keypass\fP option is not provided at the command line, and the key password is different from the keystore password, the user is prompted for it. -.LP -If the \f2\-new\fP option is not provided at the command line, the user is prompted for it. -.TP 3 -\-delete [\-alias alias] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Deletes from the keystore the entry identified by \f2alias\fP. The user is prompted for the alias, if no alias is provided at the command line. -.TP 3 -\-changealias {\-alias alias} [\-destalias destalias] [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Move an existing keystore entry from the specified \f2alias\fP to a new alias, \f2destalias\fP. If no destination alias is provided, the command will prompt for one. If the original entry is protected with an entry password, the password can be supplied via the "\-keypass" option. If no key password is provided, the \f2storepass\fP (if given) will be attempted first. If that attempt fails, the user will be prompted for a password. -.RE +With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: +.sp +.nf +\f3Calendar c = new GregorianCalendar();\fP +.fi +.nf +\f3c\&.add(Calendar\&.YEAR, \-1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.MONTH, 1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.DATE, \-1);\fP +.fi +.nf +\f3return c\&.getTime()\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SS -Getting Help -.LP -.RS 3 -.TP 3 -\-help -.LP -Lists the basic commands and their options. -.LP -For more information about a specific command, enter the following, where \f2command_name\fP is the name of the command: -.nf -\f3 -.fl - keytool \-\fP\f4command_name\fP\f3 \-help -.fl -\fP -.fi -.RE -.LP -.SH "EXAMPLES" -.LP -.LP -Suppose you want to create a keystore for managing your public/private key pair and certificates from entities you trust. -.LP -.SS -Generating Your Key Pair -.LP -.LP -The first thing you need to do is create a keystore and generate the key pair. You could use a command such as the following: -.LP -.nf -\f3 -.fl - keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US" -.fl - \-alias business \-keypass \fP\f4<new password for private key>\fP\f3 \-keystore /working/mykeystore -.fl - \-storepass \fP\f4<new password for keystore>\fP\f3 \-validity 180 -.fl -\fP -.fi +With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. -.LP -.LP -(Please note: This must be typed as a single line. Multiple lines are used in the examples just for legibility purposes.) -.LP -.LP -This command creates the keystore named "mykeystore" in the "working" directory (assuming it doesn't already exist), and assigns it the password specified by \f2<new password for keystore>\fP. It generates a public/private key pair for the entity whose "distinguished name" has a common name of "Mark Jones", organizational unit of "Java", organization of "Oracle" and two\-letter country code of "US". It uses the default "DSA" key generation algorithm to create the keys, both 1024 bits long. -.LP -.LP -It creates a self\-signed certificate (using the default "SHA1withDSA" signature algorithm) that includes the public key and the distinguished name information. This certificate will be valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias "business". The private key is assigned the password specified by \f2<new password for private key>\fP. -.LP -.LP -The command could be significantly shorter if option defaults were accepted. As a matter of fact, no options are required; defaults are used for unspecified options that have default values, and you are prompted for any required values. Thus, you could simply have the following: -.LP -.nf -\f3 -.fl - keytool \-genkeypair -.fl -\fP -.fi +When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. -.LP -.LP -In this case, a keystore entry with alias "mykey" is created, with a newly\-generated key pair and a certificate that is valid for 90 days. This entry is placed in the keystore named ".keystore" in your home directory. (The keystore is created if it doesn't already exist.) You will be prompted for the distinguished name information, the keystore password, and the private key password. -.LP -.LP -The rest of the examples assume you executed the \f2\-genkeypair\fP command without options specified, and that you responded to the prompts with values equal to those given in the first \f2\-genkeypair\fP command, above (for example, a distinguished name of "cn=Mark Jones, ou=Java, o=Oracle, c=US"). -.LP -.SS -Requesting a Signed Certificate from a Certification Authority -.LP -.LP -So far all we've got is a self\-signed certificate. A certificate is more likely to be trusted by others if it is signed by a Certification Authority (CA). To get such a signature, you first generate a Certificate Signing Request (CSR), via the following: -.LP -.nf -\f3 -.fl - keytool \-certreq \-file MarkJ.csr -.fl -\fP -.fi +The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. -.LP -.LP -This creates a CSR (for the entity identified by the default alias "mykey") and puts the request in the file named "MarkJ.csr". Submit this file to a CA, such as VeriSign, Inc. The CA will authenticate you, the requestor (usually off\-line), and then will return a certificate, signed by them, authenticating your public key. (In some cases, they will actually return a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain.) -.LP -.SS -Importing a Certificate for the CA -.LP -.LP -You need to replace your self\-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a "root" CA. -.LP -.LP -Before you import the certificate reply from a CA, you need one or more "trusted certificates" in your keystore or in the \f2cacerts\fP keystore file (which is described in importcert command): -.LP -.RS 3 -.TP 2 -o -If the certificate reply is a certificate chain, you just need the top certificate of the chain (that is, the "root" CA certificate authenticating that CA's public key). -.TP 2 -o -If the certificate reply is a single certificate, you need a certificate for the issuing CA (the one that signed it), and if that certificate is not self\-signed, you need a certificate for its signer, and so on, up to a self\-signed "root" CA certificate. -.RE +This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. +.TP +-genseckey +.br +\f3-genseckey {-alias alias} {-keyalg keyalg} {-keysize keysize} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -The "cacerts" keystore file ships with several VeriSign root CA certificates, so you probably won't need to import a VeriSign certificate as a trusted certificate in your keystore. But if you request a signed certificate from a different CA, and a certificate authenticating that CA's public key hasn't been added to "cacerts", you will need to import a certificate from the CA as a "trusted certificate". -.LP -.LP -A certificate from a CA is usually either self\-signed, or signed by another CA (in which case you also need a certificate authenticating that CA's public key). Suppose company ABC, Inc., is a CA, and you obtain a file named "ABCCA.cer" that is purportedly a self\-signed certificate from ABC, authenticating that CA's public key. -.LP -.LP -Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! View it first (using the \f3keytool\fP \f2\-printcert\fP command, or the \f3keytool\fP \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. You can call the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show (or that a secure public key repository shows). Only if the fingerprints are equal is it guaranteed that the certificate has not been replaced in transit with somebody else's (for example, an attacker's) certificate. If such an attack took place, and you did not check the certificate before you imported it, you would end up trusting anything the attacker has signed. -.LP -.LP -If you trust that the certificate is valid, then you can add it to your keystore via the following: -.LP -.nf -\f3 -.fl - keytool \-importcert \-alias abc \-file ABCCA.cer -.fl -\fP -.fi +Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. -.LP -.LP -This creates a "trusted certificate" entry in the keystore, with the data from the file "ABCCA.cer", and assigns the alias "abc" to the entry. -.LP -.SS -Importing the Certificate Reply from the CA -.LP -.LP -Once you've imported a certificate authenticating the public key of the CA you submitted your certificate signing request to (or there's already such a certificate in the "cacerts" file), you can import the certificate reply and thereby replace your self\-signed certificate with a certificate chain. This chain is the one returned by the CA in response to your request (if the CA reply is a chain), or one constructed (if the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the "cacerts" keystore file. -.LP -.LP -For example, suppose you sent your certificate signing request to VeriSign. You can then import the reply via the following, which assumes the returned certificate is named "VSMarkJ.cer": -.LP -.nf -\f3 -.fl - keytool \-importcert \-trustcacerts \-file VSMarkJ.cer -.fl -\fP -.fi +The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. +.TP +-importcert +.br +\f3-importcert {-alias alias} {-file cert_file} [-keypass keypass] {-noprompt} {-trustcacerts} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.SS -Exporting a Certificate Authenticating Your Public Key -.LP -.LP -Suppose you have used the jarsigner(1) tool to sign a Java ARchive (JAR) file. Clients that want to use the file will want to authenticate your signature. -.LP -.LP -One way they can do this is by first importing your public key certificate into their keystore as a "trusted" entry. You can export the certificate and supply it to your clients. As an example, you can copy your certificate to a file named \f2MJ.cer\fP via the following, assuming the entry is aliased by "mykey": -.LP -.nf -\f3 -.fl - keytool \-exportcert \-alias mykey \-file MJ.cer -.fl -\fP -.fi +Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. -.LP -.LP -Given that certificate, and the signed JAR file, a client can use the \f3jarsigner\fP tool to authenticate your signature. -.LP -.SS -Importing Keystore -.LP -.LP -The command "importkeystore" is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command. You can use this command to import entries from a different type of keystore. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys). If \f3keytool\fP has difficulties recover the private keys or secret keys from the source keystore, it will prompt you for a password. If it detects alias duplication, it will ask you for a new one, you can specify a new alias or simply allow \f3keytool\fP to overwrite the existing one. -.LP -.LP -For example, to import entries from a normal JKS type keystore key.jks into a PKCS #11 type hardware based keystore, you can use the command: -.LP -.nf -\f3 -.fl - keytool \-importkeystore -.fl - \-srckeystore key.jks \-destkeystore NONE -.fl - \-srcstoretype JKS \-deststoretype PKCS11 -.fl - \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3 -.fl -\fP -.fi +The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. -.LP -.LP -The importkeystore command can also be used to import a single entry from a source keystore to a destination keystore. In this case, besides the options you see in the above example, you need to specify the alias you want to import. With the srcalias option given, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want. The following command demonstrates this: -.LP -.nf -\f3 -.fl - keytool \-importkeystore -.fl - \-srckeystore key.jks \-destkeystore NONE -.fl - \-srcstoretype JKS \-deststoretype PKCS11 -.fl - \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3 -.fl - \-srcalias myprivatekey \-destalias myoldprivatekey -.fl - \-srckeypass \fP\f4<source entry password>\fP\f3 \-destkeypass \fP\f4<destination entry password>\fP\f3 -.fl - \-noprompt -.fl -\fP -.fi +You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. -.LP -.SS -Generating Certificates for a Typical SSL Server -.LP -.LP -The following are keytool commands to generate keypairs and certificates for three entities, namely, Root CA (root), Intermediate CA (ca), and SSL server (server). Ensure that you store all the certificates in the same keystore. In these examples, it is recommended that you specify RSA as the key algorithm. -.LP -.nf -\f3 -.fl -keytool \-genkeypair \-keystore root.jks \-alias root \-ext bc:c -.fl -keytool \-genkeypair \-keystore ca.jks \-alias ca \-ext bc:c -.fl -keytool \-genkeypair \-keystore server.jks \-alias server -.fl +Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. +.TP +-importpassword +.br +\f3{-alias alias} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.fl -keytool \-keystore root.jks \-alias root \-exportcert \-rfc > root.pem -.fl +Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. +.TP +-importkeystore +.br +\f3{-srcstoretype srcstoretype} {-deststoretype deststoretype} [-srcstorepass srcstorepass] [-deststorepass deststorepass] {-srcprotected} {-destprotected} {-srcalias srcalias {-destalias destalias} [-srckeypass srckeypass] } [-destkeypass destkeypass] {-noprompt} {-srcProviderName src_provider_name} {-destProviderName dest_provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.fl -keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-certreq \-alias ca | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore root.jks \-gencert \-alias root \-ext BC=0 \-rfc > ca.pem -.fl -keytool \-keystore ca.jks \-importcert \-alias ca \-file ca.pem -.fl +Imports a single entry or all entries from a source keystore to a destination keystore\&. -.fl -keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore server.jks \-certreq \-alias server | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-gencert \-alias ca \-ext ku:c=dig,kE \-rfc > server.pem -.fl -cat root.pem ca.pem server.pem | keytool \-keystore server.jks \-importcert \-alias server -.fl -\fP -.fi +When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. -.LP -.SH "TERMINOLOGY and WARNINGS" -.LP -.SS -KeyStore -.LP -.LP -A keystore is a storage facility for cryptographic keys and certificates. -.LP -.RS 3 -.TP 2 -o -\f3KeyStore Entries\fP -.LP -Keystores may have different types of entries. The two most applicable entry types for \f3keytool\fP include: -.RS 3 -.TP 3 -1. -\f3key entries\fP \- each holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate "chain" for the corresponding public key. The \f3keytool\fP can handle both types of entries, while the \f3jarsigner\fP tool only handle the latter type of entry, that is private keys and their associated certificate chains. -.TP 3 -2. -\f3trusted certificate entries\fP \- each contains a single public key certificate belonging to another party. It is called a "trusted certificate" because the keystore owner trusts that the public key in the certificate indeed belongs to the identity identified by the "subject" (owner) of the certificate. The issuer of the certificate vouches for this, by signing the certificate. -.RE -.TP 2 -o -\f3KeyStore Aliases\fP -.LP -All keystore entries (key and trusted certificate entries) are accessed via unique \f2aliases\fP. -.LP -An alias is specified when you add an entity to the keystore using the \-genseckey command to generate a secret key, \-genkeypair command to generate a key pair (public and private key) or the \-importcert command to add a certificate or certificate chain to the list of trusted certificates. Subsequent \f3keytool\fP commands must use this same alias to refer to the entity. -.LP -For example, suppose you use the alias \f2duke\fP to generate a new public/private key pair and wrap the public key into a self\-signed certificate (see Certificate Chains) via the following command: -.nf -\f3 -.fl - keytool \-genkeypair \-alias duke \-keypass dukekeypasswd -.fl -\fP -.fi -.LP -This specifies an initial password of "dukekeypasswd" required by subsequent commands to access the private key associated with the alias \f2duke\fP. If you later want to change duke's private key password, you use a command like the following: -.nf -\f3 -.fl - keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass -.fl -\fP -.fi -.LP -This changes the password from "dukekeypasswd" to "newpass". -.LP -Please note: A password should not actually be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system. If you don't specify a required password option on a command line, you will be prompted for it. -.TP 2 -o -\f3KeyStore Implementation\fP -.LP -The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore. -.LP -Currently, two command\-line tools (\f3keytool\fP and \f3jarsigner\fP) and a GUI\-based tool named \f3Policy Tool\fP make use of keystore implementations. Since \f2KeyStore\fP is publicly available, users can write additional security applications that use it. -.LP -There is a built\-in default implementation, provided by Oracle. It implements the keystore as a file, utilizing a proprietary keystore type (format) named "JKS". It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password. -.LP -Keystore implementations are provider\-based. More specifically, the application interfaces supplied by \f2KeyStore\fP are implemented in terms of a "Service Provider Interface" (SPI). That is, there is a corresponding abstract \f2KeystoreSpi\fP class, also in the \f2java.security\fP package, which defines the Service Provider Interface methods that "providers" must implement. (The term "provider" refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API.) Thus, to provide a keystore implementation, clients must implement a "provider" and supply a KeystoreSpi subclass implementation, as described in -.na -\f2How to Implement a Provider for the Java Cryptography Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html. -.LP -Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible. -.LP -\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL. -.LP -For \f3keytool\fP and \f3jarsigner\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Keystore" menu. -.LP -If you don't explicitly specify a keystore type, the tools choose a keystore implementation based simply on the value of the \f2keystore.type\fP property specified in the security properties file. The security properties file is called \f2java.security\fP, and it resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -Each tool gets the \f2keystore.type\fP value and then examines all the currently\-installed providers until it finds one that implements keystores of that type. It then uses the keystore implementation from that provider. -.LP -The \f2KeyStore\fP class defines a static method named \f2getDefaultType\fP that lets applications and applets retrieve the value of the \f2keystore.type\fP property. The following line of code creates an instance of the default keystore type (as specified in the \f2keystore.type\fP property): -.nf -\f3 -.fl - KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); -.fl -\fP -.fi -.LP -The default keystore type is "jks" (the proprietary type of the keystore implementation provided by Oracle). This is specified by the following line in the security properties file: -.nf -\f3 -.fl - keystore.type=jks -.fl -\fP -.fi -.LP -To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type. -.LP -For example, if you have a provider package that supplies a keystore implementation for a keystore type called "pkcs12", change the line to -.nf -\f3 -.fl - keystore.type=pkcs12 -.fl -\fP -.fi -.LP -Note: case doesn't matter in keystore type designations. For example, "JKS" would be considered the same as "jks". -.RE +If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. -.LP -.SS +If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. + +If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. +.TP +-printcertreq +.br +\f3{-file file}\fR + +Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. +.TP +-certreq +.br +\f3{-alias alias} {-dname dname} {-sigalg sigalg} {-file certreq_file} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. + +A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. + +The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. + +The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. + +Use the \f3importcert\fR command to import the response from the CA\&. +.TP +-exportcert +.br +\f3{-alias alias} {-file cert_file} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-rfc} {-v} {-protected} {-Jjavaoption}\fR + +Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. + +The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. + +This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. +.TP +-list +.br +\f3{-alias alias} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v | -rfc} {-protected} {-Jjavaoption}\fR + +Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. + +This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +You cannot specify both \f3-v\fR and \f3-rfc\fR\&. +.TP +-printcert +.br +\f3{-file cert_file | -sslserver host[:port]} {-jarfile JAR_file {-rfc} {-v} {-Jjavaoption}\fR + +Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. + +When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. + +If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. + +If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-printcrl +.br +\f3-file crl_ {-v}\fR + +Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-storepasswd +.br +\f3[-new new_storepass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-Jjavaoption}\fR + +Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. +.TP +-keypasswd +.br +\f3{-alias alias} [-keypass old_keypass] [-new new_keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-Jjavaoption}\fR + +Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. + +If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. + +If the \f3-new\fR option is not provided at the command line, then the user is prompted for it +.TP +-delete +.br +\f3[-alias alias] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. +.TP +-changealias +.br +\f3{-alias alias} [-destalias destalias] [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. +.TP +-help +.br +Lists the basic commands and their options\&. + +For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. +.SH EXAMPLES +This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. +.SS GENERATE\ THE\ KEY\ PAIR +First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: +.sp +.nf +\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP +.fi +.nf +\f3 \-alias business \-keypass <new password for private key>\fP +.fi +.nf +\f3 \-keystore /working/mykeystore\fP +.fi +.nf +\f3 \-storepass <new password for keystore> \-validity 180\fP +.fi +.nf +\f3\fP +.fi +.sp +The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. +.PP +The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. +.PP +The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: +.sp +.nf +\f3keytool \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp +In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. +.PP +The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. +.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA +Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: +.sp +.nf +\f3keytool \-certreq \-file MarkJ\&.csr\fP +.fi +.nf +\f3\fP +.fi +.sp +This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. +.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA +You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. +.PP +Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. +.TP 0.2i +\(bu +If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. +.TP 0.2i +\(bu +If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. +.PP +The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. +.PP +A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. +.PP +If you trust that the certificate is valid, then you can add it to your keystore with the following command: +.sp +.nf +\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. +.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA +After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. +.PP +For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: +.sp +.nf +\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY +If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. +.PP +You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: +.sp +.nf +\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. +.SS IMPORT\ KEYSTORE +The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. +.PP +For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP +.fi +.nf +\f3 \-srckeypass <source entry password>\fP +.fi +.nf +\f3 \-destkeypass <destination entry password>\fP +.fi +.nf +\f3 \-noprompt\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER +The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. +.sp +.nf +\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP +.fi +.nf +\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP +.fi +.nf +\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP +.fi +.nf +\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP +.fi +.nf +\f3cat root\&.pem ca\&.pem server\&.pem |\fP +.fi +.nf +\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH TERMS +.TP +Keystore +A keystore is a storage facility for cryptographic keys and certificates\&. +.TP +Keystore entries +Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: + +\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. + +\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. +.TP +KeyStore aliases +All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. + +An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. + +For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. +.sp +.nf +\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: +.sp +.nf +\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. +.TP +KeyStore implementation +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies well-defined interfaces to access and modify the information in a keystore\&. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular type of keystore\&. + +Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. + +There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. + +Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html + +Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. + +The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. + +For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. + +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. + +Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. +.TP Certificate -.LP -A \f3certificate\fP (also known as a \f3public\-key certificate\fP) is a digitally signed statement from one entity (the \f2issuer\fP), saying that the public key (and some other information) of another entity (the \f2subject\fP) has some specific value. -.RS 3 -.TP 2 -o -\f3Certificate Terms\fP -.RS 3 -.TP 3 -Public Keys -.LP -These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity. Public keys are used to verify signatures. -.TP 3 -Digitally Signed -.LP -If some data is \f2digitally signed\fP it has been stored with the "identity" of an entity, and a signature that proves that entity knows about the data. The data is rendered unforgeable by signing with the entity's private key. -.TP 3 -Identity -.LP -A known way of addressing an entity. In some systems the identity is the public key, in others it can be anything from a Unix UID to an Email address to an X.509 Distinguished Name. -.TP 3 -Signature -.LP -A signature is computed over some data using the private key of an entity (the \f2signer\fP, which in the case of a certificate is also known as the \f2issuer\fP). -.TP 3 -Private Keys -.LP -These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it's supposed to be kept secret). Private and public keys exist in pairs in all public key cryptography systems (also referred to as "public key crypto systems"). In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key. Private keys are used to compute signatures. -.TP 3 -Entity -.LP -An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree. -.RE -.LP -Basically, public key cryptography requires access to users' public keys. In a large\-scale networked environment it is impossible to guarantee that prior relationships between communicating entities have been established or that a trusted repository exists with all used public keys. Certificates were invented as a solution to this public key distribution problem. Now a \f2Certification Authority\fP (CA) can act as a trusted third party. CAs are entities (for example, businesses) that are trusted to sign (issue) certificates for other entities. It is assumed that CAs will only create valid and reliable certificates, as they are bound by legal agreements. There are many public Certification Authorities, such as -.na -\f2VeriSign\fP @ -.fi -http://www.verisign.com/, -.na -\f2Thawte\fP @ -.fi -http://www.thawte.com/, -.na -\f2Entrust\fP @ -.fi -http://www.entrust.com/, and so on. You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization. -.LP -Using \f3keytool\fP, it is possible to display, import, and export certificates. It is also possible to generate self\-signed certificates. -.LP -\f3keytool\fP currently handles X.509 certificates. -.TP 2 -o -\f3X.509 Certificates\fP -.LP -The X.509 standard defines what information can go into a certificate, and describes how to write it down (the data format). All the data in a certificate is encoded using two related standards called ASN.1/DER. \f2Abstract Syntax Notation 1\fP describes data. The \f2Definite Encoding Rules\fP describe a single way to store and transfer that data. -.LP -All X.509 certificates have the following data, in addition to the signature: -.RS 3 -.TP 3 -Version -.LP -This identifies which version of the X.509 standard applies to this certificate, which affects what information can be specified in it. Thus far, three versions are defined. \f3keytool\fP can import and export v1, v2, and v3 certificates. It generates v3 certificates. -.LP -\f2X.509 Version 1\fP has been available since 1988, is widely deployed, and is the most generic. -.LP -\f2X.509 Version 2\fP introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject and/or issuer names over time. Most certificate profile documents strongly recommend that names not be reused, and that certificates should not make use of unique identifiers. Version 2 certificates are not widely used. -.LP -\f2X.509 Version 3\fP is the most recent (1996) and supports the notion of extensions, whereby anyone can define an extension and include it in the certificate. Some common extensions in use today are: \f2KeyUsage\fP (limits the use of the keys to particular purposes such as "signing\-only") and \f2AlternativeNames\fP (allows other identities to also be associated with this public key, e.g. DNS names, Email addresses, IP addresses). Extensions can be marked \f2critical\fP to indicate that the extension should be checked and enforced/used. For example, if a certificate has the KeyUsage extension marked critical and set to "keyCertSign" then if this certificate is presented during SSL communication, it should be rejected, as the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use. -.TP 3 -Serial Number -.LP -The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues. This information is used in numerous ways, for example when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL). -.TP 3 -Signature Algorithm Identifier -.LP -This identifies the algorithm used by the CA to sign the certificate. -.TP 3 -Issuer Name -.LP -The X.500 Distinguished Name of the entity that signed the certificate. This is normally a CA. Using this certificate implies trusting the entity that signed this certificate. (Note that in some cases, such as \f2root or top\-level\fP CA certificates, the issuer signs its own certificate.) -.TP 3 -Validity Period -.LP -Each certificate is valid only for a limited amount of time. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate or the amount one is willing to pay for a certificate. This is the expected period that entities can rely on the public value, if the associated private key has not been compromised. -.TP 3 -Subject Name -.LP -The name of the entity whose public key the certificate identifies. This name uses the X.500 standard, so it is intended to be unique across the Internet. This is the X.500 Distinguished Name (DN) of the entity, for example, -.nf -\f3 -.fl - CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US -.fl -\fP -.fi -.LP -(These refer to the subject's Common Name, Organizational Unit, Organization, and Country.) -.TP 3 -Subject Public Key Information -.LP -This is the public key of the entity being named, together with an algorithm identifier which specifies which public key crypto system this key belongs to and any associated key parameters. -.RE -.TP 2 -o -\f3Certificate Chains\fP -.LP -\f3keytool\fP can create and manage keystore "key" entries that each contain a private key and an associated certificate "chain". The first certificate in the chain contains the public key corresponding to the private key. -.LP -When keys are first generated (see the \-genkeypair command), the chain starts off containing a single element, a \f2self\-signed certificate\fP. A self\-signed certificate is one for which the issuer (signer) is the same as the subject (the entity whose public key is being authenticated by the certificate). Whenever the \f2\-genkeypair\fP command is called to generate a new public/private key pair, it also wraps the public key into a self\-signed certificate. -.LP -Later, after a Certificate Signing Request (CSR) has been generated (see the \-certreq command) and sent to a Certification Authority (CA), the response from the CA is imported (see \-importcert), and the self\-signed certificate is replaced by a chain of certificates. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject's public key. The next certificate in the chain is one that authenticates the \f2CA\fP's public key. -.LP -In many cases, this is a self\-signed certificate (that is, a certificate from the CA authenticating its own public key) and the last certificate in the chain. In other cases, the CA may return a chain of certificates. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a \f2different\fP CA, authenticating the public key of the CA you sent the CSR to. Then, the next certificate in the chain will be a certificate authenticating the second CA's key, and so on, until a self\-signed "root" certificate is reached. Each certificate in the chain (after the first) thus authenticates the public key of the signer of the previous certificate in the chain. -.LP -Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs). In this case, the certificate chain must be established from trusted certificate information already stored in the keystore. -.LP -A different reply format (defined by the PKCS#7 standard) also includes the supporting certificate chain, in addition to the issued certificate. Both reply formats can be handled by \f3keytool\fP. -.LP -The top\-level (root) CA certificate is self\-signed. However, the trust into the root's public key does not come from the root certificate itself (anybody could generate a self\-signed certificate with the distinguished name of say, the VeriSign root CA!), but from other sources like a newspaper. The root CA public key is widely known. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a "vehicle" to transport the root CA's public key. Before you add the root CA certificate to your keystore, you should view it (using the \f2\-printcert\fP option) and compare the displayed fingerprint with the well\-known fingerprint (obtained from a newspaper, the root CA's Web page, etc.). -.TP 2 -o -\f3The cacerts Certificates File\fP -.LP -A certificates file named \f3"cacerts"\fP resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -The "cacerts" file represents a system\-wide keystore with CA certificates. System administrators can configure and manage that file using \f3keytool\fP, specifying "jks" as the keystore type. The "cacerts" keystore file ships with a default set of root CA certificates; list them with the following command: -.nf -\f3 -.fl -keytool \-list \-keystore \fP\f4java.home\fP\f3/lib/security/cacerts -.fl -\fP -.fi -.LP -The initial password of the "cacerts" keystore file is "changeit". System administrators should change that password and the default access permission of that file upon installing the SDK. -.LP -\f3IMPORTANT: Verify Your \fP\f4cacerts\fP\f3 File\fP: Since you trust the CAs in the \f2cacerts\fP file as entities for signing and issuing certificates to other entities, you must manage the \f2cacerts\fP file carefully. The \f2cacerts\fP file should contain only certificates of the CAs you trust. It is your responsibility to verify the trusted root CA certificates bundled in the \f2cacerts\fP file and make your own trust decisions. To remove an untrusted CA certificate from the \f2cacerts\fP file, use the delete option of the \f2keytool\fP command. You can find the \f2cacerts\fP file in the JRE installation directory. Contact your system administrator if you do not have permission to edit this file. -.TP 2 -o -\f3The Internet RFC 1421 Certificate Encoding Standard\fP -.LP -Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding. This certificate format, also known as "Base 64 encoding", facilitates exporting certificates to other applications by email or through some other mechanism. -.LP -Certificates read by the \f2\-importcert\fP and \f2\-printcert\fP commands can be in either this format or binary encoded. -.LP -The \f2\-exportcert\fP command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, if the \f2\-rfc\fP option is specified. -.LP -The \f2\-list\fP command by default prints the SHA1 fingerprint of a certificate. If the \f2\-v\fP option is specified, the certificate is printed in human\-readable format, while if the \f2\-rfc\fP option is specified, the certificate is output in the printable encoding format. -.LP -In its printable encoding format, the encoded certificate is bounded at the beginning by -.nf -\f3 -.fl -\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\- -.fl -\fP -.fi -.LP -and at the end by -.nf -\f3 -.fl -\-\-\-\-\-END CERTIFICATE\-\-\-\-\- -.fl -\fP -.fi -.RE +A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: -.LP -.SS -X.500 Distinguished Names -.LP -.LP -X.500 Distinguished Names are used to identify entities, such as those which are named by the \f2subject\fP and \f2issuer\fP (signer) fields of X.509 certificates. \f3keytool\fP supports the following subparts: -.LP -.RS 3 -.TP 2 -o -\f2commonName\fP \- common name of a person, e.g., "Susan Jones" -.TP 2 -o -\f2organizationUnit\fP \- small organization (e.g., department or division) name, e.g., "Purchasing" -.TP 2 -o -\f2organizationName\fP \- large organization name, e.g., "ABCSystems, Inc." -.TP 2 -o -\f2localityName\fP \- locality (city) name, e.g., "Palo Alto" -.TP 2 -o -\f2stateName\fP \- state or province name, e.g., "California" -.TP 2 -o -\f2country\fP \- two\-letter country code, e.g., "CH" -.RE +\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. -.LP -.LP -When supplying a distinguished name string as the value of a \f2\-dname\fP option, as for the \f2\-genkeypair\fP command, the string must be in the following format: -.LP -.nf -\f3 -.fl -CN=\fP\f4cName\fP\f3, OU=\fP\f4orgUnit\fP\f3, O=\fP\f4org\fP\f3, L=\fP\f4city\fP\f3, S=\fP\f4state\fP\f3, C=\fP\f4countryCode\fP\f3 -.fl -\fP -.fi +\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. -.LP -.LP -where all the italicized items represent actual values and the above keywords are abbreviations for the following: -.LP -.nf -\f3 -.fl - CN=commonName -.fl - OU=organizationUnit -.fl - O=organizationName -.fl - L=localityName -.fl - S=stateName -.fl - C=country -.fl -\fP -.fi +\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. -.LP -.LP -A sample distinguished name string is -.LP -.nf -\f3 -.fl -CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US -.fl -\fP -.fi +\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. -.LP -.LP -and a sample command using such a string is -.LP -.nf -\f3 -.fl -keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, -.fl -S=California, C=US" \-alias mark -.fl -\fP -.fi +\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. -.LP -.LP -Case does not matter for the keyword abbreviations. For example, "CN", "cn", and "Cn" are all treated the same. -.LP -.LP -Order matters; each subcomponent must appear in the designated order. However, it is not necessary to have all the subcomponents. You may use a subset, for example: -.LP -.nf -\f3 -.fl -CN=Steve Meier, OU=Java, O=Oracle, C=US -.fl -\fP -.fi +\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. -.LP -.LP -If a distinguished name string value contains a comma, the comma must be escaped by a "\\" character when you specify the string on a command line, as in -.LP -.nf -\f3 -.fl - cn=Peter Schuster, ou=Java\\, Product Development, o=Oracle, c=US -.fl -\fP -.fi +Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. -.LP -.LP -It is never necessary to specify a distinguished name string on a command line. If it is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents. In this case, a comma does not need to be escaped by a "\\". -.LP -.SS -WARNING Regarding Importing Trusted Certificates -.LP -.LP -IMPORTANT: Be sure to check a certificate very carefully before importing it as a trusted certificate! -.LP -.LP -View it first (using the \f2\-printcert\fP command, or the \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. For example, suppose someone sends or emails you a certificate, and you put it in a file named \f2/tmp/cert\fP. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f2\-printcert\fP command to view its fingerprints, as in -.LP -.nf -\f3 -.fl - keytool \-printcert \-file /tmp/cert -.fl - Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll -.fl - Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll -.fl - Serial Number: 59092b34 -.fl - Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997 -.fl - Certificate Fingerprints: -.fl - MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F -.fl - SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE -.fl - SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90: -.fl - 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4 -.fl -\fP -.fi +You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. -.LP -.LP -Then call or otherwise contact the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show. Only if the fingerprints are equal is it guaranteed that the certificate has not been replaced in transit with somebody else's (for example, an attacker's) certificate. If such an attack took place, and you did not check the certificate before you imported it, you would end up trusting anything the attacker has signed (for example, a JAR file with malicious class files inside). -.LP -.LP -Note: it is not required that you execute a \f2\-printcert\fP command prior to importing a certificate, since before adding a certificate to the list of trusted certificates in the keystore, the \f2\-importcert\fP command prints out the certificate information and prompts you to verify it. You then have the option of aborting the import operation. Note, however, this is only the case if you invoke the \f2\-importcert\fP command without the \f2\-noprompt\fP option. If the \f2\-noprompt\fP option is given, there is no interaction with the user. -.LP -.SS -Warning Regarding Passwords -.LP -.LP -Most commands operating on a keystore require the store password. Some commands require a private/secret key password. -.LP -.LP -Passwords can be specified on the command line (in the \f2\-storepass\fP and \f2\-keypass\fP options, respectively). However, a password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system. -.LP -.LP -If you don't specify a required password option on a command line, you will be prompted for it. -.LP -.SS -Warning Regarding Certificate Conformance -.LP -.LP -The Internet standard -.na -\f2RFC 5280\fP @ -.fi -http://tools.ietf.org/rfc/rfc5280.txt has defined a profile on conforming X.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions. \f3keytool\fP has not enforced all these rules so it can generate certificates which do not conform to the standard, and these certificates might be rejected by JRE or other applications. Users should make sure that they provide the correct options for \f2\-dname\fP, \f2\-ext\fP, etc. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jar(1) tool documentation -.TP 2 -o -jarsigner(1) tool documentation -.TP 2 -o -the -.na -\f4Security\fP @ -.fi -http://download.oracle.com/javase/tutorial/security/index.html trail of the -.na -\f4Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/ for examples of the use of \f3keytool\fP -.RE +The \f3keytool\fR command currently handles X\&.509 certificates\&. +.TP +X\&.509 Certificates +The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. -.LP -.SH "CHANGES" -.LP -.LP -The command interface for keytool changed in Java SE 6. -.LP -.LP -\f3keytool\fP no longer displays password input when entered by users. Since password input can no longer be viewed when entered, users will be prompted to re\-enter passwords any time a password is being set or changed (for example, when setting the initial keystore password, or when changing a key password). -.LP -.LP -Some commands have simply been renamed, and other commands deemed obsolete are no longer listed in this document. All previous commands (both renamed and obsolete) are still supported in this release and will continue to be supported in future releases. The following summarizes all of the changes made to the keytool command interface: -.LP -.LP -Renamed commands: -.LP -.RS 3 -.TP 2 -o -\f2\-export\fP, renamed to \f2\-exportcert\fP -.TP 2 -o -\f2\-genkey\fP, renamed to \f2\-genkeypair\fP -.TP 2 -o -\f2\-import\fP, renamed to \f2\-importcert\fP -.RE +All X\&.509 certificates have the following data, in addition to the signature: -.LP -.LP -Commands deemed obsolete and no longer documented: -.LP -.RS 3 -.TP 2 -o -.na -\f2\-keyclone\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#keycloneCmd -.TP 2 -o -.na -\f2\-identitydb\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#identitydbCmd -.TP 2 -o -.na -\f2\-selfcert\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#selfcertCmd -.RE +\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. -.LP +X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. +X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. + +X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. + +\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. + +\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. + +\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. + +\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. + +\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, +.sp +.nf +\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. + +\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. +.TP +Certificate Chains +The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. + +When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. + +Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. + +In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. + +Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. + +A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. + +The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. +.TP +The cacerts Certificates File +A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. + +The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: +.sp +.nf +\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. + +\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. + +To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file +.TP +Internet RFC 1421 Certificate Encoding Standard +Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. + +Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. + +The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. + +In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: +.sp +.nf +\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3encoded certificate goes here\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +X\&.500 Distinguished Names +X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: + +\fIcommonName\fR: The common name of a person such as Susan Jones\&. + +\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. + +\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. + +\fIstateName\fR: State or province name, for example, California\&. + +\fIcountry\fR: Two-letter country code, for example, CH\&. + +When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: +.sp +.nf +\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP +.fi +.nf +\f3\fP +.fi +.sp + + +All the italicized items represent actual values and the previous keywords are abbreviations for the following: +.sp +.nf +\f3CN=commonName\fP +.fi +.nf +\f3OU=organizationUnit\fP +.fi +.nf +\f3O=organizationName\fP +.fi +.nf +\f3L=localityName\fP +.fi +.nf +\f3S=stateName\fP +.fi +.nf +\f3C=country\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample distinguished name string is: +.sp +.nf +\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample command using such a string is: +.sp +.nf +\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP +.fi +.nf +\f3S=California, C=US" \-alias mark\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. + +Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: +.sp +.nf +\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: +.sp +.nf +\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. +.SH WARNINGS +.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING +\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. +.PP +Windows Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file \etmp\ecert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.sp + +.PP +Oracle Solaris Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file /tmp/cert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.nf +\f3\fP +.fi +.sp +Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. +.PP +\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS PASSWORDS\ WARNING +Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. +.SS CERTIFICATE\ CONFORMANCE\ WARNING +The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt +.PP +The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. +.SH NOTES +.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE +Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. +.PP +If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. +.PP +If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS IMPORT\ A\ CERTIFICATE\ REPLY +When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. +.PP +The methods of determining whether the certificate reply is trusted are as follows: +.TP 0.2i +\(bu +If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. +.TP 0.2i +\(bu +If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. +.PP +If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. +.PP +This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/native2ascii.1 b/jdk/src/bsd/doc/man/native2ascii.1 index 2f8ee81f158..7e7ec7cfaa9 100644 --- a/jdk/src/bsd/doc/man/native2ascii.1 +++ b/jdk/src/bsd/doc/man/native2ascii.1 @@ -1,72 +1,87 @@ -." Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH native2ascii 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Internationalization Tools +.\" Title: native2ascii.1 +.\" +.if n .pl 99999 +.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -native2ascii \- Native\-to\-ASCII Converter -.LP -.LP -Converts a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes, or visa versa. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f4native2ascii\fP\f2 [options] [inputfile [outputfile]]\fP -.fl -.fi +.SH NAME +native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f2native2ascii\fP converts files that are encoded to any character encoding that is supported by the Java runtime environment to files encoded in ASCII, using Unicode escapes ("\\uxxxx" notation) for all characters that are not part of the ASCII character set. This process is required for properties files containing characters not in ISO\-8859\-1 character sets. The tool can also perform the reverse conversion. -.LP -.LP -If \f2outputfile\fP is omitted, standard output is used for output. If, in addition, \f2inputfile\fP is omitted, standard input is used for input. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-reverse -Perform the reverse operation: Convert a file encoded in ISO\-8859\-1 with Unicode escapes to a file in any character encoding supported by the Java runtime environment. +\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] +.fi +.sp +.TP +\fIinputfile\fR +The encoded file to be converted to ASCII\&. +.TP +\fIoutputfile\fR +The converted ASCII file\&. +.SH DESCRIPTION +The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. +.PP +If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. +.SH OPTIONS +.TP +-reverse .br +Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. +.TP +-encoding \fIencoding_name\fR .br -.TP 3 -\-encoding encoding_name -Specifies the name of the character encoding to be used by the conversion procedure. If this option is not present, the default character encoding (as determined by the \f2java.nio.charset.Charset.defaultCharset\fP method) is used. The \f2encoding_name\fP string must be the name of a character encoding that is supported by the Java runtime environment \- see the -.na -\f4Supported Encodings\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html document. +Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html +.TP +-J\fIoption\fR .br -.br -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP - +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/orbd.1 b/jdk/src/bsd/doc/man/orbd.1 index 93f3a096669..1575df4bdea 100644 --- a/jdk/src/bsd/doc/man/orbd.1 +++ b/jdk/src/bsd/doc/man/orbd.1 @@ -1,368 +1,214 @@ -." Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH orbd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: orbd.1 +.\" +.if n .pl 99999 +.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -orbd \- The Object Request Broker Daemon -.LP -.LP -\f3orbd\fP is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. -.LP -.LP -\f3See also:\fP -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -orbd <\fP\f3options\fP\f3> -.fl -\fP -.fi +.SH NAME +orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The Server Manager included with the \f3orbd\fP tool is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. The persistent servers, while publishing the persistent object references in the Naming Service, include the port number of the ORBD in the object reference instead of the port number of the Server. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages: -.LP -.RS 3 -.TP 2 -o -The object reference in the Naming Service remains independent of the server life cycle. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shutdown, the ORBD will always return the correct object reference to the invoking client. -.TP 2 -o -The client needs to lookup the object reference in the Naming Service only once, and can keep re\-using this reference independent of the changes introduced due to server life cycle. -.RE - -.LP -.LP -To access ORBD's Server Manager, the server must be started using servertool(1), which is a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. For more information on the Server Manager, see the section in this document titled \f2Server Manager\fP. -.LP -.LP -When \f2orbd\fP starts up, it also starts a naming service. For more information on the naming service, link to -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html. -.LP -.SH "OPTIONS" -.LP -.SS -Required Options -.LP -.RS 3 -.TP 3 -\-ORBInitialPort nameserverport -Specifies the port on which the name server should be started. Once started, \f2orbd\fP will listen for incoming requests on this port. Note that when using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. (required) -.RE - -.LP -.LP - -.LP -.SS -OTHER OPTIONS -.LP -.RS 3 -.TP 3 -\-port port -Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects. The default value for this port is 1049. This port number is added to the port field of the persistent Interoperable Object References (IOR). (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-defaultdb directory -Specifies the base where the ORBD persistent storage directory \f2orb.db\fP is created. If this option is not specified, the default value is "./orb.db". (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-serverPollingTime milliseconds -Specifies how often ORBD checks for the health of persistent servers registered via \f2servertool\fP. The default value is 1,000 ms. The value specified for \f2milliseconds\fP must be a valid positive integer. (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-serverStartupDelay milliseconds -Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered via \f2servertool\fP is restarted. The default value is 1,000 ms. The value specified for \f2milliseconds\fP must be a valid positive integer. (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.TP 3 - -.RE - -.LP -.SH "Starting and Stopping the Naming Service" -.LP -.LP -A Naming Service is a CORBA service that allows -.na -\f2CORBA objects\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#CORBA%20object to be named by means of binding a name to an object reference. The -.na -\f2name binding\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#name%20binding may be stored in the naming service, and a client may supply the name to obtain the desired object reference. -.LP -.LP -Prior to running a client or a server, you will start ORBD. ORBD includes a persistent Naming Service and a transient Naming Service, both of which are an implementation of the COS Naming Service. -.LP -.LP -The \f4Persistent\fP\f3 Naming Service\fP provides persistence for naming contexts. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure. If ORBD is restarted, the Persistent Naming Service will restore the naming context graph, so that the binding of all clients' and servers' names remains intact (persistent). -.LP -.LP -\ -.LP -.LP -For backward compatibility, \f2tnameserv\fP, a \f4Transient\fP\f3 Naming Service\fP shipped with older versions of the JDK, is also included in this release of J2SE. A transient naming service retains naming contexts as long as it is running. If there is a service interruption, the naming context graph is lost. -.LP -.LP -The \f2\-ORBInitialPort\fP argument is a required command\-line argument for \f2orbd\fP, and is used to set the port number on which the Naming Service will run. The following instructions assume you can use port 1050 for the Java\ IDL Object Request Broker Daemon. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. You can substitute a different port if necessary. -.LP -.LP -To start \f2orbd\fP from a UNIX command shell, enter: -.LP -.nf -\f3 -.fl - orbd \-ORBInitialPort 1050& -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Now that ORBD is running, you can run your server and client applications. When running the client and server applications, they must be made aware of the port number (and machine name, if applicable) where the Naming Service is running. One way to do this is to add the following code to your application: -.LP -.nf -\f3 -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - props.put("org.omg.CORBA.ORBInitialHost", "MyHost"); -.fl - ORB orb = ORB.init(args, props); -.fl -\fP -.fi - -.LP -.LP -In this example, the Naming Service is running on port 1050 on host "MyHost". Another way is to specify the port number and/or machine name when running the server or client application from the command line. For example, you would start your "HelloApplication" with the following command line: -.LP -.nf -\f3 -.fl - java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost -.fl -\fP -.fi - -.LP -.LP -To stop the naming service, use the relevant operating system command, such as \f2pkill orbd\fP on Solaris, or \f2Ctrl+C\fP in the DOS window in which \f2orbd\fP is running. Note that names registered with the naming service may disappear when the service is terminated if the naming service is transient. The Java IDL naming service will run until it is explicitly stopped. -.LP -.LP -For more information on the Naming Service included with ORBD, see -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html. -.LP -.SH "Server Manager" -.LP -.LP -To access ORBD's Server Manager and run a persistent server, the server must be started using servertool(1), which is a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. When a server is started using \f2servertool\fP, it must be started on the same host and port on which \f2orbd\fP is executing. If the server is run on a different port, the information stored in the database for local contexts will be invalid and the service will not work properly. -.LP -.SS -Server Manager: an Example -.LP -.LP -Using the -.na -\f2sample tutorial\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlExample.html for our demonstration, you would run the \f2idlj\fP compiler and \f2javac\fP compiler as shown in the tutorial. To run the Server Manager, follow these steps for running the application: -.LP -.LP -Start \f2orbd\fP. -.LP -.LP -To start \f2orbd\fP from a UNIX command shell, enter: -.LP -.LP -\ -.LP -.nf -\f3 -.fl - orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Note that \f21050\fP is the port on which you want the name server to run. \f2\-ORBInitialPort\fP is a required command\-line argument. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. -.LP -.LP -Start the \f2servertool\fP: -.LP -.LP -To start the Hello server, enter: -.LP -.nf -\f3 -.fl - servertool \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Make sure the name server (\f2orbd\fP) port is the same as in the previous step, for example, \f2\-ORBInitialPort 1050\fP. The \f2servertool\fP must be started on the same port as the name server. -.LP -.LP -The \f2servertool\fP command line interface appears. -.LP -.LP - -.LP -.LP -Start the Hello server from the \f2servertool\fP prompt: -.LP -.nf -\f3 -.fl - servertool > register \-server HelloServer \-classpath . \-applicationName -.fl - HelloServerApName -.fl -\fP -.fi - -.LP -.LP -The \f2servertool\fP registers the server, assigns it the name of "HelloServerApName", and displays its server id, along with a listing of all registered servers. -.LP -.LP - -.LP -.LP -Run the client application from another terminal window or prompt: -.LP -.LP -\ -.LP -.nf -\f3 -.fl - java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost -.fl -\fP -.fi - -.LP -.LP -For this example, you can omit \f2\-ORBInitialHost localhost\fP since the name server is running on the same host as the Hello client. If the name server is running on a different host, use \f2\-ORBInitialHost\fP \f2nameserverhost\fP to specify the host on which the IDL name server is running. -.LP -.LP -Specify the name server (\f2orbd\fP) port as done in the previous step, for example, \f2\-ORBInitialPort 1050\fP. -.LP -.LP -\ -.LP -.LP -\ -.LP -.LP -When you have finished experimenting with the Server Manager, be sure to shut down or kill the name server (\f2orbd\fP) and \f2servertool\fP. -.LP -.LP -To shut down \f2orbd\fP from a DOS prompt, select the window that is running the server and enter \f2Ctrl+C\fP to shut it down. To shut down \f2orbd\fPfrom a Unix shell, find the process, and kill it. The server will continue to wait for invocations until it is explicitly stopped. -.LP -.LP -To shut down the \f2servertool\fP, type \f2quit\fP and press the \f2Enter\fP key on the keyboard. -.LP -.SH "See Also" -.LP -.RS 3 -.TP 2 -o -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html +\fBorbd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The persistent servers, while publishing the persistent object references in the naming service, include the port number of the ORBD in the object reference instead of the port number of the server\&. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages: +.TP 0.2i +\(bu +The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. +.TP 0.2i +\(bu +The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. +.PP +To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. +.PP +When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. +.SH OPTIONS +.TP +-ORBInitialPort \fInameserverport\fR .br -.TP 2 -o +Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. +.SS NONREQUIRED\ OPTIONS +.TP +-port \fIport\fR +.br +Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. +.TP +-defaultdb \fIdirectory\fR +.br +Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. +.TP +-serverPollingTime \fImilliseconds\fR +.br +Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-serverStartupDelay milliseconds +.br +Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE +A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. +.PP +Before running a client or a server, you will start ORBD\&. ORBD includes a persistent naming service and a transient naming service, both of which are an implementation of the COS Naming Service\&. +.PP +The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. +.PP +For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. +.PP +The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. +.PP +To start \f3orbd\fR from a UNIX command shell, enter: +.sp +.nf +\f3orbd \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start orbd \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: +.sp +.nf +\f3Properties props = new Properties();\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP +.fi +.nf +\f3ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: +.sp +.nf +\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP +.fi +.nf +\f3\fP +.fi +.sp +To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. +.PP +For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.SH SERVER\ MANAGER +To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. +.PP +See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html +.PP +In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: +.PP +Start \f3orbd\fR\&. +.PP +UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. +.PP +MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. +.PP +Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. +.PP +Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. +.PP +Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. +.PP +In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: +.sp +.nf +\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP +.fi +.nf +\f3 HelloServerApName\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: +.sp +.nf +\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP +.fi +.nf +\f3\fP +.fi +.sp +For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. +.PP +To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu servertool(1) -.RE - -.LP -.br - -.LP - +.TP 0.2i +\(bu +Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/pack200.1 b/jdk/src/bsd/doc/man/pack200.1 index f5869170982..f414cdb6170 100644 --- a/jdk/src/bsd/doc/man/pack200.1 +++ b/jdk/src/bsd/doc/man/pack200.1 @@ -1,340 +1,291 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH pack200 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: pack200.1 +.\" +.if n .pl 99999 +.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -pack200 \- JAR Packing tool -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4pack200\fP\f2 [ \fP\f2options\fP ] \f2output\-file\fP \f2JAR\-file\fP -.LP -.LP -Options may be in any order. The last option on the command line or in a properties file supersedes all previously specified options. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -output\-file -Name of the output file. -.TP 3 -JAR\-file -Name of the input file. -.RE +.SH NAME +pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f2pack200\fP tool is a Java application that transforms a JAR file into a compressed \f2pack200\fP file using the Java \f2gzip\fP compressor. The \f2pack200\fP files are highly compressed files that can be directly deployed, saving bandwidth and reducing download time. -.LP -.LP -The \f2pack200\fP tool uses several options to fine\-tune and set the compression engine. -.LP -.SS -Typical usage: -.LP -.LP -\f2% pack200 myarchive.pack.gz myarchive.jar\fP -.LP -.LP -In this example, \f2myarchive.pack.gz\fP is produced using the default \f2pack200\fP settings. -.LP -.SH "OPTIONS" -.LP -.LP -\f4\-r \-\-repack\fP -.LP -.LP -Produces a JAR file by packing the file \f2myarchive.jar\fP and unpacking it. The resulting file can be used as an input to the \f2jarsigner(1)\fP tool. -.LP -.LP -\f2% pack200 \-\-repack myarchive\-packer.jar myarchive.jar\fP -.LP -.LP -\f2% pack200 \-\-repack myarchive.jar\fP -.LP -.LP -\f4\-g \-\-no\-gzip\fP -.LP -.LP -Produces a \f2pack200\fP file. With this option a suitable compressor must be used, and the target system must use a corresponding decompresser. -.LP -.LP -\f2% pack200 \-\-no\-gzip myarchive.pack myarchive.jar\fP -.LP -.LP -\f4\-G \-\-strip\-debug\fP -.LP -.LP -Strips attributes used for debugging from the output. These include \f2SourceFile\fP, \f2LineNumberTable\fP, \f2LocalVariableTable\fP and \f2LocalVariableTypeTable\fP. Removing these attributes reduces the size of both downloads and installations but reduces the usefulness of debuggers. -.LP -.LP -\f4\-\-keep\-file\-order\fP -.LP -.LP -Preserve the order of files in the input file; this is the default behavior. -.LP -.LP -\f4\-O \-\-no\-keep\-file\-order\fP -.LP -.LP -The packer will reorder and transmit all elements. Additionally, the packer may remove JAR directory names. This will reduce the download size; however, certain JAR file optimizations, such as indexing, may not work correctly. -.LP -.LP -\f4\-Svalue \-\-segment\-limit=\fP\f2value\fP -.LP -.LP -The value is the estimated target size N (in bytes) of each archive segment. If a single input file requires +\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR +.fi +.sp +Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIoutput-file\fR +Name of the output file\&. +.TP +\fIJAR-file\fR +Name of the input file\&. +.SH DESCRIPTION +The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. +.PP +The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: +.sp +.nf +\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-r, --repack .br -more than N bytes, it will be given its own archive segment. As a special case, a value of \f2\-1\fP will produce a single large segment with all input files, while a value of \f20\fP will produce one segment for each class. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory. -.LP -.LP -The size of each segment is estimated by counting the size of each input file to be transmitted in the segment, along with the size of its name and other transmitted properties. -.LP -.LP -The default is \-1, which means the packer will always create a single segment output file. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs. -.LP -.LP -A 10MB JAR packed without this limit will typically pack about 10% smaller, but the packer may require a larger Java heap (about ten times the segment limit). -.LP -.LP -\f4\-Evalue \-\-effort=\fP\f2value\fP -.LP -.LP -If the value is set to a single decimal digit, the packer will use the indicated amount of effort in compressing the archive. Level \f21\fP may produce somewhat larger size and faster compression speed, while level \f29\fP will take much longer but may produce better compression. The special value \f20\fP instructs the packer to copy through the original JAR file directly with no compression. The JSR 200 standard requires any unpacker to understand this special case as a pass\-through of the entire archive. -.LP -.LP -The default is \f25\fP, investing a modest amount of time to produce reasonable compression. -.LP -.LP -\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP -.LP -.LP -Overrides the default, which preserves the input information, but may cause the transmitted archive to be larger. The possible values are: -.LP -.RS 3 -.TP 3 -true -.TP 3 -false -In either case, the packer will set the deflation hint accordingly in the output archive, and will not transmit the individual deflation hints of archive elements. -.RE +Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: +.sp +.nf +\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP +.fi +.nf +\f3pack200 \-\-repack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.RS 3 -.TP 3 -keep -Preserve deflation hints observed in the input JAR. (This is the default.) -.RE -.LP -.LP -\f4\-mvalue \-\-modification\-time=\fP\f2value\fP -.LP -.LP -The possible values are: -.LP -.RS 3 -.TP 3 -latest -The packer will attempt to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment. This single value will be transmitted as part of the segment and applied to all the entries in each segment. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date. -.TP 3 -keep -Preserves modification times observed in the input JAR. (This is the default.) -.RE +The following example preserves the order of files in the input file\&. +.TP +-g, --no-gzip +.br +Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. +.sp +.nf +\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -\f4\-Pfile \-\-pass\-file=\fP\f2file\fP -.LP -.LP -Indicates that a file should be passed through bytewise with no compression. By repeating the option, multiple files may be specified. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator "\f2/\fP". The resulting file names must match exactly as strings with their occurrences in the JAR file. If file is a directory name, all files under that directory will be passed. -.LP -.LP -\f4\-Uaction \-\-unknown\-attribute=\fP\f2action\fP -.LP -.LP -Overrides the default behavior; i.e., the classfile containing the unknown attribute will be passed through with the specified action. The possible values for actions are: -.LP -.RS 3 -.TP 3 -error -The \f2pack200\fP operation as a whole will fail with a suitable explanation. -.TP 3 -strip -The attribute will be dropped. Note: Removing the required VM attributes may cause Class Loader failures. -.TP 3 -pass -Upon encountering this attribute, the entire class will be transmitted as though it is a resource. -.RE +.TP +-G, --strip-debug +.br +Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. +.TP +--keep-file-order +.br +Preserve the order of files in the input file\&. This is the default behavior\&. +.TP +-O, --no-keep-file-order +.br +The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. +.TP +-S\fIvalue\fR , --segment-limit=\fIvalue\fR +.br +The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. -.LP -.LP -\f4\-Cattribute\-name=\fP\f2layout\fP \f3\-\-class\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Fattribute\-name=\fP\f2layout\fP \f3\-\-field\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Mattribute\-name=\fP\f2layout\fP \f3\-\-method\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Dattribute\-name=\fP\f2layout\fP \f3\-\-code\-attribute=\fP\f2attribute\-name=action\fP -.LP -.LP -With the above four options, the attribute layout can be specified for a class entity, such as Class attribute, Field attribute, Method attribute, and Code attribute. The attribute\-name is the name of the attribute for which the layout or action is being defined. The possible values for action are: -.LP -.RS 3 -.TP 3 -some\-layout\-string -The layout language is defined in the JSR 200 specification. -.LP -Example: \f2\-\-class\-attribute=SourceFile=RUH\fP -.TP 3 -error -Upon encountering this attribute, the pack200 operation will fail with a suitable explanation. -.TP 3 -strip -Upon encountering this attribute, the attribute will be removed from the output. Note: removing VM\-required attributes may cause Class Loader failures. -.RE +The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. -.LP -.LP -Example: \f2\-\-class\-attribute=CompilationID=pass\fP will cause the class file containing this attribute to be passed through without further action by the packer. -.LP -.LP -\f4\-f\fP\f2 \fP\f2pack.properties\fP \f3\-\-config\-file=\fP\f2pack.properties\fP -.LP -.LP -A configuration file, containing Java properties to initialize the packer, may be specified on the command line. -.LP -.LP -\f2% pack200 \-f pack.properties myarchive.pack.gz myarchive.jar\fP +The default is -1, which means that the packer creates a single segment output file\&. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs\&. + +A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. +.TP +-E\fIvalue\fR , --effort=\fIvalue\fR .br -\f2% more pack.properties\fP +If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command to copy through the original JAR file directly with no compression\&. The JSR 200 standard requires any unpacker to understand this special case as a pass-through of the entire archive\&. + +The default is 5, to invest a modest amount of time to produce reasonable compression\&. +.TP +-H\fIvalue\fR , --deflate-hint=\fIvalue\fR .br -\f2# Generic properties for the packer.\fP +Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. + +If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. + +The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. +.TP +-m\fIvalue\fR , --modification-time=\fIvalue\fR .br -\f2modification.time=latest\fP +The possible values are \f3latest\fR and \f3keep\fR\&. + +If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. + +If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. +.TP +-P\fIfile\fR , --pass-file=\fIfile\fR .br -\f2deflate.hint=false\fP +Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. +.TP +-U\fIaction\fR , --unknown-attribute=\fIaction\fR .br -\f2keep.file.order=false\fP +Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. + +If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. + +If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +.nf +-C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR .br -\f2# This option will cause the files bearing new attributes to\fP +.fi +See next option\&. +.TP +.nf +-F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR .br -\f2# be reported as an error rather than passed uncompressed.\fP +.fi +See next option\&. +.TP +.nf +-M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR .br -\f2unknown.attribute=error\fP +.fi +See next option\&. +.TP +.nf +-D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR .br -\f2# Change the segment limit to be unlimited.\fP +.fi +With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. + +\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. + +If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. + +If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +-f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR .br -\f2segment.limit=\-1\fP -.LP -.LP -\f4\-v \-\-verbose\fP -.LP -.LP -Outputs minimal messages. Multiple specification of this option will output more verbose messages. -.LP -.LP -\f4\-q \-\-quiet\fP -.LP -.LP -Specifies quiet operation with no messages. -.LP -.LP -\f4\-lfilename \-\-log\-file=\fP\f2filename\fP -.LP -.LP -Specifies a log file to output messages. -.LP -.LP -\f4\-? \-h \-\-help\fP -.LP -.LP -Prints help information about this command. -.LP -.LP -\f4\-V \-\-version\fP -.LP -.LP -Prints version information about this command. -.LP -.LP -\f4\-J\fP\f2option\fP -.LP -.LP -Passes \f2option\fP to the Java launcher called by \f2pack200\fP. For example, \f2\-J\-Xms48m\fP sets the startup memory to 48 megabytes. Although it does not begin with \f2\-X\fP, it is not a standard option of \f2pack200\fP. It is a common convention for \f2\-J\fP to pass options to the underlying VM executing applications written in Java. -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are returned: -.LP -.LP -\f2\ 0\fP for successful completion; -.LP -.LP -\f2>0\fP if an error occurs. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o +A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. +.sp +.nf +\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3more pack\&.properties\fP +.fi +.nf +\f3# Generic properties for the packer\&.\fP +.fi +.nf +\f3modification\&.time=latest\fP +.fi +.nf +\f3deflate\&.hint=false\fP +.fi +.nf +\f3keep\&.file\&.order=false\fP +.fi +.nf +\f3# This option will cause the files bearing new attributes to\fP +.fi +.nf +\f3# be reported as an error rather than passed uncompressed\&.\fP +.fi +.nf +\f3unknown\&.attribute=error\fP +.fi +.nf +\f3# Change the segment limit to be unlimited\&.\fP +.fi +.nf +\f3segment\&.limit=\-1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-v, --verbose +.br +Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. +.TP +-q, --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-l\fIfilename\fR , --log-file=\fIfilename\fR +.br +Specifies a log file to output messages\&. +.TP +-?, -h, --help +.br +Prints help information about this command\&. +.TP +-V, --version +.br +Prints version information about this command\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. +.SH NOTES +This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu unpack200(1) -.TP 2 -o -.na -\f2Java SE Documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/index.html -.TP 2 -o -.na -\f2Java Deployment Guide \- Pack200\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html -.TP 2 -o -jar(1) \- Java Archive Tool -.TP 2 -o -jarsigner(1) \- JAR Signer tool -.TP 2 -o -\f2attributes(5)\fP man page -.RE - -.LP -.SH "NOTES" -.LP -.LP -This command should not be confused with \f2pack(1)\fP. They are distinctly separate products. -.LP -.LP -The Java SE API Specification provided with the JDK is the superseding authority, in case of discrepancies. -.LP - +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/policytool.1 b/jdk/src/bsd/doc/man/policytool.1 index 411321f0ec5..a82f7be956c 100644 --- a/jdk/src/bsd/doc/man/policytool.1 +++ b/jdk/src/bsd/doc/man/policytool.1 @@ -1,89 +1,115 @@ -." Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH policytool 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: policytool.1 +.\" +.if n .pl 99999 +.TH policytool 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -policytool \- PolicyTool Administration GUI Utility -.LP -\f3policytool\fP reads and writes a plain text policy file based on user input via the utility GUI. -.SH "SYNOPSIS" -.LP -.RS 3 -.TP 3 -\ -.TP 3 -Run the policytool Administrator's utility -\f4policytool\fP -.TP 3 -Run policytool and load the specified policy file -\f4policytool\fP\f2[\-file\ \fP\f2filename\fP\f2]\fP -.TP 3 -\ -.TP 3 -where: -.RS 3 -.TP 3 -file -directs \f2policytool\fP to load a local policy file -.TP 3 -filename -The file name -.RE -.SH "DESCRIPTION" -.LP -\f3policytool\fP is a GUI that allows users to create and manage policy files. For details, see -.na -\f2the Policytool Users Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html. -.SH "OPTIONS" -.RS 3 -.TP 3 -file -Loads \f2filename\fP. -.SH "SEE ALSO" -.na -\f2Default Policy Implementation and Syntax\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html -.br -.na -\f2Policy Tool Users' Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html -.br -.na -\f2Security Permissions\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/permissions.html -.br -.na -\f2Security Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/overview/jsoverview.html -.br -.RE -.RE - -.LP +.SH NAME +policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. +.SH SYNOPSIS +.sp +.nf +\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] +.fi +.sp +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.TP +\fIfilename\fR +The name of the file to be loaded\&. +.PP +\fIExamples\fR: +.PP +Run the policy tool administrator utility: +.sp +.nf +\f3policytool\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3policytool\fR command and load the specified file: +.sp +.nf +\f3policytool\-file mypolicyfile\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH DESCRIPTION +The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.SH OPTIONS +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.TP 0.2i +\(bu +Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html +.TP 0.2i +\(bu +Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html +.TP 0.2i +\(bu +Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html +.TP 0.2i +\(bu +Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/rmic.1 b/jdk/src/bsd/doc/man/rmic.1 index 893061b1a48..9f7397edb54 100644 --- a/jdk/src/bsd/doc/man/rmic.1 +++ b/jdk/src/bsd/doc/man/rmic.1 @@ -1,227 +1,224 @@ -." Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmic 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmic.1 +.\" +.if n .pl 99999 +.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmic \- The Java RMI Compiler -.LP -.LP -\f3rmic\fP generates stub, skeleton, and tie classes for remote objects using either the JRMP or IIOP protocols. Also generates OMG IDL. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmic [ \fP\f3options\fP\f3 ] \fP\f4package\-qualified\-class\-name(s)\fP\f3 -.fl -\fP -.fi +.SH NAME +rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmic\fP compiler generates stub and skeleton class files (JRMP protocol) and stub and tie class files (IIOP protocol) for remote objects. These classes files are generated from compiled Java programming language classes that are remote object implementation classes. A remote implementation class is a class that implements the interface \f2java.rmi.Remote\fP. The class names in the \f3rmic\fP command must be for classes that have been compiled successfully with the \f3javac\fP command and must be fully package qualified. For example, running \f3rmic\fP on the class file name \f2HelloImpl\fP as shown here: -.LP -.nf -\f3 -.fl -rmic hello.HelloImpl -.fl -\fP -.fi +\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line \f3options\fR\&. See Options\&. +.TP +\fIpackage-qualified-class-names\fR +Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. +.SH DESCRIPTION +\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. +.PP +The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class files are generated from compiled Java programming language classes that are remote object implementation classes\&. A remote implementation class is a class that implements the interface \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): +.sp +.nf +\f3rmic hello\&.HelloImpl\fP +.fi +.nf +\f3\fP +.fi +.sp +A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. +.PP +A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. +.PP +A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. +.PP +By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. +.PP +A stub implements only the remote interfaces, and not any local interfaces that the remote object also implements\&. Because a JRMP stub implements the same set of remote interfaces as the remote object, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. +.SH OPTIONS +.TP +-bootclasspath \fIpath\fR +.br +Overrides the location of bootstrap class files\&. +.TP +-classpath path +.br +Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. +.TP +-d \fIdirectory\fR +.br +Specifies the root destination directory for the generated class hierarchy\&. You can use this option to specify a destination directory for the stub, skeleton, and tie files\&. For example, the following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. +.sp +.nf +\f3rmic \-d /java/classes exampleclass\&.MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -creates the \f2HelloImpl_Stub.class\fP file in the \f2hello\fP subdirectory (named for the class's package). -.LP -.LP -A \f2skeleton\fP for a remote object is a JRMP protocol server\-side entity that has a method that dispatches calls to the actual remote object implementation. -.LP -.LP -A \f2tie\fP for a remote object is a server\-side entity similar to a skeleton, but which communicates with the client using the IIOP protocol. -.LP -.LP -A \f2stub\fP is a client\-side proxy for a remote object which is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides. A client's reference to a remote object, therefore, is actually a reference to a local stub. -.LP -.LP -By default, \f3rmic\fP generates stub classes that use the 1.2 JRMP stub protocol version only, as if the \f2\-v1.2\fP option had been specified. (Note that the \f2\-vcompat\fP option was the default in releases prior to 5.0.) Use the \f2\-iiop\fP option to generate stub and tie classes for the IIOP protocol. -.LP -.LP -A stub implements only the remote interfaces, not any local interfaces that the remote object also implements. Because a JRMP stub implements the same set of remote interfaces as the remote object itself, a client can use the Java programming language's built\-in operators for casting and type checking. For IIOP, the \f2PortableRemoteObject.narrow\fP method must be used. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-bootclasspath path -Overrides location of bootstrap class files -.TP 3 -\-classpath path -Specifies the path \f3rmic\fP uses to look up classes. This option overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is: -.nf -\f3 -.fl -.:<your_path> -.fl -\fP -.fi -For example: -.nf -\f3 -.fl -.:/usr/local/java/classes -.fl -\fP -.fi -.TP 3 -\-d directory -Specifies the root destination directory for the generated class hierarchy. You can use this option to specify a destination directory for the stub, skeleton, and tie files. For example, the command -.nf -\f3 -.fl -% rmic \-d /java/classes foo.MyClass -.fl -\fP -.fi -would place the stub and skeleton classes derived from \f2MyClass\fP into the directory \f2/java/classes/foo\fP. If the \f2\-d\fP option is not specified, the default behavior is as if \f2"\-d\ ."\fP were specified: the package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it. (Note that in some previous versions of \f3rmic\fP, if \f2\-d\fP was not specified, then the package hierarchy was \f2not\fP created, and all of the output files were placed directly in the current directory.) -.br -\ -.TP 3 -\-extdirs path -Overrides location of installed extensions -.TP 3 -\-g -Enables generation of all debugging information, including local variables. By default, only line number information is generated. -.TP 3 -\-idl -Causes \f2rmic\fP to generate OMG IDL for the classes specified and any classes referenced. IDL provides a purely declarative, programming language\-independent way of specifying an object's API. The IDL is used as a specification for methods and data that can be written in and invoked from any language that provides CORBA bindings. This includes Java and C++ among others. See the -.na -\f2Java Language to IDL Mapping\fP @ -.fi -http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description. -.br -.br -When the \f2\-idl\fP option is used, other options also include: -.RS 3 -.TP 3 -\-always or \-alwaysgenerate -Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. -.TP 3 -\-factory -Uses factory keyword in generated IDL. -.TP 3 -\-idlModule\ fromJavaPackage[.class]\ toIDLModule -Specifies IDLEntity package mapping. For example:\ \f2\-idlModule foo.bar my::real::idlmod\fP. -.TP 3 -\-idlFile\ fromJavaPackage[.class]\ toIDLFile -Specifies IDLEntity file mapping. For example:\ \f2\-idlFile test.pkg.X TEST16.idl\fP.\ -.RE -.TP 3 -\-iiop -Causes \f2rmic\fP to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes. A stub class is a local proxy for a remote object and is used by clients to send calls to a server. Each remote interface requires a stub class, which implements that remote interface. A client's reference to a remote object is actually a reference to a stub. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class. Each implementation class requires a tie class. -.br -.br -Invoking \f2rmic\fP with the \f2\-iiop\fP generates stubs and ties that conform to this naming convention: -.nf -\f3 -.fl -_<implementationName>_stub.class -.fl -_<interfaceName>_tie.class -.fl -\fP -.fi -When the \f2\-iiop\fP option is used, other options also include: -.RS 3 -.TP 3 -\-always or \-alwaysgenerate -Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. -.TP 3 -\-nolocalstubs -Do not create stubs optimized for same\-process clients and servers. -.TP 3 -\-noValueMethods -Must be used with the \f2\-idl\fP option. Prevents addition of \f2valuetype\fP methods and initializers to emitted IDL. These methods and initializers are optional for \f2valuetype\fPs, and are generated unless the \f2\-noValueMethods\fP option is specified when using the \f2\-idl\fP option. -.TP 3 -\-poa -Changes the inheritance from \f2org.omg.CORBA_2_3.portable.ObjectImpl\fP to \f2org.omg.PortableServer.Servant\fP. The \f2PortableServer\fP module for the -.na -\f2Portable Object Adapter\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html (POA) defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2.3.1 ptc/00\-01\-08.pdf. -.RE -.TP 3 -\-J -Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter. -.TP 3 -\-keep or \-keepgenerated -Retains the generated \f2.java\fP source files for the stub, skeleton, and/or tie classes and writes them to the same directory as the \f2.class\fP files. -.TP 3 -\-nowarn -Turns off warnings. If used the compiler does not print out any warnings. -.TP 3 -\-nowrite -Does not write compiled classes to the file system. -.TP 3 -\-vcompat -Generates stub and skeleton classes compatible with both the 1.1 and 1.2 JRMP stub protocol versions. (This option was the default in releases prior to 5.0.) The generated stub classes will use the 1.1 stub protocol version when loaded in a JDK 1.1 virtual machine and will use the 1.2 stub protocol version when loaded into a 1.2 (or later) virtual machine. The generated skeleton classes will support both 1.1 and 1.2 stub protocol versions. The generated classes are relatively large in order to support both modes of operation. -.TP 3 -\-verbose -Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded. -.TP 3 -\-v1.1 -Generates stub and skeleton classes for the 1.1 JRMP stub protocol version only. Note that this option is only useful for generating stub classes that are serialization\-compatible with pre\-existing, statically\-deployed stub classes that were generated by the \f3rmic\fP tool from JDK 1.1 and that cannot be upgraded (and dynamic class loading is not being used). -.TP 3 -\-v1.2 -(default) Generates stub classes for the 1.2 JRMP stub protocol version only. No skeleton classes are generated with this option because skeleton classes are not used with the 1.2 stub protocol version. The generated stub classes will not work if they are loaded into a JDK 1.1 virtual machine. -.RE -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 +If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. +.TP +-extdirs \fIpath\fR +.br +Overrides the location of installed extensions\&. +.TP +-g +.br +Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. +.TP +-idl +.br +Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html + +When the \f3-idl\fR option is used, other options also include: +.RS +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. +.TP 0.2i +\(bu +The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. +.TP 0.2i +\(bu +\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. +.RE + +.TP +-iiop +.br +Causes the \f3rmic\fR command to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes\&. A stub class is a local proxy for a remote object and is used by clients to send calls to a server\&. Each remote interface requires a stub class, which implements that remote interface\&. A client reference to a remote object is a reference to a stub\&. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class\&. Each implementation class requires a tie class\&. + +If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: +.sp +.nf +\f3_<implementationName>_stub\&.class\fP +.fi +.nf +\f3_<interfaceName>_tie\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.RS +.TP 0.2i +\(bu +When you use the \f3-iiop\fR option, other options also include: +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. +.TP 0.2i +\(bu +The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. +.TP 0.2i +\(bu +The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2\&.3\&.1 ptc/00-01-08\&.pdf\&..RE + +.TP +-J +.br +Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter +.TP +-keep or -keepgenerated +.br +Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. +.TP +-nowarn +.br +Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. +.TP +-nowrite +.br +Does not write compiled classes to the file system\&. +.TP +-vcompat (deprecated) +.br +Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. +.TP +-verbose +.br +Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. +.TP +-v1\&.1 (deprecated) +.br +Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. +.TP +-v1\&.2 (deprecated) +.br +(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. +.SH ENVIRONMENT\ VARIABLES +.TP CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example, -.nf -\f3 -.fl -.:/usr/local/java/classes -.fl -\fP -.fi -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -java(1), javac(1), -.na -\f2CLASSPATH\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath -.LP - +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/rmid.1 b/jdk/src/bsd/doc/man/rmid.1 index 1cb08b7566e..0a01aa90827 100644 --- a/jdk/src/bsd/doc/man/rmid.1 +++ b/jdk/src/bsd/doc/man/rmid.1 @@ -1,328 +1,315 @@ -." Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmid 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmid.1 +.\" +.if n .pl 99999 +.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmid \- The Java RMI Activation System Daemon -.LP -.LP -\f3rmid\fP starts the activation system daemon that allows objects to be registered and activated in a virtual machine (VM). -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmid [options] -.fl -\fP -.fi +.SH NAME +rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmid\fP tool starts the activation system daemon. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a VM. See the -.na -\f2Java RMI Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/rmi/spec/rmiTOC.html and -.na -\f2Activation tutorials\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/rmi/activation/overview.html for details on how to write programs that use activatable remote objects. -.LP -.LP -The daemon can be started by executing the \f2rmid\fP command, and specifying a security policy file, as follows: -.LP -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy -.fl -\fP -.fi - -.LP -.LP -\f3Note:\fP When running Sun's implementation of \f2rmid\fP, by default you will need to specify a security policy file so that \f2rmid\fP can verify whether or not the information in each \f2ActivationGroupDesc\fP is allowed to be used to launch a VM for an activation group. Specifically, the command and options specified by the \f2CommandEnvironment\fP and any \f2Properties\fP passed to an \f2ActivationGroupDesc\fP's constructor must now be explicitly allowed in the security policy file for \f2rmid\fP. The value of the \f2sun.rmi.activation.execPolicy\fP property dictates the policy that \f2rmid\fP uses to determine whether or not the information in an \f2ActivationGroupDesc\fP may be used to launch a VM for an activation group. -.LP -.LP -Executing \f2rmid\fP by default -.LP -.RS 3 -.TP 2 -o -starts the Activator and an internal registry on the default port, 1098, and -.TP 2 -o -binds an \f2ActivationSystem\fP to the name \f2java.rmi.activation.ActivationSystem\fP in this internal registry. -.RE - -.LP -.LP -To specify an alternate port for the registry, you must specify the \f2\-port\fP option when starting up \f2rmid\fP. For example, -.LP -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy \-port 1099 -.fl -\fP -.fi - -.LP -.LP -starts the activation system daemon and a registry on the registry's default port, 1099. -.LP -.SS -Starting rmid from inetd/xinetd -.LP -.LP -An alternative to starting \f2rmid\fP from the command line is to configure \f2inetd\fP (Solaris) or \f2xinetd\fP (Bsd) to start \f2rmid\fP on demand. -.LP -.LP -When \f2rmid\fP starts up, it attempts to obtain an inherited channel (inherited from \f2inetd\fP/\f2xinetd\fP) by invoking the \f2System.inheritedChannel\fP method. If the inherited channel is \f2null\fP or not an instance of \f2java.nio.channels.ServerSocketChannel\fP, then \f2rmid\fP assumes that it was not started by \f2inetd\fP/\f2xinetd\fP, and it starts up as described above. -.LP -.LP -If the inherited channel is a \f2ServerSocketChannel\fP instance, then \f2rmid\fP uses the \f2java.net.ServerSocket\fP obtained from the \f2ServerSocketChannel\fP as the server socket that accepts requests for the remote objects it exports, namely the registry in which the \f2java.rmi.activation.ActivationSystem\fP is bound and the \f2java.rmi.activation.Activator\fP remote object. In this mode, \f2rmid\fP behaves the same as when it is started from the command line, \f2except\fP: -.LP -.RS 3 -.TP 2 -o -Output printed to \f2System.err\fP is redirected to a file. This file is located in the directory specified by the \f2java.io.tmpdir\fP system property (typically \f2/var/tmp\fP or \f2/tmp\fP) with the prefix \f2"rmid\-err"\fP and the suffix \f2"tmp"\fP. -.TP 2 -o -The \f2\-port\fP option is disallowed. If this option is specified, \f2rmid\fP will exit with an error message. -.TP 2 -o -The \f2\-log\fP option is required. If this option is not specified, \f2rmid\fP will exit with an error message. -.RE - -.LP -.LP -See the man pages for \f2inetd\fP (Solaris) or \f2xinetd\fP (Bsd) for details on how to configure services to be started on demand. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-C<someCommandLineOption> -Specifies an option that is passed as a command\-line argument to each child process (activation group) of \f2rmid\fP when that process is created. For example, you could pass a property to each virtual machine spawned by the activation system daemon: -.nf -\f3 -.fl - rmid \-C\-Dsome.property=value -.fl -\fP -.fi -This ability to pass command\-line arguments to child processes can be useful for debugging. For example, the following command: -.nf -\f3 -.fl - rmid \-C\-Djava.rmi.server.logCalls=true -.fl -\fP -.fi -will enable server\-call logging in all child VMs. -.LP -.TP 3 -\-J<someCommandLineOption> -Specifies an option that is passed to the \f2java\fP interpreter running \f2rmid\fP. For example, to specify that \f2rmid\fP use a policy file named \f2rmid.policy\fP, the \f2\-J\fP option can be used to define the \f2java.security.policy\fP property on \f2rmid\fP's command line, for example: -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy -.fl -\fP -.fi -.TP 3 -\-J\-Dsun.rmi.activation.execPolicy=<policy> -Specifies the policy that \f2rmid\fP employs to check commands and command\-line options used to launch the VM in which an activation group runs. Please note that this option exists only in Sun's implementation of the Java RMI activation daemon. If this property is not specified on the command line, the result is the same as if \f2\-J\-Dsun.rmi.activation.execPolicy=default\fP were specified. The possible values of \f2<policy>\fP can be \f2default\fP, \f2<policyClassName>\fP, or \f2none\fP: -.RS 3 -.TP 2 -o -\f3default (or if this property is \fP\f4unspecified\fP\f3)\fP -.LP -The default \f2execPolicy\fP allows \f2rmid\fP to execute commands with specific command\-line options only if \f2rmid\fP has been granted permission to execute those commands and options in the security policy file that \f2rmid\fP uses. Only the default activation group implementation can be used with the \f2default\fP execution policy. -.LP -\f2rmid\fP launches a VM for an activation group using the information in the group's registered activation group descriptor, an \f2ActivationGroupDesc\fP. The group descriptor specifies an optional \f2ActivationGroupDesc.CommandEnvironment\fP which includes the \f2command\fP to execute to start the activation group as well as any command line \f2options\fP to be added to the command line. By default, \f2rmid\fP uses the \f2java\fP command found in \f2java.home\fP. The group descriptor also contains \f2properties\fP overrides that are added to the command line as options defined as: -.nf -\f3 -.fl - \-D\fP\f4<property>\fP\f3=\fP\f4<value>\fP\f3 -.fl -\fP -.fi -.LP -The permission \f2com.sun.rmi.rmid.ExecPermission\fP is used to grant \f2rmid\fP permission to execute a command, specified in the group descriptor's \f2CommandEnvironment\fP to launch an activation group. The permission \f2com.sun.rmi.rmid.ExecOptionPermission\fP is used to allow \f2rmid\fP to use command\-line options, specified as properties overrides in the group descriptor or as options in the \f2CommandEnvironment\fP, when launching the activation group. -.LP -When granting \f2rmid\fP permission to execute various commands and options, the permissions \f2ExecPermission\fP and \f2ExecOptionPermission\fP need to be granted universally (i.e., granted to all code sources). -.RS 3 -.TP 3 -ExecPermission -The \f2ExecPermission\fP class represents permission for \f2rmid\fP to execute a specific \f2command\fP to launch an activation group. -.LP -\f3Syntax\fP +\fBrmid\fR [\fIoptions\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3rmid\fR command starts the activation system daemon\&. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html +.PP +Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. +.PP +Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. +.PP +To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH START\ RMID\ ON\ DEMAND +An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. +.PP +When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. +.PP +If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: +.TP 0.2i +\(bu +Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. +.TP 0.2i +\(bu +The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. +.TP 0.2i +\(bu +The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message +.PP +See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. +.SH OPTIONS +.TP +-C\fIoption\fR .br -The \f2name\fP of an \f2ExecPermission\fP is the path name of a command to grant \f2rmid\fP permission to execute. A path name that ends in "/*" indicates all the files contained in that directory (where "/" is the file\-separator character, \f2File.separatorChar\fP). A path name that ends with "/\-" indicates all files and subdirectories contained in that directory (recursively). A path name consisting of the special token "<<ALL FILES>>" matches \f3any\fP file. -.LP -\f3Note:\fP A path name consisting of a single "*" indicates all the files in the current directory, while a path name consisting of a single "\-" indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory. -.TP 3 -ExecOptionPermission -The \f2ExecOptionPermission\fP class represents permission for \f2rmid\fP to use a specific command\-line \f2option\fP when launching an activation group. The \f2name\fP of an \f2ExecOptionPermission\fP is the value of a command line option. -.LP -\f3Syntax\fP +Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: +.sp +.nf +\f3rmid \-C\-Dsome\&.property=value\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. +.sp +.nf +\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J\fIoption\fR .br -Options support a limited wildcard scheme. An asterisk signifies a wildcard match, and it may appear as the option name itself (i.e., it matches any option), or an asterisk may appear at the end of the option name only if the asterisk follows either a "." or "=". -.LP -For example: "*" or "\-Dfoo.*" or "\-Da.b.c=*" is valid, "*foo" or "\-Da*b" or "ab*" is not. -.TP 3 -Policy file for rmid -When granting \f2rmid\fP permission to execute various commands and options, the permissions \f2ExecPermission\fP and \f2ExecOptionPermission\fP need to be granted universally (i.e., granted to all code sources). It is safe to grant these permissions universally because only \f2rmid\fP checks these permissions. -.LP -An example policy file that grants various execute permissions to \f2rmid\fP is: -.nf -\f3 -.fl -grant { -.fl - permission com.sun.rmi.rmid.ExecPermission -.fl - "/files/apps/java/jdk1.7.0/solaris/bin/java"; -.fl +Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - permission com.sun.rmi.rmid.ExecPermission -.fl - "/files/apps/rmidcmds/*"; -.fl +.TP +-J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR +.br +Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. +.RS +.TP 0.2i +\(bu +default -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Djava.security.policy=/files/policies/group.policy"; -.fl +The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Djava.security.debug=*"; -.fl +The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Dsun.rmi.*"; -.fl -}; -.fl -\fP -.fi -The first permission granted allow \f2rmid\fP to execute the 1.7.0 version of the \f2java\fP command, specified by its explicit path name. Note that by default, the version of the \f2java\fP command found in \f2java.home\fP is used (the same one that \f2rmid\fP uses), and does not need to be specified in the policy file. The second permission allows \f2rmid\fP to execute any command in the directory \f2/files/apps/rmidcmds\fP. -.LP -The third permission granted, an \f2ExecOptionPermission\fP, allows \f2rmid\fP to launch an activation group that defines the security policy file to be \f2/files/policies/group.policy\fP. The next permission allows the \f2java.security.debug\fP property to be used by an activation group. The last permission allows any property in the \f2sun.rmi\fP property name hierarchy to be used by activation groups. -.LP -To start \f2rmid\fP with a policy file, the \f2java.security.policy\fP property needs to be specified on \f2rmid\fP's command line, for example: -.LP -\f2rmid \-J\-Djava.security.policy=rmid.policy\fP -.RE -.TP 2 -o -\f4<policyClassName>\fP -.LP -If the default behavior is not flexible enough, an administrator can provide, when starting \f2rmid\fP, the name of a class whose \f2checkExecCommand\fP method is executed in order to check commands to be executed by rmid. -.LP -The \f2policyClassName\fP specifies a public class with a public, no\-argument constructor and an implementation of the following \f2checkExecCommand\fP method: -.nf -\f3 -.fl - public void checkExecCommand(ActivationGroupDesc desc, -.fl - String[] command) -.fl - throws SecurityException; -.fl -\fP -.fi -Before launching an activation group, \f2rmid\fP calls the policy's \f2checkExecCommand\fP method, passing it the activation group descriptor and an array containing the complete command to launch the activation group. If the \f2checkExecCommand\fP throws a \f2SecurityException\fP, \f2rmid\fP will not launch the activation group and an \f2ActivationException\fP will be thrown to the caller attempting to activate the object. -.TP 2 -o -\f3none\fP -.LP -If the \f2sun.rmi.activation.execPolicy\fP property value is "none", then \f2rmid\fP will not perform any validation of commands to launch activation groups. -.RE -.LP -.TP 3 -\-log dir -Specifies the name of the directory the activation system daemon uses to write its database and associated information. The log directory defaults to creating a directory, \f2log\fP, in the directory in which the \f2rmid\fP command was executed. -.LP -.TP 3 -\-port port -Specifies the port \f2rmid\fP's registry uses. The activation system daemon binds the \f2ActivationSystem\fP, with the name \f2java.rmi.activation.ActivationSystem\fP, in this registry. Thus, the \f2ActivationSystem\fP on the local machine can be obtained using the following \f2Naming.lookup\fP method call: -.nf -\f3 -.fl - import java.rmi.*; -.fl - import java.rmi.activation.*; -.fl +\fIExecPermission\fR -.fl - ActivationSystem system; system = (ActivationSystem) -.fl - Naming.lookup("//:\fP\f4port\fP/java.rmi.activation.ActivationSystem"); -.fl -.fi -.TP 3 -\-stop -Stops the current invocation of \f2rmid\fP, for a port specified by the \f2\-port\fP option. If no port is specified, it will stop the \f2rmid\fP running on port 1098. -.RE +The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 +\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. + +A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. + +\fIExecOptionPermission\fR + +The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. + +\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. + +For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. + +\fIPolicy file for rmid\fR + +When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. + +An example policy file that grants various execute permissions to the \f3rmid\fR command is: +.sp +.nf +\f3grant {\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/rmidcmds/*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.debug=*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Dsun\&.rmi\&.*";\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. + +The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. + +To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: + +\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. +.TP 0.2i +\(bu +<policyClassName> + +If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. + +The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: +.sp +.nf +\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP +.fi +.nf +\f3 throws SecurityException;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. +.TP 0.2i +\(bu +none + +If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. +.RE + +.TP +-log \fIdir\fR +.br +Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. +.TP +-port \fIport\fR +.br +Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: +.sp +.nf +\f3import java\&.rmi\&.*; \fP +.fi +.nf +\f3 import java\&.rmi\&.activation\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 ActivationSystem system; system = (ActivationSystem)\fP +.fi +.nf +\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stop +.br +Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. +.SH ENVIRONMENT\ VARIABLES +.TP CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example: -.nf -\f3 -.fl - .:/usr/local/java/classes -.fl -\fP -.fi -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -rmic(1), -.na -\f2CLASSPATH\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath, java(1) -.LP - +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/rmiregistry.1 b/jdk/src/bsd/doc/man/rmiregistry.1 index c3facb6ffac..a05a5176e7d 100644 --- a/jdk/src/bsd/doc/man/rmiregistry.1 +++ b/jdk/src/bsd/doc/man/rmiregistry.1 @@ -1,83 +1,99 @@ -." Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmiregistry 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmiregistry.1 +.\" +.if n .pl 99999 +.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmiregistry \- The Java Remote Object Registry -.LP -.RS 3 -The \f3rmiregistry\fP command starts a remote object registry on the specified port on the current host. -.RE +.SH NAME +rmiregistry \- Starts a remote object registry on the specified port on the current host\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmiregistry [\fP\f4port\fP\f3] -.fl -\fP -.fi - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmiregistry\fP command creates and starts a remote object registry on the specified \f2port\fP on the current host. If \f2port\fP is omitted, the registry is started on port 1099. The \f3rmiregistry\fP command produces no output and is typically run in the background. For example: -.LP -.LP -\f2rmiregistry &\fP -.LP -.LP -A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names. Clients on local and remote hosts can then look up remote objects and make remote method invocations. -.LP -.LP -The registry is typically used to locate the first remote object on which an application needs to invoke methods. That object in turn will provide application\-specific support for finding other objects. -.LP -.LP -The methods of the \f2java.rmi.registry.LocateRegistry\fP class are used to get a registry operating on the local host or local host and port. -.LP -.LP -The URL\-based methods of the \f2java.rmi.Naming\fP class operate on a registry and can be used to look up a remote object on any host, and on the local host: bind a simple (string) name to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URLs bound in the registry. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-J -Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter. -.RE - -.LP -.SH "SEE ALSO" -.LP -java(1), -.na -\f2java.rmi.registry.LocateRegistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/rmi/registry/LocateRegistry.html and -.na -\f2java.rmi.Naming\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/rmi/Naming.html +\fBrmiregistry\fR [ \fIport\fR ] +.fi +.sp +.TP +\fIport\fR +The number of a \f3port\fR on the current host at which to start the remote object registry\&. +.SH DESCRIPTION +The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: +.sp +.nf +\f3rmiregistry &\fP +.fi +.nf +\f3\fP +.fi +.sp +A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. +.PP +The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. +.PP +The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. +.PP +The URL-based methods of the \f3java\&.rmi\&.Naming\fR class operate on a registry and can be used to look up a remote object on any host and on the local host\&. Bind a simple name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. +.SH OPTIONS +.TP +-J +.br +Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html +.TP 0.2i +\(bu +\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/schemagen.1 b/jdk/src/bsd/doc/man/schemagen.1 index 1449239943d..7c51558ba78 100644 --- a/jdk/src/bsd/doc/man/schemagen.1 +++ b/jdk/src/bsd/doc/man/schemagen.1 @@ -1,127 +1,122 @@ -." Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH schemagen 1 "10 May 2011" +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: schemagen.1 +.\" +.if n .pl 99999 +.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -schemagen \- Java(TM) Architecture for XML Binding Schema Generator -.LP -.LP -\f3Specification Version:\fP 2.1 +.SH NAME +schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIjava-files\fR +The Java class files to be processed\&. +.SH DESCRIPTION +The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.PP +Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. +.sp +.nf +\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP +.fi +.nf +\f3Note: Writing schema1\&.xsd\fP +.fi +.nf +\f3\fP +.fi +.sp +If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. +.SH OPTIONS +.TP +-d \fIpath\fR .br -\f3Implementation Version:\fP 2.1.3 -.LP -.SH "Launching schemagen" -.LP -.LP -The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform. -.LP -.LP -The current schema generator can process either Java source files or class files. -.LP -.LP -We also provide an Ant task to run the schema generator \- see the instructions for -.na -\f2using schemagen with Ant\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. -.LP -.nf -\f3 -.fl -% schemagen.sh Foo.java Bar.java ... -.fl -Note: Writing schema1.xsd -.fl -\fP -.fi - -.LP -.LP -If your java sources/classes reference other classes, they must be accessable on your system CLASSPATH environment variable, or they need to be given to the tool by using the \f2\-classpath\fP/\f2\-cp\fP options. Otherwise you will see errors when generating your schema. -.LP -.SS -Command Line Options -.LP -.nf -\f3 -.fl -Usage: schemagen [\-options ...] <java files> -.fl - -.fl -Options: -.fl - \-d <path> : specify where to place processor and javac generated class files -.fl - \-cp <path> : specify where to find user specified files -.fl - \-classpath <path> : specify where to find user specified files -.fl - \-encoding <encoding> : specify encoding to be used for apt/javac invocation -.fl - -.fl - \-episode <file> : generate episode file for separate compilation -.fl - \-version : display version information -.fl - \-help : display this usage message -.fl -\fP -.fi - -.LP -.SH "Generated Resource Files" -.LP -.LP -The current schema generator simply creates a schema file for each namespace referenced in your Java classes. There is no way to control the name of the generated schema files at this time. For that purpose, use -.na -\f2the schema generator ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. -.LP -.SH "Name" -See Also -.LP -.RS 3 -.TP 2 -o -Running the schema generator (schemagen): [ -.na -\f2command\-line instructions\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html, -.na -\f2using the SchemaGen Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html] -.TP 2 -o -.na -\f2Java Architecture for XML Binding (JAXB)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html -.RE - -.LP - +The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. +.TP +-cp \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-classpath \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. +.TP +-episode \fIfile\fR +.br +Generates an episode file for separate compilation\&. +.TP +-version +.br +Displays release information\&. +.TP +-help +.br +Displays a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/serialver.1 b/jdk/src/bsd/doc/man/serialver.1 index 2dcf94588d5..ba1dfcbef84 100644 --- a/jdk/src/bsd/doc/man/serialver.1 +++ b/jdk/src/bsd/doc/man/serialver.1 @@ -1,97 +1,111 @@ -." Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH serialver 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: serialver.1 +.\" +.if n .pl 99999 +.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -serialver \- The Serial Version Command -.LP -.LP -The \f3serialver\fP command returns the \f2serialVersionUID\fP. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3serialver\fP [ options ] [ classnames ] -.fl -.fi - -.LP -.RS 3 -.TP 3 -options -Command\-line options, as specified in this document. -.TP 3 -classnames -One or more class names -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3serialver\fP returns the \f2serialVersionUID\fP for one or more classes in a form suitable for copying into an evolving class. When invoked with no arguments it prints a usage line. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-classpath <directories and zip/jar files separated by :> -Set search path for application classes and resources. -.RE - -.LP -.RS 3 -.TP 3 -\-show -Displays a simple user interface. Enter the full class name and press either the Enter key or the Show button to display the serialVersionUID. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.SH "NOTES" -.LP -.LP -The \f3serialver\fP command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager. If \f3serialver\fP is to be run with untrusted classes, a security manager can be set with the following option: -.LP -.LP -\f2\-J\-Djava.security.manager\fP -.LP -.LP -and, if necessary, a security policy can be specified with the following option: -.LP -.LP -\f2\-J\-Djava.security.policy=<policy file>\fP -.LP -.SH "SEE ALSO" -.LP -.LP -.na -\f2java.io.ObjectStreamClass\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/io/ObjectStreamClass.html -.LP +.SH NAME +serialver \- Returns the serial version UID for specified classes\&. +.SH SYNOPSIS +.sp +.nf +\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassnames\fR +The classes for which the \f3serialVersionUID\fR is to be returned\&. +.SH DESCRIPTION +The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. +.SH OPTIONS +.TP +-classpath \fIpath-files\fR +.br +Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. +.TP +-show +.br +Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.manager\fP +.fi +.nf +\f3\fP +.fi +.sp +When necessary, a security policy can be specified with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.policy=<policy file>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +policytool(1) +.TP 0.2i +\(bu +The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/servertool.1 b/jdk/src/bsd/doc/man/servertool.1 index bde1b312f35..b48e407c6b3 100644 --- a/jdk/src/bsd/doc/man/servertool.1 +++ b/jdk/src/bsd/doc/man/servertool.1 @@ -1,113 +1,138 @@ -." Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH servertool 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: servertool.1 +.\" +.if n .pl 99999 +.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -servertool \- The Java(TM) IDL Server Tool -.LP -\f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -servertool \-ORBInitialPort \fP\f4nameserverport\fP\f3 \fP\f3options\fP\f3 [ \fP\f3commands\fP\f3 ] -.fl -\fP -.fi +.SH NAME +servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -If you did not enter a command when starting \f2servertool\fP, the command\-line tool displays with a \f2servertool >\fP prompt. Enter commands at the \f2servertool >\fP prompt. -.LP -.LP -If you enter a command when starting \f2servertool\fP, the Java IDL Server Tool starts, runs the command, and exits. -.LP -.LP -The \f2\-ORBInitialPort\fP \f2nameserverport\fP option is \f3required\fP. The value for \f2nameserverport\fP must specify the port on which \f2orbd\fP is running and listening for incoming requests. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024 for the \f2nameserverport\fP. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f2servertool\fP provides the command\-line interface for the application programmers to register, unregister, startup, and shutdown a persistent server. Other commands are provided to obtain various statistical information about the server. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-ORBInitialHost nameserverhost -Specifies the host machine on which the name server is running and listening for incoming requests. The \f2nameserverhost\fP defaults to \f2localhost\fP if this option is not specified. If \f2orbd\fP and \f2servertool\fP are running on different machines, you must specify the name or IP address of the host on which \f2orbd\fP is running. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.RE +\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +commands +The command-line commands\&. See Commands\&. +.SH DESCRIPTION +The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. +.SH OPTIONS +.TP +-ORBInitialHost \fInameserverhost\fR +.br +This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. -.LP -.SH "COMMANDS" -.LP -.RS 3 -.TP 3 -register \-server\ <server\ class\ name> \ \-classpath\ <classpath\ to\ server> [\ \-applicationName\ <application\ name> \-args\ <args\ to\ server> \-vmargs\ <flags\ to\ be\ passed\ to\ Java\ VM> \ ] -Register a new persistent server with the Object Request Broker Daemon (ORBD). If the server is not already registered, it is registered and activated. This command causes an install method to be invoked in the main class of the server identified by the \f2\-server\fP option. The install method must be \f2public static void install(org.omg.CORBA.ORB)\fP. The install method is optional and enables the developer to provide their own server installation behavior (for example, creating database schema). -.TP 3 -unregister \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Unregister a server from the ORBD by using either its server id or its application name. This command causes an uninstall method to be invoked in the main class of the server identified by the \f2\-server\fP option. The uninstall method must be \f2public static void uninstall(org.omg.CORBA.ORB)\fP. The uninstall method is optional and enables the developer to provide their own server uninstall behavior (for example, undoing the behavior of the install method). -.TP 3 -getserverid \-applicationName\ <application\ name> -Return the server id that corresponds with an application. -.TP 3 +\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH COMMANDS +You can start the \f3servertool\fR command with or without a command-line command\&. +.TP 0.2i +\(bu +If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. +.TP 0.2i +\(bu +If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. +.TP +.ll 180 +register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] +Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. +.TP +.ll 180 +unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. +.TP +getserverid -applicationName \fIapplication-name\fR +Returns the server ID that corresponds to the \f3application-name\fR value\&. +.TP list -List information about all persistent servers registered with the ORBD. -.TP 3 +Lists information about all persistent servers registered with the ORBD\&. +.TP listappnames -List the application names for all servers currently registered with the ORBD. -.TP 3 +Lists the application names for all servers currently registered with the ORBD\&. +.TP listactive -List information about all persistent servers that have been launched by the ORBD and are currently running. -.TP 3 -locate \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-endpointType\ <endpointType>\ ] -Locate the endpoints (ports) of a specific type for all ORBs created by a registered server. If a server is not already running, it is activated. If an endpoint type is not specified, then the plain/non\-protected endpoint associated with each ORB in a server is returned. -.TP 3 -locateperorb \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-orbid\ <ORB\ name>\ ] -Locate all the endpoints (ports) registered by a specific ORB of registered server. If a server is not already running, then it is activated. If an \f2orbid\fP is not specified, the default value of "" is assigned to the \f2orbid\fP. If any ORBs are created with an \f2orbid\fP of empty string, all ports registered by it are returned. -.TP 3 -orblist \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Lists the ORBId of the ORBs defined on a server. An ORBId is the string name for the ORB created by the server. If the server is not already running, it is activated. -.TP 3 -shutdown \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Shutdown an active server that is registered with ORBD. During execution of this command, the \f2shutdown()\fP method defined in the class specified by either the \f2\-serverid\fP or \f2\-applicationName\fP parameter is also invoked to shutdown the server process appropriately. -.TP 3 -startup \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Startup or activate a server that is registered with ORBD. If the server is not running, this command launches the server. If the server is already running, an error message is returned to the user. -.TP 3 +Lists information about all persistent servers that were started by the ORBD and are currently running\&. +.TP +.ll 180 +locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] +Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. +.TP +.ll 180 +locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] +Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. +.TP +orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. +.TP +shutdown -serverid \fIserver-id\fR | -applicationName application-name +Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. +.TP +startup -serverid \fIserver-id\fR | -applicationName application-name +Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. +.TP help -List all the commands available to the server through the server tool. -.TP 3 +Lists all the commands available to the server through the \f3servertool\fR command\&. +.TP quit -Exit the server tool. -.RE - -.LP -.SH "SEE ALSO" -.LP +Exits the \f3servertool\fR command\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu orbd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/tnameserv.1 b/jdk/src/bsd/doc/man/tnameserv.1 index 2f254de03d4..e883ab6008a 100644 --- a/jdk/src/bsd/doc/man/tnameserv.1 +++ b/jdk/src/bsd/doc/man/tnameserv.1 @@ -1,494 +1,489 @@ -." Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH tnameserv 1 "10 May 2011" +'\" t +.\" Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: tnameserv.1 +.\" +.if n .pl 99999 +.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -Java IDL: Transient Naming Service \- \f2tnameserv\fP -.LP -.LP -This document discusses using the Java IDL Transient Naming Service, \f2tnameserv\fP. Java IDL also includes the Object Request Broker Daemon (ORBD). ORBD is a daemon process containing a Bootstrap Service, a Transient Naming Service, a \f3Persistent\fP Naming Service, and a Server Manager. The Java IDL tutorials all use ORBD, however, you can substitute \f2tnameserv\fP for \f2orbd\fP in any of the examples that use a Transient Naming Service. For documentation on the \f2orbd\fP tool, link to its orbd(1) or the -.na -\f2Java IDL Naming Service Included with ORBD\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html topic. -.LP -.LP -Topics in this section include: -.LP -.RS 3 -.TP 2 -o -Java\ IDL Transient Naming Service -.TP 2 -o -Starting the Java\ IDL Transient Naming Service -.TP 2 -o -Stopping the Java\ IDL Transient Naming Service -.TP 2 -o -Sample Client: Adding Objects to the Namespace -.TP 2 -o -Sample Client: Browsing the Namespace -.RE - -.LP -.SH "Java\ IDL Transient Naming Service" -.LP -.LP -The CORBA COS (Common Object Services) Naming Service provides a tree\-like directory for object references much like a filesystem provides a directory structure for files. The Transient Naming Service provided with Java IDL, \f2tnameserv\fP, is a simple implementation of the COS Naming Service specification. -.LP -.LP -Object references are stored in the namespace by name and each object reference\-name pair is called a name \f2binding\fP. Name bindings may be organized under \f2naming contexts\fP. Naming contexts are themselves name bindings and serve the same organizational function as a file system subdirectory. All bindings are stored under the \f2initial naming context\fP. The initial naming context is the only persistent binding in the namespace; the rest of the namespace is lost if the Java IDL naming service process halts and restarts. -.LP -.LP -For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to a stringified initial naming context for that naming service. The naming service can either be the Java\ IDL naming service or another COS\-compliant naming service. -.LP -.SH "Starting the Java\ IDL Transient Naming Service" -.LP -.LP -You must start the Java\ IDL naming service before an application or applet that uses its naming service. Installation of the Java\ IDL product creates a script (Solaris: \f2tnameserv\fP) or executable file (Windows NT: \f2tnameserv.exe\fP) that starts the Java\ IDL naming service. Start the naming service so it runs in the background. -.LP -.LP -If you do not specify otherwise, the Java\ IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f2resolve_initial_references()\fP and \f2list_initial_references()\fP methods, as follows: -.LP -.nf -\f3 -.fl - tnameserv \-ORBInitialPort \fP\f4nameserverport\fP\f3& -.fl -\fP -.fi - -.LP -.LP -If you do not specify the name server port, port 900 is used by default. When running Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: -.LP -.nf -\f3 -.fl - tnameserv \-ORBInitialPort 1050& -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start tnameserv \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Clients of the name server must be made aware of the new port number. Do this by setting the \f2org.omg.CORBA.ORBInitialPort\fP property to the new port number when creating the ORB object. -.LP -.SS -Running the server and client on different hosts -.LP -.LP -In most of the Java IDL and RMI\-IIOP tutorials, the Naming Service, Server, and Client are all running on the development machine. In real world deployment, it is likely that the client and server will run on different host machines than the Naming Service. -.LP -.LP -For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running. Do this by setting the \f2org.omg.CORBA.ORBInitialPort\fP and \f2org.omg.CORBA.ORBInitialHost\fP properties in the client and server files to the machine name and port number on which the Naming Service is running. An example of this is shown in -.na -\f2The Hello World Example Using RMI\-IIOP\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/rmi\-iiop/rmiiiopexample.html. You could also use the command line options \f2\-ORBInitialPort\fP \f2nameserverport#\fP and \f2\-ORBInitialHost\fP \f2nameserverhostname\fP to tell the client and server where to find the Naming Service. -.na -\f2Java IDL: Running the Hello World Example on TWO Machines\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/tutorial/jidl2machines.html shows one way of doing this using the command line option. -.LP -.LP -For example, suppose the Transient Naming Service, \f2tnameserv\fP is running on port 1050 on host \f2nameserverhost\fP. The client is running on host \f2clienthost\fP and the server is running on host \f2serverhost\fP. -.LP -.RS 3 -.TP 2 -o -Start \f2tnameserv\fP on the host \f2nameserverhost\fP, as follows: -.nf -\f3 -.fl - tnameserv \-ORBInitialPort 1050 -.fl - -.fl -\fP -.fi -.TP 2 -o -Start the server on the \f2serverhost\fP, as follows: -.nf -\f3 -.fl - java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost -.fl -\fP -.fi -.TP 2 -o -Start the client on the \f2clienthost\fP, as follows: -.nf -\f3 -.fl - java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost -.fl -\fP -.fi -.RE - -.LP -.SS -The \-J option -.LP -This command\-line option is available for use with \f2tnameserve\fP: -.RS 3 -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.RE - -.LP -.SH "Stopping the Java\ IDL Transient Naming Service" -.LP -.LP -To stop the Java\ IDL naming service, use the relevant operating system command, such as \f2kill\fP for a Unix process, or \f2Ctrl\-C\fP for a Windows process. The naming service will continue to wait for invocations until it is explicitly shutdown. Note that names registered with the Java\ IDL naming service disappear when the service is terminated. -.LP -.SH "Sample Client: Adding Objects to the Namespace" -.LP -.LP -The following sample program illustrates how to add names to the namespace. It is a self\-contained Transient Naming Service client that creates the following simple tree. -.LP -.RS 3 -.TP 2 -o -\f4Initial Naming Context\fP -.RS 3 -.TP 2 -* -\f3plans\fP -.TP 2 -* -\f4Personal\fP -.RS 3 -.TP 2 -- -\f3calendar\fP -.TP 2 -- -\f3schedule\fP -.RE -.RE -.RE - -.LP -.LP -In this example, \f3plans\fP is an object reference and \f3Personal\fP is a naming context that contains two object references: \f3calendar\fP and \f3schedule\fP. -.LP -.nf -\f3 -.fl -import java.util.Properties; -.fl -import org.omg.CORBA.*; -.fl -import org.omg.CosNaming.*; -.fl - -.fl -public class NameClient -.fl -{ -.fl - public static void main(String args[]) -.fl - { -.fl - try { -.fl -\fP -.fi - -.LP -In the above section, Starting the Java IDL Transient Naming Service, the nameserver was started on port 1050. The following code ensures that the client program is aware of this port number. -.nf -\f3 -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - ORB orb = ORB.init(args, props); -.fl - -.fl -\fP -.fi - -.LP -This code obtains the initial naming context and assigns it to \f3ctx\fP. The second line copies \f3ctx\fP into a dummy object reference \f3objref\fP that we'll attach to various names and add into the namespace. -.nf -\f3 -.fl - NamingContext ctx = -.fl -NamingContextHelper.narrow(orb.resolve_initial_references("NameService")); -.fl - NamingContext objref = ctx; -.fl - -.fl -\fP -.fi - -.LP -This code creates a name "plans" of type "text" and binds it to our dummy object reference. "plans" is then added under the initial naming context using \f2rebind\fP. The \f2rebind\fP method allows us to run this program over and over again without getting the exceptions we'd get from using \f2bind\fP. -.nf -\f3 -.fl - NameComponent nc1 = new NameComponent("plans", "text"); -.fl - NameComponent[] name1 = {nc1}; -.fl - ctx.rebind(name1, objref); -.fl - System.out.println("plans rebind sucessful!"); -.fl - -.fl -\fP -.fi - -.LP -This code creates a naming context called "Personal" of type "directory". The resulting object reference, \f3ctx2\fP, is bound to the name and added under the initial naming context. -.nf -\f3 -.fl - NameComponent nc2 = new NameComponent("Personal", "directory"); -.fl - NameComponent[] name2 = {nc2}; -.fl - NamingContext ctx2 = ctx.bind_new_context(name2); -.fl - System.out.println("new naming context added.."); -.fl - -.fl -\fP -.fi - -.LP -The remainder of the code binds the dummy object reference using the names "schedule" and "calendar" under the "Personal" naming context (\f3ctx2\fP). -.nf -\f3 -.fl - NameComponent nc3 = new NameComponent("schedule", "text"); -.fl - NameComponent[] name3 = {nc3}; -.fl - ctx2.rebind(name3, objref); -.fl - System.out.println("schedule rebind sucessful!"); -.fl - -.fl - NameComponent nc4 = new NameComponent("calender", "text"); -.fl - NameComponent[] name4 = {nc4}; -.fl - ctx2.rebind(name4, objref); -.fl - System.out.println("calender rebind sucessful!"); -.fl - -.fl - -.fl - } catch (Exception e) { -.fl - e.printStackTrace(System.err); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi - -.LP -.SH "Sample Client: Browsing the Namespace" -.LP -.LP -The following sample program illustrates how to browse the namespace. -.LP -.nf -\f3 -.fl -import java.util.Properties; -.fl -import org.omg.CORBA.*; -.fl -import org.omg.CosNaming.*; -.fl - -.fl -public class NameClientList -.fl -{ -.fl - public static void main(String args[]) -.fl - { -.fl - try { -.fl -\fP -.fi - -.LP -In the above section, Starting the Java IDL Transient Naming Service, the nameserver was started on port 1050. The following code ensures that the client program is aware of this port number. -.nf -\f3 -.fl - -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - ORB orb = ORB.init(args, props); -.fl - -.fl - -.fl -\fP -.fi - -.LP -The following code obtains the intial naming context. -.nf -\f3 -.fl - NamingContext nc = -.fl -NamingContextHelper.narrow(orb.resolve_initial_references("NameService")); -.fl - -.fl -\fP -.fi - -.LP -The \f2list\fP method lists the bindings in the naming context. In this case, up to 1000 bindings from the initial naming context will be returned in the BindingListHolder; any remaining bindings are returned in the BindingIteratorHolder. -.nf -\f3 -.fl - BindingListHolder bl = new BindingListHolder(); -.fl - BindingIteratorHolder blIt= new BindingIteratorHolder(); -.fl - nc.list(1000, bl, blIt); -.fl - -.fl -\fP -.fi - -.LP -This code gets the array of bindings out of the returned BindingListHolder. If there are no bindings, the program ends. -.nf -\f3 -.fl - Binding bindings[] = bl.value; -.fl - if (bindings.length == 0) return; -.fl - -.fl -\fP -.fi - -.LP -The remainder of the code loops through the bindings and prints the names out. -.nf -\f3 -.fl - for (int i=0; i < bindings.length; i++) { -.fl - -.fl - // get the object reference for each binding -.fl - org.omg.CORBA.Object obj = nc.resolve(bindings[i].binding_name); -.fl - String objStr = orb.object_to_string(obj); -.fl - int lastIx = bindings[i].binding_name.length\-1; -.fl - -.fl - // check to see if this is a naming context -.fl - if (bindings[i].binding_type == BindingType.ncontext) { -.fl - System.out.println( "Context: " + -.fl -bindings[i].binding_name[lastIx].id); -.fl - } else { -.fl - System.out.println("Object: " + -.fl -bindings[i].binding_name[lastIx].id); -.fl - } -.fl - } -.fl - -.fl - } catch (Exception e) { -.fl - e.printStackTrace(System.err); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi - -.LP +.SH NAME +tnameserv \- Interface Definition Language (IDL)\&. +.SH SYNOPSIS +.sp +.nf +\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] +.fi +.sp +.TP +-ORBInitialPort \fInameserverport\fR +.br +The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. +.SH DESCRIPTION +Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. +.PP +See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.PP +The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. +.PP +Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. +.PP +For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. +.SS START\ THE\ NAMING\ SERVICE +You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. +.PP +If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: +.sp +.nf +\f3tnameserv \-ORBInitialPort nameserverport&\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. +.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS +In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. +.PP +For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html +.PP +You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html +.PP +For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. +.PP +Start \f3tnameserv\fR on the host \f3nameserverhost\fR: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the server on the \f3serverhost\fR: +.sp +.nf +\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the client on the \f3clienthost\fR: +.sp +.nf +\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ NAMING\ SERVICE +To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. +.SH OPTIONS +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH EXAMPLES +.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE +The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. +.sp +.nf +\f3Initial Naming Context\fP +.fi +.nf +\f3 plans\fP +.fi +.nf +\f3 Personal\fP +.fi +.nf +\f3 calendar\fP +.fi +.nf +\f3 schedule\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClient {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. +.sp +.nf +\f3 NamingContext ctx =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3 NamingContext objref = ctx;\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. +.sp +.nf +\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP +.fi +.nf +\f3 NameComponent[] name1 = {nc1};\fP +.fi +.nf +\f3 ctx\&.rebind(name1, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("plans rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. +.sp +.nf +\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP +.fi +.nf +\f3 NameComponent[] name2 = {nc2};\fP +.fi +.nf +\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP +.fi +.nf +\f3 System\&.out\&.println("new naming context added\&.\&.");\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. +.sp +.nf +\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP +.fi +.nf +\f3 NameComponent[] name3 = {nc3};\fP +.fi +.nf +\f3 ctx2\&.rebind(name3, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("schedule rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP +.fi +.nf +\f3 NameComponent[] name4 = {nc4};\fP +.fi +.nf +\f3 ctx2\&.rebind(name4, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("calender rebind successful!");\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS BROWSING\ THE\ NAME\ SPACE +The following sample program shoes how to browse the name space\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClientList {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +The following code obtains the initial naming context\&. +.sp +.nf +\f3 NamingContext nc =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. +.sp +.nf +\f3 BindingListHolder bl = new BindingListHolder();\fP +.fi +.nf +\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP +.fi +.nf +\f3 nc\&.list(1000, bl, blIt);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. +.sp +.nf +\f3 Binding bindings[] = bl\&.value;\fP +.fi +.nf +\f3 if (bindings\&.length == 0) return;\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code loops through the bindings and prints outs the names\&. +.sp +.nf +\f3 for (int i=0; i < bindings\&.length; i++) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // get the object reference for each binding\fP +.fi +.nf +\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP +.fi +.nf +\f3 String objStr = orb\&.object_to_string(obj);\fP +.fi +.nf +\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // check to see if this is a naming context\fP +.fi +.nf +\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP +.fi +.nf +\f3 System\&.out\&.println("Context: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 } else {\fP +.fi +.nf +\f3 System\&.out\&.println("Object: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err)\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/unpack200.1 b/jdk/src/bsd/doc/man/unpack200.1 index 41088891593..2327bc02cac 100644 --- a/jdk/src/bsd/doc/man/unpack200.1 +++ b/jdk/src/bsd/doc/man/unpack200.1 @@ -1,156 +1,138 @@ -." Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH unpack200 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: unpack200.1 +.\" +.if n .pl 99999 +.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -unpack200 \- JAR Unpacking tool -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4unpack200\fP\f2 [ \fP\f2options\fP ] \f2input\-file\fP \f2JAR\-file\fP -.LP -.LP -Options may be in any order. The last option on the command line supersedes all previously specified options. -.LP -.RS 3 -.TP 3 -input\-file -Name of the input file, which can be a pack200 gzip file or a pack200 file. The input could also be JAR file produced by pack200(1) with an effort of 0. In this case the contents of the input file will be copied to the output JAR file with the Pack200 marker. -.TP 3 -JAR\-file -Name of the output JAR file. -.RE +.SH NAME +unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f2unpack200\fP is a native implementation that transforms a packed file produced by \f2pack200\fP(1) into a JAR file. Typical usage: -.LP -.LP -\f2% unpack200 myarchive.pack.gz myarchive.jar\fP -.LP -.LP -In this example, the \f2myarchive.jar\fP is produced from \f2myarchive.pack.gz\fP using the default \f2unpack200\fP settings. -.LP -.SH "OPTIONS" -.LP -.LP -\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP -.LP -.LP -Sets the deflation to be \f2true\fP, \f2false\fP, or \f2keep\fP on all entries within a JAR file. The default mode is \f2keep\fP. If \f2true\fP or \f2false\fP, overrides the default behavior and sets the deflation mode on all entries within the output JAR file. -.LP -.LP -\f4\-r \-\-remove\-pack\-file\fP -.LP -.LP -Removes the input packed file. -.LP -.LP -\f4\-v \-\-verbose\fP -.LP -.LP -Outputs minimal messages. Multiple specification of this option will output more verbose messages. -.LP -.LP -\f4\-q \-\-quiet\fP -.LP -.LP -Specifies quiet operation with no messages. -.LP -.LP -\f4\-lfilename \-\-log\-file=\fP\f2filename\fP -.LP -.LP -Specifies a log file to output messages. -.LP -.LP -\f4\-? \-h \-\-help\fP -.LP -.LP -Prints help information about this command. -.LP -.LP -\f4\-V \-\-version\fP -.LP -.LP -Prints version information about this command. -.LP -.LP -\f4\-J\fP\f2option\fP -.LP -.LP -Passes \f2option\fP to the Java launcher called by \f2unpack200\fP. -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are returned: -.LP -.LP -\f2\ 0\fP if successful completion; -.LP -.LP -\f2>0\fP if an error occurred. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o +\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIinput-file\fR +Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. +.TP +\fIJAR-file\fR +Name of the output JAR file\&. +.SH DESCRIPTION +The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. +.sp +.nf +\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-Hvalue --deflate-hint=\fIvalue\fR +.br +Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. +.TP +-r --remove-pack-file +.br +Removes the input pack file\&. +.TP +-v --verbose +.br +Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. +.TP +-q --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-lfilename --log-file=\fIfilename\fR +.br +Specifies a log file where output messages are logged\&. +.TP +-? -h --help +.br +Prints help information about the \f3unpack200\fR command\&. +.TP +-V --version +.br +Prints version information about the \f3unpack200\fR command\&. +.TP +-J\fIoption\fR +.br +Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu pack200(1) -.TP 2 -o -.na -\f2Java SE Documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/index.html -.TP 2 -o -.na -\f2Java Deployment Guide \- Pack200\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html -.TP 2 -o -jar(1) \- Java Archive Tool -.TP 2 -o -jarsigner(1) \- JAR Signer tool -.TP 2 -o -\f2attributes(5)\fP man page -.RE - -.LP -.SH "NOTES" -.LP -.LP -This command should not be confused with \f2unpack(1)\fP. They are distinctly separate products. -.LP -.LP -The Java SE API Specification provided with the JDK is the superseding authority, in case of discrepancies. -.LP - +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html +.TP 0.2i +\(bu +The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/wsgen.1 b/jdk/src/bsd/doc/man/wsgen.1 index 07ffe43aab7..56776b59781 100644 --- a/jdk/src/bsd/doc/man/wsgen.1 +++ b/jdk/src/bsd/doc/man/wsgen.1 @@ -1,596 +1,176 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH wsgen 1 "10 May 2011" -.SH "Name" -wsgen \- Java(TM) API for XML Web Services (JAX\-WS) 2.0 -.LP -\f3Specification Version:\fP 2.1 -.br -\f3Implementation Version:\fP 2.1.1 -.LP -The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint implementation class (SEI) and generates all the required artifacts for web service deployment, and invocation -.SH "Overview" -.LP -The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment, and invocation. JAXWS 2.1.1 RI also provides a wsgen ant task, see -.na -\f2Wsgen ant task\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/wsgenant.html for details. -.LP -.SH "Launching wsgen" -.RS 3 -.TP 2 -o -\f3Solaris/Bsd\fP -.RS 3 -.TP 2 -* -\f2export JAXWS_HOME=/pathto/jaxws\-ri\fP -.TP 2 -* -\f2$JAXWS_HOME/bin/wsgen.sh \-help\fP -.RE -.TP 2 -o -\f3Windows\fP -.RS 3 -.TP 2 -* -\f2set JAXWS_HOME=c:\\pathto\\jaxws\-ri\fP -.TP 2 -* -\f2%JAXWS_HOME%\\bin\\wsgen.bat \-help\fP -.RE -.RE +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsgen.1 +.\" +.if n .pl 99999 +.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Syntax" -.nf -\f3 -.fl -wsgen [options] <SEI>\fP -.br -\f3 -.fl -\fP -.fi -.LP -The following table lists the \f2wsgen\fP options. -.br -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to find input class files -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Same as \f2\-classpath <path>\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated output files -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -allow vendor extensions (functionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \-wsdl option. Specify where to place generated resource files such as WSDLs -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated source files -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Output messages about what the compiler is doing -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print version information. Use of this option will ONLY print version information. Normal processing will not occur. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -By default \f2wsgen\fP does not generate a WSDL file. This flag is optional and will cause \f2wsgen\fP to generate a WSDL file and is usually only used so that the developer can look at the WSDL before the endpoint is deploy. The \f2protocol\fP is optional and is used to specify what protocol should be used in the \f2wsdl:binding\fP. Valid protocols include: \f2soap1.1\fP and \f2Xsoap1.2\fP. The default is \f2soap1.1\fP. \f2Xsoap1.2\fP is not standard and can only be used in conjunction with the \f2\-extension\fP option. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particular \f2wsdl:service\fP name to be generated in the WSDL. Example, \f2\-servicename "{http://mynamespace/}MyService"\fP -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particular \f2wsdl:port\fP name to be generated in the WSDL. Example, \f2\-portname "{http://mynamespace/}MyPort"\fP -.br -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-classpath <path>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-cp <path>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-d <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-extension\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-help\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-keep\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-r <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-s <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-verbose\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-version\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-wsdl[:protocol]\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-servicename <name>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-portname <name>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wDisplay help -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wKeep generated files -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 133 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-classpath <path>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-cp <path>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-d <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-extension\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-help\fP\h'|\n(41u'Display help -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-keep\fP\h'|\n(41u'Keep generated files -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-r <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-s <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-verbose\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-version\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-wsdl[:protocol]\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-servicename <name>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-portname <name>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-53 +.SH NAME +wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "Example" -.nf -\f3 -.fl -\fP\f3wsgen \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -This will generate the wrapper classes needed for StockService annotated with @WebService annotation inside \f3stock\fPdirectory. -.nf -\f3 -.fl -\fP\f3wsgen \-wsdl \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -This will generate a SOAP 1.1 WSDL and schema for your Java class stock.StockService annotated with @WebService annotation. -.nf -\f3 -.fl -\fP\f3wsgen \-wsdl:Xsoap1.2 \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -Will generate a SOAP 1.2 WSDL. -.LP -Note that you do not have to generate WSDL at the development time as JAXWS runtime will automatically generate a WSDL for you when you deploy your service. +\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fISEI\fR +The web service endpoint implementation class (SEI) to be read\&. +.SH DESCRIPTION +The \f3wsgen\fR command generates JAX-WS portable artifacts used in JAX-WS web services\&. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment and invocation\&. JAXWS 2\&.1\&.1 RI also provides a \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.PP +To start the \f3wsgen\fR command, do the following: +.sp +.nf +\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP +.fi +.nf +\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +The location of the input class files\&. +.TP +-cp \fIpath\fR +.br +The location of the input class files\&. +.TP +-d \fIdirectory\fR +.br +The location for where to place generated output files\&. +.TP +-extension +.br +Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message about the \f3wsgen\fR command\&. +.TP +-keep +.br +Keeps the generated files\&. +.TP +-r \fIdirectory\fR +.br +Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. +.TP +-s \fIdirectory\fR +.br +The location for where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdl [ :protocol ] \fI\fR +.br +An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. + +By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. +.TP +-servicename \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. +.TP +-portname \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. +.SH EXAMPLES +The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. +.sp +.nf +\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. +.sp +.nf +\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.2 WSDL\&. +.sp +.nf +\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsimport(1) +.TP 0.2i +\(bu +\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/wsimport.1 b/jdk/src/bsd/doc/man/wsimport.1 index 92f80027bb3..edc3ef56d40 100644 --- a/jdk/src/bsd/doc/man/wsimport.1 +++ b/jdk/src/bsd/doc/man/wsimport.1 @@ -1,975 +1,217 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH wsimport 1 "10 May 2011" -.SH "Name" -wsimport \- Java(TM) API for XML Web Services (JAX\-WS) 2.0 -.LP -\f3Specification Version:\fP 2.1 -.br -\f3Implementation Version:\fP 2.1.1 -.br -.SH "Overview" -.LP -The \f2wsimport\fP tool generates JAX\-WS portable artifacts, such as: -.RS 3 -.TP 2 -o +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsimport.1 +.\" +.if n .pl 99999 +.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. +.SH SYNOPSIS +.sp +.nf + +\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIwsdl\fR +The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. +.SH DESCRIPTION +The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu Service Endpoint Interface (SEI) -.TP 2 -o +.TP 0.2i +\(bu Service -.TP 2 -o -Exception class mapped from wsdl:fault (if any) -.TP 2 -o -Async Reponse Bean derived from response wsdl:message (if any) -.TP 2 -o +.TP 0.2i +\(bu +Exception class is mapped from \f3wsdl:fault\fR (if any) +.TP 0.2i +\(bu +Async Response Bean is derived from response \f3wsdl:message\fR (if any) +.TP 0.2i +\(bu JAXB generated value types (mapped java classes from schema types) -.RE -.LP -These artifacts can be packaged in a WAR file with the WSDL and schema documents along with the endpoint implementation to be deployed. also provides wsimport ant task, see -.na -\f2Wsimport ant task\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/wsimportant.html. +.PP +To start the \f3wsgen\fR command, do the following: +.PP +\fIOracle Solaris/Linux\fR: +.sp +.nf +\f3/bin/wsimport\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +\fIWindows\fR: +.sp +.nf +\f3\ebin\ewsimport\&.bat \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-d \fIdirectory\fR .br +Specifies where to place generated output files\&. +.TP +-b \fIpath\fR +.br +Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP +-B \fIjaxbOption\fR +.br +Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. +.TP +-catalog +.br +Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP +-extension +.br +Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message for the \f3wsimport\fR command\&. +.TP +-httpproxy: \fIhost\fR:\fIport\fR +.br +Specifies an HTTP proxy server\&. The default is 8080\&. +.TP +-keep +.br +Keeps generated files\&. +.TP +-p \fIname\fR +.br +Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. +.TP +-s \fIdirectory\fR +.br +Specifies where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdllocation \fIlocation\fR +.br +Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. +.TP +-target +.br +Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. +.TP +-quiet +.br +Suppresses the \f3wsimport\fR command output\&. +.PP +Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html +.SH NONSTANDARD\ OPTIONS +.TP +-XadditionalHeaders +.br +Maps headers not bound to a request or response message to Java method parameters\&. +.TP +-Xauthfile \fIfile\fR +.br +The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: -.LP -.SH "Launching wsimport" -.RS 3 -.TP 2 -o -\f3Solaris/Bsd\fP -.RS 3 -.TP 2 -* -\f2/bin/wsimport.sh \-help\fP -.RE -.TP 2 -o -\f3Windows\fP -.RS 3 -.TP 2 -* -\f2\\bin\\wsimport.bat \-help\fP -.RE -.RE - -.LP -.SH "Syntax" -.nf -\f3 -.fl -wsimport [options] <wsdl> -.fl -\fP -.fi -.LP -The following table lists the \f2wsimport\fP options. -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. +.TP +-Xdebug .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated output files +Prints debugging information\&. +.TP +-Xno-addressing-databinding .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Enables binding of W3C EndpointReferenceType to Java\&. +.TP +-Xnocompile .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify external JAX\-WS or JAXB binding files (Each \f2<file>\fP must have its own \f2\-b\fP) -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Pass this option to JAXB schema compiler -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify catalog file to resolve external entity references, it supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the documentation of -.na -\f2catalog\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/catalog\-support.html and see \f3catalog\fP sample. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Allow vendor extensions (functionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-httpproxy:<host>:<port> \fP -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify an HTTP proxy server (port defaults to 8080) -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specifying a target package via this command\-line option, overrides any wsdl and schema binding customization for package name and the default package name algorithm defined in the specification -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated source files -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Output messages about what the compiler is doing -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print version information -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-wsdllocation <location>\fP -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@WebServiceClient.wsdlLocation\fP value -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Generate code as per the given JAX\-WS specification version. version 2.0 will generate compliant code for JAX\-WS 2.0 spec. -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-d <directory> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-b <path> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-B <jaxbOption>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-catalog\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-extension \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-help \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-keep \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-p \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-s <directory> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-verbose \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-version \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-target \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-quiet \fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(f- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(l- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wDisplay help -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wKeep generated files -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wSuppress wsimport output -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 157 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-d <directory> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-b <path> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-B <jaxbOption>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-catalog\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-extension \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-help \fP\h'|\n(41u'Display help -.ne \n(f|u+\n(.Vu -.ne \n(g|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-keep \fP\h'|\n(41u'Keep generated files -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-p \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-s <directory> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-verbose \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-version \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.ne \n(m|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-target \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-quiet \fP\h'|\n(41u'Suppress wsimport output -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-66 -.LP -Multiple JAX\-WS and JAXB binding files can be specified using \f2\-b\fP option and they can be used to customize various things like package names, bean names, etc. More information on JAX\-WS and JAXB binding files can be found in the -.na -\f2customization documentation\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/customizations.html. -.LP -The following table lists \f2wsimport\fP non\-standard options: -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Map headers not bound to request or response message to Java method parameters. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -WSDL URI that specifies the file that contains authorization information; this URI is in the following format: http://\f2<user name>\fP:\f2<password>\fP@\f2<host name>\fP/\f2<Web service name>\fP?wsdl -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print debugging information. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-Xno\-addressing\-databinding\fP -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Enable binding of W3C \f2EndpointReferenceType\fP to Java. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Do not compile generated Java files. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-XadditionalHeaders\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xauthfile <file>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xdebug\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xnocompile\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 193 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-XadditionalHeaders\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xauthfile <file>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xdebug\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xnocompile\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-26 - -.LP -.SH "Example" -.nf -\f3 -.fl -\fP\f3wsimport \-p stockquote http://stockquote.example.com/quote?wsdl\fP -.fl -.fi -.LP -This will generate the Java artifacts and compile them by importing the \f2http://stockquote.example.com/quote?wsdl\fP. -.br - +Does not compile the generated Java files\&. +.SH EXAMPLE +The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR +.sp +.nf +\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsgen(1) +.TP 0.2i +\(bu +The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/bsd/doc/man/xjc.1 b/jdk/src/bsd/doc/man/xjc.1 index d414abf903a..3956ce8e8a6 100644 --- a/jdk/src/bsd/doc/man/xjc.1 +++ b/jdk/src/bsd/doc/man/xjc.1 @@ -1,297 +1,233 @@ -." Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH xjc 1 "10 May 2011" +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: xjc.1 +.\" +.if n .pl 99999 +.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -xjc \- Java(TM) Architecture for XML Binding +.SH NAME +xjc \- Compiles an XML schema file into fully annotated Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +schema \fIfile/URL/dir/jar \&.\&.\&.\fR +The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. +.TP +-b \fIbindinfo\fR .br -Binding Compiler -.LP -.LP -\f3Specification Version:\fP 2.1 +The location of the bindings files\&. +.SH DESCRIPTION +Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html +.SH OPTIONS +.TP 0.2i +\(bu +See also Nonstandard Options +.TP 0.2i +\(bu +See also Deprecated and Removed Options +.TP +-nv .br -\f3Reference Implementation (RI) Version:\fP 2.1.3 -.LP -.SH "Launching xjc" -.LP -.LP -The binding compiler can be launched using the appropriate \f2xjc\fP shell script in the \f2bin\fP directory for your platform. We also provide an Ant task to run the binding complier \- see the instructions for -.na -\f2using the XJC Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html. -.LP -.LP -\f2% xjc \-help\fP -.LP -.SS -Output -.LP -.nf -\f3 -.fl -Usage: xjc [\-options ...] <schema file/URL/dir/jar> ... [\-b <bindinfo>] ... -.fl -If dir is specified, all schema files in it will be compiled. -.fl -If jar is specified, /META\-INF/sun\-jaxb.episode binding file will be compiled. -.fl -Options: -.fl - \-nv : do not perform strict validation of the input schema(s) -.fl - \-extension : allow vendor extensions \- do not strictly follow the Compatibility Rules and App E.2 from the JAXB Spec -.fl - \-b <file/dir> : specify external bindings files (each <file> must have its own \-b); if a directory is given, **/*.xjb is searched -.fl - \-d <dir> : generated files will go into this directory -.fl - \-p <pkg> : specifies the target package -.fl - \-httpproxy <proxy> : set HTTP/HTTPS proxy; format is [user[:password]@]proxyHost:proxyPort -.fl - \-httpproxyfile <f> : works like \-httpproxy but takes the argument in a file to protect password -.fl - \-classpath <arg> : specify where to find user class files -.fl - \-catalog <file> : specify catalog files to resolve external entity references; support TR9401, XCatalog, and OASIS XML Catalog format -.fl - \-readOnly : generated files will be in read\-only mode -.fl - \-npa : suppress generation of package level annotations (**/package\-info.java) -.fl - \-no\-header : suppress generation of a file header with timestamp -.fl - \-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features -.fl - \-xmlschema : treat input as W3C XML Schema (default) -.fl - \-relaxng : treat input as RELAX NG (experimental,unsupported) -.fl - \-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported) -.fl - \-dtd : treat input as XML DTD (experimental,unsupported) -.fl - \-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported) -.fl - \-verbose : be extra verbose -.fl - \-quiet : suppress compiler output -.fl - \-help : display this help message -.fl - \-version : display version information -.fl - -.fl - -.fl -Extensions: -.fl - \-Xlocator : enable source location support for generated code -.fl - \-Xsync\-methods : generate accessor methods with the 'synchronized' keyword -.fl - \-mark\-generated : mark the generated code as @javax.annotation.Generated -.fl - \-episode <FILE> : generate the episode file for separate compilation -.fl -\fP -.fi - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-nv -By default, the XJC binding compiler performs strict validation of the source schema before processing it. Use this option to disable strict schema validation. This does not mean that the binding compiler will not perform any validation, it simply means that it will perform less\-strict validation. -.TP 3 -\-extension -By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification. Appendix E.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1.0. In some cases, you may be allowed to use them in the "\-extension" mode enabled by this switch. In the default (strict) mode, you are also limited to using only the binding customizations defined in the specification. By using the "\-extension" switch, you will be allowed to use the JAXB Vendor Extensions -.TP 3 -\-b <file> -Specify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files: \f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP +By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. +.TP +-extension .br -\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP In addition, the ordering of the schema files and binding files on the command line does not matter. -.TP 3 -\-d <dir> -By default, the XJC binding compiler will generate the Java content classes in the current directory. Use this option to specify an alternate output directory. The output directory must already exist, the XJC binding compiler will not create it for you. -.TP 3 -\-p <pkg> -Specifying a target package via this command\-line option overrides any binding customization for package name and the default package name algorithm defined in the specification. -.TP 3 -\-httpproxy <proxy> -Specify the HTTP/HTTPS proxy. The format is [user[:password]@]proxyHost[:proxyPort]. The old \f2\-host\fP and \f2\-port\fP are still supported by the RI for backwards compatibility, but they have been deprecated. Note that the password specified with this option is an argument that is visible to other users who use the \f2top\fP command, for example. For greater security, use \f2\-httpproxyfile\fP, below. -.TP 3 -\-httpproxyfile <file> -Specify the HTTP/HTTPS proxy using a file. Same format as above, but the password specified in the file is not visible to other users. -.TP 3 -\-classpath <arg> -Specify where to find client application class files used by the \f2<jxb:javaType>\fP and \f2<xjc:superClass>\fP customizations. -.TP 3 -\-catalog <file> -Specify catalog files to resolve external entity references. Supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the XML Entity and URI Resolvers document or the \f2catalog\-resolver\fP sample application. -.TP 3 -\-readOnly -By default, the XJC binding compiler does not write\-protect the Java source files it generates. Use this option to force the XJC binding compiler to mark the generated Java sources read\-only. -.TP 3 -\-npa -Supress the generation of package level annotations into **/package\-info.java. Using this switch causes the generated code to internalize those annotations into the other generated classes. -.TP 3 -\-no\-header -Supress the generation of a file header comment that includes some note and timestamp. Using this makes the generated code more diff\-friendly. -.TP 3 -\-target 2.0 -Avoid generating code that relies on any JAXB 2.1 features. This will allow the generated code to run with JAXB 2.0 runtime (such as JavaSE 6.) -.TP 3 -\-xmlschema -Treat input schemas as W3C XML Schema (default). If you do not specify this switch, your input schemas will be treated as W3C XML Schema. -.TP 3 -\-relaxng -Treat input schemas as RELAX NG (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-relaxng\-compact -Treat input schemas as RELAX NG compact syntax(experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-dtd -Treat input schemas as XML DTD (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-wsdl -Treat input as WSDL and compile schemas inside it (experimental,unsupported). -.TP 3 -\-quiet -Suppress compiler output, such as progress information and warnings. -.TP 3 -\-verbose -Be extra verbose, such as printing informational messages or displaying stack traces upon some errors. -.TP 3 -\-help -Display a brief summary of the compiler switches. -.TP 3 -\-version -Display the compiler version information. -.TP 3 -<schema file/URL/dir> -Specify one or more schema files to compile. If you specify a directory, then xjc will scan it for all schema files and compile them. -.RE - -.LP -.SS -Non\-Standard Command Line Options -.LP -.RS 3 -.TP 3 -\-Xlocator -Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling. -.TP 3 -\-Xsync\-methods -Causes all of the generated method signatures to include the \f2synchronized\fP keyword. -.TP 3 -\-mark\-generated -Mark the generated code with the annotation \f2@javax.annotation.Generated\fP. -.TP 3 -\-episode <file> -Generate the specified episode file for separate compilation. -.RE - -.LP -.SS -Deprecated and Removed Command Line Options -.LP -.RS 3 -.TP 3 -\-host & \-port -These options have been deprecated and replaced with the \f3\-httpproxy\fP option. For backwards compatibility, we will continue to support these options, but they will no longer be documented and may be removed from future releases. -.TP 3 -\-use\-runtime -Since the JAXB 2.0 specification has defined a portable runtime, it is no longer necessary for the JAXB RI to generate **/impl/runtime packages. Therefore, this switch is obsolete and has been removed. -.TP 3 -\-source -The \-source compatibility switch was introduced in the first JAXB 2.0 Early Access release. We have decided to remove this switch from future releases of JAXB 2.0. If you need to generate 1.0.x code, please use an installation of the 1.0.x codebase. -.RE - -.LP -.SS -Compiler Restrictions -.LP -.LP -In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches. -.LP -.LP -Please keep the following list of restrictions in mind when running xjc. Most of these issues only apply when compiling multiple schemas with multiple invocations of xjc. -.LP -.RS 3 -.TP 2 -o +By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification\&. Appendix E\&.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1\&.0\&. In some cases, you may be allowed to use them in the \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. +.TP +-b \fIfile\fR +.br +Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. +.TP +-d \fIdir\fR +.br +By default, the XJC binding compiler generates the Java content classes in the current directory\&. Use this option to specify an alternate output directory\&. The output directory must already exist\&. The XJC binding compiler does not create it for you\&. +.TP +-p \fIpkg\fR +.br +When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. +.TP +-httpproxy \fIproxy\fR +.br +Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. +.TP +-httpproxyfile file +.br +Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. +.TP +-classpath arg +.br +Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. +.TP +-catalog file +.br +Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html +.TP +-readOnly +.br +By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. +.TP +-npa +.br +Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. +.TP +-no-header +.br +Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. +.TP +-target 2\&.0 +.br +Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. +.TP +-xmlschema +.br +Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. +.TP +-relaxing +.br +Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-relaxing-compact +.br +Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-dtd +.br +Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-wsdl +.br +Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. +.TP +-quiet +.br +Suppress compiler output, such as progress information and warnings\&. +.TP +-verbose +.br +Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. +.TP +-help +.br +Displays a brief summary of the compiler switches\&. +.TP +-version +.br +Displays the compiler version information\&. +.TP +\fIschema file/URL/dir\fR +Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. +.SS NONSTANDARD\ OPTIONS +.TP +-XLocator +.br +Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. +.TP +-Xsync-methods +.br +Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. +.TP +-mark-generated +.br +Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. +.TP +-episode file +.br +Generates the specified episode file for separate compilation\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +.TP +-host & -port +.br +These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. +.TP +-use-runtime +.br +Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. +.TP +-source +.br +The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. +.SH COMPILER\ RESTRICTIONS +In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. +.PP To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: -.RS 3 -.TP 3 -1. -The "\f2\-p\fP" command line option takes the highest precedence. -.TP 3 -2. -<\f2jaxb:package\fP> customization -.TP 3 -3. -If \f2targetNamespace\fP is declared, apply \f2targetNamespace\fP \-> Java package name algorithm defined in the specification. -.TP 3 -4. -If no \f2targetNamespace\fP is declared, use a hardcoded package named "generated". -.RE -.TP 2 -o -It is not legal to have more than one <\f2jaxb:schemaBindings\fP> per namespace, so it is impossible to have two schemas in the same target namespace compiled into different Java packages. -.TP 2 -o -All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time \- they cannot be compiled independently and work as expected. -.TP 2 -o -Element substitution groups spread across multiple schema files must be compiled at the same time. -.RE - -.LP -.SH "See Also" -.LP -.RS 3 -.TP 2 -o -Running the binding compiler (XJC): [ -.na -\f2command\-line instructions\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjc.html, -.na -\f2using the XJC Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html] -.TP 2 -o -.na -\f2Java Architecture for XML Binding (JAXB)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html -.RE - -.LP - +.TP 0.4i +1\&. +The \f3-p\fR option has the highest precedence\&. +.TP 0.4i +2\&. +\fIjaxb:package\fR customization\&. +.TP 0.4i +3\&. +If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. +.TP 0.4i +4\&. +If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. +.PP +You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. +.PP +All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. +.PP +Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/appletviewer.1 b/jdk/src/linux/doc/man/appletviewer.1 index 887abbd66e3..71ccac3c664 100644 --- a/jdk/src/linux/doc/man/appletviewer.1 +++ b/jdk/src/linux/doc/man/appletviewer.1 @@ -1,66 +1,90 @@ -." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH appletviewer 1 "10 May 2011" +'\" t +.\" Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: appletviewer.1 +.\" +.if n .pl 99999 +.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -appletviewer \- The Java Applet Viewer. -.LP -.LP -The \f3appletviewer\fP command allows you to run applets outside of a web browser. -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4appletviewer\fP \f2[\fP \f2options\fP \f2] \fP\f2urls\fP ... -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3appletviewer\fP command connects to the documents or resources designated by \f2urls\fP and displays each applet referenced by the documents in its own window. Note: if the documents referred to by \f2urls\fP do not reference any applets with the \f2OBJECT\fP, \f2EMBED\fP, or \f2APPLET\fP tag, then \f3appletviewer\fP does nothing. For details on the HTML tags that \f3appletviewer\fP supports, see -.na -\f2AppletViewer Tags\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/appletviewertags.html. -.LP -.LP -\f3Note:\fP The \f3appletviewer\fP requires encoded URLs according to the escaping mechanism defined in RFC2396. Only encoded URLs are supported. However, file names must be unencoded, as specified in RFC2396. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-debug -Starts the applet viewer in the Java debugger, jdb(1), thus allowing you to debug the applets in the document. -.TP 3 -\-encoding \ \ encoding name -Specify the input HTML file encoding name. -.TP 3 -\-Jjavaoption -Passes through the string \f2javaoption\fP as a single argument to the Java interpreter which runs the appletviewer. The argument should not contain spaces. Multiple argument words must all begin with the prefix \f3\-J\fP, which is stripped. This is useful for adjusting the compiler's execution environment or memory usage. -.RE +.SH NAME +appletviewer \- Runs applets outside of a web browser\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP - -.LP - +\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options separated by spaces\&. See Options\&. +.TP +\fIurl\fR +The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. +.SH DESCRIPTION +The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html +.PP +The \f3appletviewer\fR command requires encoded URLs according to the escaping mechanism defined in RFC2396\&. Only encoded URLs are supported\&. However, file names must be unencoded, as specified in RFC2396\&. +.PP +\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html +.SH OPTIONS +.TP +-debug +.br +Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. +.TP +-encoding \fIencoding-name\fR +.br +Specifies the input HTML file encoding name\&. +.TP +-J\fIjavaoption\fR +.br +Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. +.PP +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/extcheck.1 b/jdk/src/linux/doc/man/extcheck.1 index 9dfe6472adf..09599d3aa02 100644 --- a/jdk/src/linux/doc/man/extcheck.1 +++ b/jdk/src/linux/doc/man/extcheck.1 @@ -1,73 +1,91 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH extcheck 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: extcheck.1 +.\" +.if n .pl 99999 +.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -extcheck \- A utility to detect jar conflicts -.LP -.LP -\f3extcheck\fP detects version conflicts between a target jar file and currently installed extension jar files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -extcheck [ \-verbose ] targetfile.jar -.fl -\fP -.fi +.SH NAME +extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3extcheck\fP utility checks a specified Jar file for title and version conflicts with any extensions installed in the Java(TM) SDK. Before installing an extension, you can use this utility to see if the same or a more recent version of the extension is already installed. -.LP -.LP -The \f3extcheck\fP utility compares the \f2Specification\-title\fP and \f2Specification\-version\fP headers in the manifest of the \f2targetfile.jar\fP file against the corresponding headers in all Jar files currently installed in the extension directory. (The extension directory is \f2jre/lib/ext\fP by default.) The \f3extcheck\fP utility compares version numbers in the same way as the method \f2java.lang.Package.isCompatibleWith\fP. -.LP -.LP -If no conflict is detected, the return code is \f20\fP. -.LP -.LP -If the manifest of any jar file in the extensions directory has the same \f2Specification\-title\fP and the same or a newer \f2Specification\-version\fP number, a non\-zero error code is returned. A non\-zero error code is also returned if \f2targetfile.jar\fP does not have the \f2Specification\-title\fP or \f2Specification\-version\fP attributes in its manifest. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-verbose -Lists Jar files in the extension directory as they are checked. Additionally, manifest attributes of the target jar file and any conflicting jar files are also reported. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP +\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fItargetfile\&.jar\fR +The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. +.SH DESCRIPTION +The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. +.PP +The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. +.PP +If no conflict is detected, then the return code is 0\&. +.PP +If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. +.SH OPTIONS +.TP +-verbose +.br +Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. +.TP +-J\fIoption\fR +.br +Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu jar(1) -.LP - +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/idlj.1 b/jdk/src/linux/doc/man/idlj.1 index 2ed5652bc63..01130581906 100644 --- a/jdk/src/linux/doc/man/idlj.1 +++ b/jdk/src/linux/doc/man/idlj.1 @@ -1,739 +1,568 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH idlj 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: idlj.1 +.\" +.if n .pl 99999 +.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -idlj \- The IDL\-to\-Java Compiler -.LP -\f3idlj\fP generates Java bindings from a given IDL file. -.SH "Synopsis" -.LP -.nf -\f3 -.fl -idlj [ \fP\f3options\fP\f3 ] \fP\f4idl\-file\fP\f3 -.fl -\fP -.fi +.SH NAME +idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -where \f2idl\-file\fP is the name of a file containing Interface Definition Language (IDL) definitions. \f2Options\fP may appear in any order, but must precede the \f2idl\-file\fP. -.LP -.SH "Description" -.LP -.LP -The IDL\-to\-Java Compiler generates the Java bindings for a given IDL file.\ For binding details, see the -.na -\f2OMG IDL to Java Language Language Mapping Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP. -.LP -.SS -Emitting Client and Server Bindings -.LP -.LP -To generate Java bindings for an IDL file named My.idl: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -This generates the client\-side bindings and is equivalent to: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient\fP My.idl -.fl -.fi - -.LP -.LP -The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fserver\fP My.idl -.fl -.fi - -.LP -.LP -Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient \-fserver\fP My.idl -.fl -idlj \f3\-fall\fP My.idl -.fl -.fi - -.LP -.LP -There are two possible server\-side models: the Inheritance Model and the Tie Delegation Model. -.LP -.LP -The default server\-side model is the \f2Portable Servant Inheritance Model\fP. Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2MyPOA.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2MyPOA\fP. -.LP -.LP -\f2MyPOA.java\fP is a stream\-based skeleton that extends -.na -\f2org.omg.PortableServer.Servant\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements. -.LP -.LP -The \f2PortableServer\fP module for the -.na -\f2Portable Object Adapter (POA)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. -.LP -.LP -Another option for the Inheritance Model is to use the \f2\-oldImplBase\fP flag in order to generate server\-side bindings that are compatible with versions of the Java programming language prior to J2SE 1.4. Note that using the \f2\-oldImplBase\fP flag is non\-standard: these APIs are being deprecated. You would use this flag ONLY for compatibility with existing servers written in J2SE 1.3. In that case, you would need to modify an existing MAKEFILE to add the \f2\-oldImplBase\fP flag to the \f2idlj\fP compiler, otherwise POA\-based server\-side mappings will be generated. To generate server\-side bindings that are backwards compatible: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient \-fserver\fP \f3\-oldImplBase\fP My.idl -.fl -idlj \f3\-fall\fP \f3\-oldImplBase\fP My.idl -.fl -.fi - -.LP -.LP -Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP. -.LP -.LP -The other server\-side model is called the Tie Model. This is a delegation model. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately. The following commands generate the bindings for the Tie Model: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fall\fP My.idl -.fl -idlj \f3\-fallTIE\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance: -.LP -.nf -\f3 -.fl - ORB orb = ORB.init(args, System.getProperties()); -.fl - -.fl - // Get reference to rootpoa & activate the POAManager -.fl - POA rootpoa = (POA)orb.resolve_initial_references("RootPOA"); -.fl - rootpoa.the_POAManager().activate(); -.fl - -.fl - // create servant and register it with the ORB -.fl - MyServant myDelegate = new MyServant(); -.fl - myDelegate.setORB(orb); -.fl - -.fl - // create a tie, with servant being the delegate. -.fl - MyPOATie tie = new MyPOATie(myDelegate, rootpoa); -.fl - -.fl - // obtain the objectRef for the tie -.fl - My ref = tie._this(orb); -.fl -\fP -.fi - -.LP -.LP -You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method. -.LP -.LP -To generate server\-side, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions prior to J2SE 1.4. -.LP -.nf -\f3 -.fl -idlj \fP\f3\-oldImplBase\fP \f3\-fall\fP My.idl -.fl -idlj \f3\-oldImplBase\fP \f3\-fallTIE\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructor to \f2My_Tie\fP takes a \f2impl\fP. You must provide the implementation for \f2impl\fP, but it does not have to inherit from any other class, only the interface \f2HelloOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2My_Tie\fP. For instance: -.LP -.nf -\f3 -.fl - ORB orb = ORB.init(args, System.getProperties()); -.fl - -.fl - // create servant and register it with the ORB -.fl - MyServant myDelegate = new MyServant(); -.fl - myDelegate.setORB(orb); -.fl - -.fl - // create a tie, with servant being the delegate. -.fl - MyPOATie tie = new MyPOATie(myDelegate); -.fl - -.fl - // obtain the objectRef for the tie -.fl - My ref = tie._this(orb); -.fl -\fP -.fi - -.LP -.SS -Specifying Alternate Locations for Emitted Files -.LP -.LP -If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-td /altdir\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, the bindings will be emitted to \f2/altdir/My.java\fP, etc., instead of \f2./My.java\fP. -.LP -.SS -Specifying Alternate Locations for Include Files -.LP -.LP -If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-i /includes\fP My.idl -.fl -.fi - -.LP -.LP -If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-i /includes \-i /moreIncludes\fP My.idl -.fl -.fi - -.LP -.LP -Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form: -.LP -.nf -\f3 -.fl -includes=/includes;/moreIncludes -.fl -\fP -.fi - -.LP -.LP -The compiler will find this file and read in the includes list. Note that in this example the separator character between the two directories is a semicolon (;). This separator character is platform dependent. On the Windows platform, use a semicolon, on the Unix platform, use a colon, etc. For more information on \f2includes\fP, see the -.na -\f2Setting the Classpath\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general. -.LP -.SS -Emitting Bindings for Include Files -.LP -.LP -By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files: -.LP - -.LP -.LP -\f4My.idl\fP -.LP -.nf -\f3 -.fl -#include <MyOther.idl> -.fl -interface My -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4MyOther.idl\fP -.LP -.nf -\f3 -.fl -interface MyOther -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -The following command will only generate the java bindings for \f2My\fP: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-emitAll\fP My.idl -.fl -.fi - -.LP -.LP -There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example: -.LP - -.LP -.LP -\f4My.idl\fP -.LP -.nf -\f3 -.fl -#include <MyOther.idl> -.fl -interface My -.fl -{ -.fl - #include <Embedded.idl> -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4MyOther.idl\fP -.LP -.nf -\f3 -.fl -interface MyOther -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4Embedded.idl\fP -.LP -.nf -\f3 -.fl -enum E {one, two, three}; -.fl -\fP -.fi - -.LP - -.LP -.LP -Running the following command: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -will generate the following list of Java files: -.LP -.nf -\f3 -.fl -./MyHolder.java -.fl -./MyHelper.java -.fl -./_MyStub.java -.fl -./MyPackage -.fl -./MyPackage/EHolder.java -.fl -./MyPackage/EHelper.java -.fl -./MyPackage/E.java -.fl -./My.java -.fl -\fP -.fi - -.LP -.LP -Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP). -.LP -.LP -If the \f2\-emitAll\fP flag had been used in the previous example, then all types in all included files would be emitted. -.LP -.SS -Inserting Package Prefixes -.LP -.LP +\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. +.TP +\fIidlfile\fR +The name of a file that contains Interface Definition Language (IDL) definitions\&. +.SH DESCRIPTION +The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html +.PP +Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. +.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS +The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. +.sp +.nf +\f3idlj My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The previous syntax is equivalent to the following: +.sp +.nf +\f3idlj \-fclient My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. +.sp +.nf +\f3idlg \-fserver My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: +.sp +.nf +\f3idlj \-fclient \-fserver My\&.idl\fP +.fi +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. +.PP +\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: +.sp +.nf +\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP +.fi +.nf +\f3idlj \-fall \-oldImplBase My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. +.PP +\f3Tie Delegation Model\fR\&. The other server-side model is called the Tie Model\&. This is a delegation model\&. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately\&. The following commands generate the bindings for the Tie Model: +.sp +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// Get reference to rootpoa & activate the POAManager\fP +.fi +.nf +\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP +.fi +.nf +\f3rootpoa\&.the_POAManager()\&.activate();\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +You might want to use the Tie model instead of the typical Inheritance model when your implementation must inherit from some other implementation\&. Java allows any number of interface inheritance, but there is only one slot for class inheritance\&. If you use the inheritance model, then that slot is used up\&. With the Tie Model, that slot is freed up for your own use\&. The drawback is that it introduces a level of indirection: one extra method call occurs when a method is called\&. +.PP +For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. +.sp +.nf +\f3idlj \-oldImplBase \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES +If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. +.PP +For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES +If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Because this form of \f3include\fR can become long, another way to indicate to the compiler where to search for included files is provided\&. This technique is similar to the idea of an environment variable\&. Create a file named idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: +.sp +.nf +\f3includes=/includes;/moreIncludes\fP +.fi +.nf +\f3\fR +.fi +.sp +The compiler will find this file and read in the includes list\&. Note that in this example the separator character between the two directories is a semicolon (;)\&. This separator character is platform dependent\&. On the Windows platform, use a semicolon, on the Unix platform, use a colon, and so on\&. +.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES +By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR file on the command line have Java bindings generated for them\&. The types defined in included files are not generated\&. For example, assume the following two \f3idl\fR files: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 #include <Embedded\&.idl>\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3Embedded\&.idl\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3enum E {one, two, three};\fP +.fi +.nf +\f3\fR +.fi +.sp +Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. +.sp +.nf +\f3\&./MyHolder\&.java\fP +.fi +.nf +\f3\&./MyHelper\&.java\fP +.fi +.nf +\f3\&./_MyStub\&.java\fP +.fi +.nf +\f3\&./MyPackage\fP +.fi +.nf +\f3\&./MyPackage/EHolder\&.java\fP +.fi +.nf +\f3\&./MyPackage/EHelper\&.java\fP +.fi +.nf +\f3\&./MyPackage/E\&.java\fP +.fi +.nf +\f3\&./My\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS INSERT\ PACKAGE\ PREFIXES Suppose that you work for a company named ABC that has constructed the following IDL file: -.LP - -.LP -.LP -\f4Widgets.idl\fP -.LP -.nf -\f3 -.fl -module Widgets -.fl -{ -.fl - interface W1 {...}; -.fl - interface W2 {...}; -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.<company name>\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-pkgPrefix Widgets com.abc\fP Widgets.idl -.fl -.fi - -.LP -.LP -If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package. -.LP -.LP -If you have a number of these packages that require prefixes, it might be easier to place them into the \f2idl.config\fP file described above. Each package prefix line should be of the form: -.LP -.nf -\f3 -.fl -PkgPrefix.<type>=<prefix> -.fl -\fP -.fi - -.LP -So the line for the above example would be: -.nf -\f3 -.fl -PkgPrefix.Widgets=com.abc -.fl -\fP -.fi - -.LP -.LP -The use of this option does not affect the Repository ID. -.LP -.SS -Defining Symbols Before Compilation -.LP -.LP -You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command -.LP -.nf -\f3 -.fl -idlj \fP\f3\-d\fP MYDEF My.idl -.fl -.fi - -.LP -.LP -is the equivalent of putting the line \f2#define MYDEF\fP inside \f2My.idl\fP. -.LP -.SS -Preserving Pre\-Existing Bindings -.LP -.LP -If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command -.LP -.nf -\f3 -.fl -idlj \fP\f3\-keep\fP My.idl -.fl -.fi - -.LP -.LP -emits all client\-side bindings that do not already exist. -.LP -.SS -Viewing Progress of Compilation -.LP -.LP -The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-v\fP My.idl -.fl -.fi - -.LP -.LP -By default the compiler does not operate in verbose mode. -.LP -.SS -Displaying Version Information -.LP -.LP -To display the build version of the IDL\-to\-Java compiler, specify the \f2\-version\fP option on the command\-line: -.LP -.nf -\f3 -.fl -idlj \-version -.fl -\fP -.fi - -.LP -.LP -Version information also appears within the bindings generated by the compiler. Any additional options appearing on the command\-line are ignored. -.LP -.SH "Options" -.LP -.RS 3 -.TP 3 -\-d symbol -This is equivalent to the following line in an IDL file: -.nf -\f3 -.fl -#define \fP\f4symbol\fP\f3 -.fl -\fP -.fi -.TP 3 -\-emitAll -Emit all types, including those found in \f2#include\fP files. -.TP 3 -\-fside -Defines what bindings to emit. \f2side\fP is one of \f2client\fP, \f2server\fP, \f2serverTIE\fP, \f2all\fP, or \f2allTIE\fP. The \f2\-fserverTIE\fP and \f2\-fallTIE\fP options cause delegate model skeletons to be emitted. Assumes \f2\-fclient\fP if the flag is not specified. -.TP 3 -\-i include\-path -By default, the current directory is scanned for included files. This option adds another directory. -.TP 3 -\-keep -If a file to be generated already exists, do not overwrite it. By default it is overwritten. -.TP 3 -\-noWarn -Suppresses warning messages. -.TP 3 -\-oldImplBase -Generates skeletons compatible with pre\-1.4 JDK ORBs. By default, the POA Inheritance Model server\-side bindings are generated. This option provides backward\-compatibility with older versions of the Java programming language by generating server\-side bindings that are \f2ImplBase\fP Inheritance Model classes. -.TP 3 -\-pkgPrefix type prefix -Wherever \f2type\fP is encountered at file scope, prefix the generated Java package name with \f2prefix\fP for all files generated for that type. The \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module. -.TP 3 -\-pkgTranslate type package -Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly. +.sp +.nf +\f3Widgets\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3module Widgets\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 interface W1 {\&.\&.\&.};\fP +.fi +.nf +\f3 interface W2 {\&.\&.\&.};\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: +.sp +.nf +\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. +.PP +If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. +.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION +You might need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings\&. The command \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. +.SS PRESERVE\ PREEXISTING\ BINDINGS +If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. +.SS VIEW\ COMPILATION\ PROGRESS +The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. +.PP +By default the compiler does not operate in verbose mode +.SS DISPLAY\ VERSION\ INFORMATION +To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. +.PP +Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. +.SH OPTIONS +.TP +-d \fIsymbol\fR .br +This is equivalent to the following line in an IDL file: +.sp +.nf +\f3#define \fIsymbol\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-demitAll .br -If more than one translation matches an identifier, the longest match is chosen. For example, if the arguments include: -.nf -\f3 -.fl - \-pkgTranslate foo bar \-pkgTranslate foo.baz buzz.fizz -.fl -\fP -.fi -The following translations would occur: -.nf -\f3 -.fl -foo => bar -.fl -foo.boo => bar.boo -.fl -foo.baz => buzz.fizz -.fl -foo.baz.bar => buzz.fizz.bar -.fl -\fP -.fi -The following package names cannot be translated: -.RS 3 -.TP 2 -o -\f2org\fP -.TP 2 -o -\f2org.omg\fP or any subpackages of \f2org.omg\fP -.RE -Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error. -.TP 3 -\-skeletonName xxx%yyy -Use \f2xxx%yyy\fP as the pattern for naming the skeleton. The defaults are: -.RS 3 -.TP 2 -o -%POA for the \f2POA\fP base class (\f2\-fserver\fP or \f2\-fall\fP) -.TP 2 -o -_%ImplBase for the \f2oldImplBase\fP class (\f2\-oldImplBase\fP and (\f2\-fserver\fP or \f2\-fall\fP)) -.RE -.TP 3 -\-td dir -Use \f2dir\fP for the output directory instead of the current directory. -.TP 3 -\-tieName xxx%yyy -Name the tie according to the pattern. The defaults are: -.RS 3 -.TP 2 -o -%POATie for the \f2POA\fP tie base class (\f2\-fserverTie\fP or \f2\-fallTie\fP) -.TP 2 -o -%_Tie for the \f2oldImplBase\fP tie class (\f2\-oldImplBase\fP and (\f2\-fserverTie\fP or \f2\-fallTie\fP)) -.RE -.TP 3 -\-nowarn, \-verbose -Verbose mode. -.TP 3 -\-version -Display version information and terminate. -.RE +Emit all types, including those found in \f3#include\fR files\&. +.TP +-fside +.br +Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. +.TP +-i \fIinclude-path\fR +.br +By default, the current directory is scanned for included files\&. This option adds another directory\&. +.TP +-i \fIkeep\fR +.br +If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. +.TP +-noWarn +.br +Suppress warning messages\&. +.TP +-oldImplBase +.br +Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. +.TP +-pkgPrefix \fItype\fR\fIprefix\fR +.br +Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. +.TP +-pkgTranslate \fItype\fR\fIpackage\fR +.br +Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value is the simple name of either a top-level module, or an IDL type defined outside of any module and must match the full package name exactly\&. -.LP -.LP -See the Description section for more option information. -.LP -.SH "Restrictions:" -.LP -.RS 3 -.TP 2 -o -Escaped identifiers in the global scope may not have the same spelling as IDL primitive types, \f2Object\fP, or \f2ValueBase\fP. This is because the symbol table is pre\-loaded with these identifiers; allowing them to be redefined would overwrite their original definitions. (Possible permanent restriction). -.TP 2 -o -The \f2fixed\fP IDL type is not supported. -.RE +If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: -.LP -.SH "Known Problems:" -.LP -.RS 3 -.TP 2 -o -No import generated for global identifiers. If you invoke on an unexported local impl, you do get an exception, but it seems to be due to a \f2NullPointerException\fP in the \f2ServerDelegate\fP DSI code. -.RE +\fICommand\fR: +.sp +.nf +\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP - + +\fIResulting Translation\fR: +.sp +.nf +\f3type => pkg\fP +.fi +.nf +\f3type\&.ext => pkg\&.ext\fP +.fi +.nf +\f3type\&.baz => pkg2\&.fizz\fP +.fi +.nf +\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. +.TP +-skeletonName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. +.TP +-td \fIdir\fR +.br +Use \fIdir\fR for the output directory instead of the current directory\&. +.TP +-tieName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) +.TP +-nowarn, -verbose +.br +Displays release information and terminates\&. +.TP +-version +.br +Displays release information and terminates\&. +.SH RESTRICTIONS +Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. +.PP +The \f3fixed\fR IDL type is not supported\&. +.SH KNOWN\ PROBLEMS +No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jar.1 b/jdk/src/linux/doc/man/jar.1 index cd59f0aa1d3..e559e47a160 100644 --- a/jdk/src/linux/doc/man/jar.1 +++ b/jdk/src/linux/doc/man/jar.1 @@ -1,579 +1,485 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jar 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jar.1 +.\" +.if n .pl 99999 +.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jar\-The Java Archive Tool -.LP -\f3jar\fP combines multiple files into a single JAR archive file. -.SH "SYNOPSIS" -.LP -.RS 3 -.TP 3 -Create jar file -\f4jar c\fP\f2[v0Mmfe] [\fP\f2manifest\fP\f2] [\fP\f2jarfile\fP\f2] [\fP\f2entrypoint\fP\f2] [\-C\fP \f2dir\fP\f2]\fP \f2inputfiles\fP \f2[\-J\fP\f2option\fP\f2]\fP -.TP 3 -Update jar file -\f4jar u\fP\f2[v0Mmfe] [\fP\f2manifest\fP\f2] [\fP\f2jarfile\fP\f2] [\fP\f2entrypoint\fP\f2] [\-C\fP \f2dir\fP\f2]\fP \f2inputfiles\fP \f2[\-J\fP\f2option\fP\f2]\fP -.TP 3 -Extract jar file -\f4jar x\fP\f2[vf] [\fP\f2jarfile\fP\f2] [\fP\f2inputfiles\fP\f2] [\-J\fP\f2option\fP\f2]\fP -.TP 3 -List table of contents of jar file -\f4jar t\fP\f2[vf] [\fP\f2jarfile\fP\f2] [\fP\f2inputfiles\fP\f2] [\-J\fP\f2option\fP\f2]\fP -.TP 3 -Add index to jar file -\f4jar i\fP \f2jarfile\fP \f2[\-J\fP\f2option\fP\f2]\fP -.RE +.SH NAME +jar \- Manipulates Java Archive (JAR) files\&. +.SH SYNOPSIS +Create JAR file +.sp +.nf -.LP -.LP -where: -.LP -.RS 3 -.TP 3 -cuxtiv0Mmfe -Options that control the \f2jar\fP command. -.TP 3 -jarfile -Jar file to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), or have its table of contents viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if either is present, they must both appear. Note that omitting \f2f\fP and \f2jarfile\fP accepts a "jar file" from standard input (for x and t) or sends the "jar file" to standard output (for c and u). -.TP 3 -inputfiles -Files or directories, separated by spaces, to be combined into \f2jarfile\fP (for c and u), or to be extracted (for x) or listed (for t) from \f2jarfile\fP. All directories are processed recursively. The files are compressed unless option \f20\fP (zero) is used. -.TP 3 -manifest -Pre\-existing manifest file whose \f2name\fP\f2:\fP \f2value\fP pairs are to be included in MANIFEST.MF in the jar file. The \f2\-m\fP option and filename \f2manifest\fP are a pair \-\- if either is present, they must both appear. The letters \f3m\fP, \f3f\fP and \f3e\fP must appear in the same order that \f2manifest\fP, \f2jarfile\fP, \f2entrypoint\fP appear. -.TP 3 -entrypoint -The name of the class that set as the application entry point for stand\-alone applications bundled into executable jar file. The \f2\-e\fP option and entrypoint are a pair \-\- if either is present, they must both appear. The letters \f3m\fP, \f3f\fP and \f3e\fP must appear in the same order that \f2manifest\fP, \f2jarfile\fP, \f2entrypoint\fP appear. -.TP 3 -\-C\ dir -Temporarily changes directories to \f2dir\fP while processing the following \f2inputfiles\fP argument. Multiple \f2\-C\ \fP\f2dir\fP \f2inputfiles\fP sets are allowed. -.TP 3 -\-Joption -Option to be passed into the Java runtime environment. (There must be no space between \f2\-J\fP and \f2option\fP). -.RE +\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -The \f3jar\fP tool combines multiple files into a single JAR archive file. \f3jar\fP is a general\-purpose archiving and compression tool, based on ZIP and the -.na -\f2ZLIB\fP @ -.fi -http://www.gzip.org/zlib/ compression format. However, \f3jar\fP was designed mainly package java applets or applications into a single archive. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a java agent (like a browser) in a single HTTP transaction, rather than requiring a new connection for each piece. This dramatically improves download times. \f3jar\fP also compresses files and so further improves download time. In addition, it allows individual entries in a file to be signed by the applet author so that their origin can be authenticated. The syntax for the jar tool is almost identical to the syntax for the \f2tar\fP command. A \f3jar\fP archive can be used as a class path entry, whether or not it is compressed. -.LP -Typical usage to combine files into a jar file is: -.LP -.nf -\f3 -.fl -% jar cf myFile.jar *.class -.fl -\fP -.fi +Update JAR file +.sp +.nf -.LP -In this example, all the class files in the current directory are placed into the file named \f2myFile.jar\fP. The jar tool automatically generates a manifest file entry named \f2META\-INF/MANIFEST.MF\fP. It is always the first entry in the jar file. The manifest file declares meta\-information about the archive, and stores that data as \f2name\ :\ value\fP pairs. Refer to the -.na -\f2JAR file specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR%20Manifest for details explaining how the jar tool stores meta\-information in the manifest file. -.LP -If a jar file should include \f2name\ :\ value\fP pairs contained in an existing manifest file, specify that file using the \f2\-m\fP option: -.LP -.nf -\f3 -.fl -% jar cmf myManifestFile myFile.jar *.class -.fl -\fP -.fi +\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -An existing manifest file must end with a new line character.\ \f3jar\fP does not parse the last line of a manifest file if it does not end with a new line character. +Extract JAR file +.sp +.nf + +\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +List Contents of JAR file +.sp +.nf + +\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Add Index to JAR file +.sp +.nf + +\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp +.SH DESCRIPTION +The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to package Java applets or applications into a single archive\&. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a Java agent (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. +.PP +The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. +.SH OPERATION\ ARGUMENTS +When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. +.TP +c +Create a new JAR archive\&. +.TP +i +Generate index information for a JAR archive\&. +.TP +t +List the contents of a JAR archive\&. +.TP +u +Update a JAR archive\&. +.TP +x +Extract files from a JAR archive\&. +.SH OPTIONS +Use the following options to customize how the JAR file is created, updated, extracted, or viewed: +.TP +e +Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: +.sp +.nf +\f3jar cfe Main\&.jar Main Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The Java Runtime Environment (JRE) can directly call this application by running the following command: +.sp +.nf +\f3java \-jar Main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: +.sp +.nf +\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP +.fi +.nf +\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Note + +Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. +.TP +f +Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. +.TP +m +Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.TP +M +Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. +.TP +n +When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. +.TP +v +Generates verbose output to standard output\&. See Examples\&. +.TP +0 +(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. +.TP +-C \fIdir\fR .br +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: +.sp +.nf +\f3jar uf my\&.jar \-C classes Bar\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.br -.LP -\f3Note:\ \fP A jar command that specifies \f2cfm\fP on the command line instead of \f2cmf\fP (the order of the m and \-f options are reversed), the \f3jar\fP command line must specify the name of the jar archive first, followed by the name of the manifest file: -.nf -\f3 -.fl -% jar cfm myFile.jar myManifestFile *.class -.fl -\fP -.fi +The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. +.sp +.nf +\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -The manifest is in a text format inspired by RFC822 ASCII format, so it is easy to view and process manifest\-file contents. -.LP -To extract the files from a jar file, use \f2x\fP: -.LP -.nf -\f3 -.fl -% jar xf myFile.jar -.fl -\fP -.fi -.LP -.LP -To extract individual files from a jar file, supply their filenames: -.LP -.nf -\f3 -.fl -% jar xf myFile.jar foo bar -.fl -\fP -.fi +If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: +.sp +.nf +\f3% \fIjar tf my\&.jar\fR\fP +.fi +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3bar1\fP +.fi +.nf +\f3bar2\fP +.fi +.nf +\f3Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -Beginning with version 1.3 of the JDK, the \f2jar\fP utility supports -.na -\f2JarIndex\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index, which allows application class loaders to load classes more efficiently from jar files. If an application or applet is bundled into multiple jar files,\ only the necessary jar files will be downloaded and opened to load classes. This performance optimization is enabled by running \f2jar\fP with the \f2\-i\fPoption. It will generate package location information for the specified main jar file and all the jar files it depends on, which need to be specified in the \f2Class\-Path\fP attribute of the main jar file's manifest. -.LP -.nf -\f3 -.fl -% jar i main.jar -.fl -\fP -.fi +.TP +\fI\fR-J\fIoption\fR +Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH OPERANDS +The following operands are recognized by the \f3jar\fR command\&. +.TP +\fIfile\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. +.TP +\fIentrypoint\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. +.TP +\fIjarfile\fR +Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. -.LP -.LP -In this example, an \f2INDEX.LIST\fP file is inserted into the \f2META\-INF\fP directory of \f2main.jar\fP. -.br -.br -The application class loader uses the information stored in this file for efficient class loading.\ For details about how location information is stored in the index file, refer to the \f2JarIndex\fP specification. -.br -.br -To copy directories, first compress files in \f2dir1\fP to \f2stdout\fP, then extract from \f2stdin\fP to \f2dir2\fP (omitting the \f2\-f\fP option from both \f2jar\fP commands): -.LP -.nf -\f3 -.fl -% (cd dir1; jar c .) | (cd dir2; jar x) -.fl -\fP -.fi +When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. +.TP +\fImanifest\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. +.TP +\fI@arg-file\fR +To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. -.LP -.LP -To review command samples which use \f2jar\fP to opeate on jar files and jar file manifests, see Examples, below. Also refer to the jar trail of the -.na -\f2Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -c -Creates a new archive file named \f2jarfile\fP (if \f2f\fP is specified) or to standard output (if \f2f\fP and \f2jarfile\fP are omitted). Add to it the files and directories specified by \f2inputfiles\fP. -.TP 3 -u -Updates an existing file \f2jarfile\fP (when \f2f\fP is specified) by adding to it files and directories specified by \f2inputfiles\fP. For example: -.nf -\f3 -.fl -jar uf foo.jar foo.class -.fl -\fP -.fi -would add the file \f2foo.class\fP to the existing jar file \f2foo.jar\fP. The \f2\-u\fP option can also update the manifest entry, as given by this example: -.nf -\f3 -.fl -jar umf manifest foo.jar -.fl -\fP -.fi -updates the \f2foo.jar\fP manifest with the \f2name : value\fP pairs in \f2manifest\fP. -.TP 3 -x -Extracts files and directories from \f2jarfile\fP (if \f2f\fP is specified) or standard input (if \f2f\fP and \f2jarfile\fP are omitted). If \f2inputfiles\fP is specified, only those specified files and directories are extracted. Otherwise, all files and directories are extracted. The time and date of the extracted files are those given in the archive. -.TP 3 -t -Lists the table of contents from \f2jarfile\fP (if \f2f\fP is specified) or standard input (if \f2f\fP and \f2jarfile\fP are omitted). If \f2inputfiles\fP is specified, only those specified files and directories are listed. Otherwise, all files and directories are listed. -.TP 3 -i -Generate index information for the specified \f2jarfile\fP and its dependent jar files. For example: -.nf -\f3 -.fl -jar i foo.jar -.fl -\fP -.fi -.LP -would generate an \f2INDEX.LIST\fP file in \f2foo.jar\fP which contains location information for each package in \f2foo.jar\fP and all the jar files specified in the \f2Class\-Path\fP attribute of \f2foo.jar\fP. See the index example. -.TP 3 -f -Specifies the file \f2jarfile\fP to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), indexed (\f2i\fP), or viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if present, they must both appear. Omitting \f2f\fP and \f2jarfile\fP accepts a jar file name from \f2stdin\fP(for x and t) or sends jar file to \f2stdout\fP (for c and u). -.TP 3 -v -Generates verbose output to standard output. Examples shown below. -.TP 3 -0 -(zero) Store without using ZIP compression. -.TP 3 -M -Do not create a manifest file entry (for c and u), or delete a manifest file entry if one exists (for u). -.TP 3 -m -Includes \f2name : value\fP attribute pairs from the specified manifest file \f2manifest\fP in the file at \f2META\-INF/MANIFEST.MF\fP. \f2jar\fP adds a \f2name\ :\ value\fP pair unless an entry already exists with the same name, in which case \f2jar\fP updates its value. -.br -.br -On the command line, the letters \f3m\fP and \f3f\fP must appear in the same order that \f2manifest\fP and \f2jarfile\fP appear. Example use: -.nf -\f3 -.fl -jar cmf myManifestFile myFile.jar *.class -.fl -\fP -.fi -You can add special\-purpose \f2name\ :\ value\fP attribute pairs to the manifest that aren't contained in the default manifest. For example, you can add attributes specifying vendor information, version information, package sealing, or to make JAR\-bundled applications executable. See the -.na -\f2JAR Files\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar/ trail in the Java Tutorial for examples of using the \f4\-m\fP option. -.TP 3 -e -Sets \f2entrypoint\fP as the application entry point for stand\-alone applications bundled into executable jar file. The use of this option creates or overrides the \f2Main\-Class\fP attribute value in the manifest file. This option can be used during creation of jar file or while updating the jar file. This option specifies the application entry point without editing or creating the manifest file. -.br -.br -.br -For example, this command creates \f2Main.jar\fP where the \f2Main\-Class\fP attribute value in the manifest is set to \f2Main\fP: -.nf -\f3 -.fl -jar cfe Main.jar Main Main.class -.fl -\fP -.fi -The java runtime can directly invoke this application by running the following command: -.nf -\f3 -.fl -java \-jar Main.jar -.fl -\fP -.fi -If the entrypoint class name is in a package it may use either a dot (".") or slash ("/") character as the delimiter. For example, if \f2Main.class\fP is in a package called \f2foo\fP the entry point can be specified in the following ways: -.nf -\f3 -.fl -jar \-cfe Main.jar foo/Main foo/Main.class -.fl -\fP -.fi -or -.nf -\f3 -.fl -jar \-cfe Main.jar foo.Main foo/Main.class -.fl -\fP -.fi -\f3Note:\ \fP specifying both \f2\-m\fP and \f2\-e\fP options together when the given manifest also contains the \f2Main\-Class\fP attribute results in an ambigous \f2Main.class\fP specification, leading to an error and the jar creation or update operation is aborted. -.TP 3 -\-C\ dir -Temporarily changes directories (\f2cd\fP\ \f2dir\fP) during execution of the \f2jar\fP command while processing the following \f2inputfiles\fP argument. Its operation is intended to be similar to the \f2\-C\fP option of the UNIX \f2tar\fP utility. -.br -.br -For example, this command changes to the \f2classes\fP directory and adds the \f2bar.class\fP from that directory to \f2foo.jar\fP: -.nf -\f3 -.fl -jar uf foo.jar \-C classes bar.class -.fl -\fP -.fi -This command changes to the \f2classes\fP directory and adds to \f2foo.jar\fP all files within the \f2classes\fP directory (without creating a classes directory in the jar file), then changes back to the original directory before changing to the \f2bin\fP directory to add \f2xyz.class\fP to \f2foo.jar\fP. -.nf -\f3 -.fl -jar uf foo.jar \-C classes . \-C bin xyz.class -.fl -\fP -.fi -If \f2classes\fP holds files \f2bar1\fP and \f2bar2\fP, then here's what the jar file will contain using \f2jar tf foo.jar\fP: -.nf -\f3 -.fl -META\-INF/ -.fl -META\-INF/MANIFEST.MF -.fl -bar1 -.fl -bar2 -.fl -xyz.class -.fl -\fP -.fi -.LP -.TP 3 -\-Joption -Pass \f2option\fP to the Java runtime environment, where \f2option\fP is one of the options described on the reference page for the java application launcher. For example, \f4\-J\-Xmx48M\fP sets the maximum memory to 48 megabytes. It is a common convention for \f2\-J\fP to pass options to the underlying runtime environment. -.RE +An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. -.LP -.SH "COMMAND LINE ARGUMENT FILES" -.LP -To shorten or simplify the jar command line, you can specify one or more files that themselves contain arguments to the \f2jar\fP command (except \f2\-J\fP options). This enables you to create jar commands of any length, overcoming command line limits imposed by the operating system. -.LP -An argument file can include options and filenames. The arguments within a file can be space\-separated or newline\-separated. Filenames within an argument file are relative to the current directory, not relative to the location of the argument file. Wildcards (*) that might otherwise be expanded by the operating system shell are not expanded. Use of the \f2@\fP character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -.LP -When executing \f2jar\fP, pass in the path and name of each argument file with the \f2@\fP leading character. When \f2jar\fP encounters an argument beginning with the character \f2@\fP, it expands the contents of that file into the argument list. -.br -.br -The example below, \f2classes.list\fP holds the names of files output by a \f2find\fP command: -.LP -.nf -\f3 -.fl -% find \fP\f3.\fP \-name '*.class' \-print > classes.list -.fl -.fi +The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: +.sp +.nf +\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -You can then execute the \f2jar\fP command on \f2Classes.list\fP by passing it to \f2jar\fP using argfile syntax: -.LP -.nf -\f3 -.fl -% jar cf my.jar @classes.list -.fl -\fP -.fi -.LP -An argument file can specify a path, but any filenames inside the argument file that have relative paths are relative to the current working directory, not to the path passed in. Here is an example: -.nf -\f3 -.fl -% jar @path1/classes.list -.fl -\fP -.fi +You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: +.sp +.nf +\f3jar cf my\&.jar @classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -.LP -.SH "EXAMPLES" -.LP -To add all the files in a particular directory to an archive (overwriting contents if the archive already exists). Enumerating verbosely (with the \f2\-v\fP option) will tell you more information about the files in the archive, such as their size and last modified date. -.nf -\f3 -.fl -% ls -.fl -1.au Animator.class monkey.jpg -.fl -2.au Wave.class spacemusic.au -.fl -3.au at_work.gif -.fl +An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: +.sp +.nf +\f3jar @dir/classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -% jar cvf bundle.jar * -.fl -added manifest -.fl -adding: 1.au(in = 2324) (out= 67)(deflated 97%) -.fl -adding: 2.au(in = 6970) (out= 90)(deflated 98%) -.fl -adding: 3.au(in = 11616) (out= 108)(deflated 99%) -.fl -adding: Animator.class(in = 2266) (out= 66)(deflated 97%) -.fl -adding: Wave.class(in = 3778) (out= 81)(deflated 97%) -.fl -adding: at_work.gif(in = 6621) (out= 89)(deflated 98%) -.fl -adding: monkey.jpg(in = 7667) (out= 91)(deflated 98%) -.fl -adding: spacemusic.au(in = 3079) (out= 73)(deflated 97%) -.fl -\fP -.fi - -.LP -If you already have separate subdirectories for images, audio files and classes, you can combine them into a single jar file: -.nf -\f3 -.fl -% ls \-F -.fl -audio/ classes/ images/ -.fl - -.fl -% jar cvf bundle.jar audio classes images -.fl -added manifest -.fl -adding: audio/(in = 0) (out= 0)(stored 0%) -.fl -adding: audio/1.au(in = 2324) (out= 67)(deflated 97%) -.fl -adding: audio/2.au(in = 6970) (out= 90)(deflated 98%) -.fl -adding: audio/3.au(in = 11616) (out= 108)(deflated 99%) -.fl -adding: audio/spacemusic.au(in = 3079) (out= 73)(deflated 97%) -.fl -adding: classes/(in = 0) (out= 0)(stored 0%) -.fl -adding: classes/Animator.class(in = 2266) (out= 66)(deflated 97%) -.fl -adding: classes/Wave.class(in = 3778) (out= 81)(deflated 97%) -.fl -adding: images/(in = 0) (out= 0)(stored 0%) -.fl -adding: images/monkey.jpg(in = 7667) (out= 91)(deflated 98%) -.fl -adding: images/at_work.gif(in = 6621) (out= 89)(deflated 98%) -.fl - -.fl -% ls \-F -.fl -audio/ bundle.jar classes/ images/ -.fl -\fP -.fi - -.LP -To see the entry names in the jarfile, use the \f2t\fP option: -.nf -\f3 -.fl -% jar tf bundle.jar -.fl -META\-INF/ -.fl -META\-INF/MANIFEST.MF -.fl -audio/1.au -.fl -audio/2.au -.fl -audio/3.au -.fl -audio/spacemusic.au -.fl -classes/Animator.class -.fl -classes/Wave.class -.fl -images/monkey.jpg -.fl -images/at_work.gif -.fl -\fP -.fi - -.LP -.LP -To add an index file to the jar file for speeding up class loading, use the \f2i\fP option. -.br -.br -Example: -.br - -.LP -If you split the inter\-dependent classes for a stock trade application into three jar files: \f2main.jar\fP, \f2buy.jar\fP, and \f2sell.jar\fP. -.br - -.LP -.br - -.LP -If you specify the \f2Class\-path\fP attribute in the \f2main.jar\fP manifest as: -.nf -\f3 -.fl -Class\-Path: buy.jar sell.jar -.fl -\fP -.fi - -.LP -then you can use the \f2\-i\fP option to speed up the class loading time for your application: -.nf -\f3 -.fl -% jar i main.jar -.fl -\fP -.fi - -.LP -An \f2INDEX.LIST\fP file is inserted to the \f2META\-INF\fP directory. This enables the application class loader to download the specified jar files when it is searching for classes or resources. -.SH "SEE ALSO" -.LP -.LP -.na -\f2The Jar Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jarGuide.html -.LP -.LP -.na -\f2The Jar File Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html -.LP -.LP -.na -\f2The JarIndex Spec\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index -.LP -.LP -.na -\f2Jar Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar/index.html -.LP -.LP -pack200(1) -.LP - +.SH NOTES +The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: +.sp +.nf +\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXAMPLES +\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR +.sp +.nf +\f3% ls\fP +.fi +.nf +\f31\&.au Animator\&.class monkey\&.jpg\fP +.fi +.nf +\f32\&.au Wave\&.class spacemusic\&.au\fP +.fi +.nf +\f33\&.au at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% jar cvf bundle\&.jar *\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Adding Files From Subdirectories\fR +.sp +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ classes/ images/\fP +.fi +.nf +\f3% jar cvf bundle\&.jar audio classes images\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ bundle\&.jar classes/ images/\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Listing the Contents of JAR\fR +.sp +.nf +\f3% jar tf bundle\&.jar\fP +.fi +.sp +.sp +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3audio/1\&.au\fP +.fi +.nf +\f3audio/2\&.au\fP +.fi +.nf +\f3audio/3\&.au\fP +.fi +.nf +\f3audio/spacemusic\&.au\fP +.fi +.nf +\f3classes/Animator\&.class\fP +.fi +.nf +\f3classes/Wave\&.class\fP +.fi +.nf +\f3images/monkey\&.jpg\fP +.fi +.nf +\f3images/at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Adding an Index\fR +.PP +Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: +.sp +.nf +\f3Class\-Path: buy\&.jar sell\&.jar\fP +.fi +.nf +\f3jar i main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. +.PP +The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): +.sp +.nf +\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1)\&. +.TP 0.2i +\(bu +The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jarsigner.1 b/jdk/src/linux/doc/man/jarsigner.1 index d646eae2cde..9394a1079a9 100644 --- a/jdk/src/linux/doc/man/jarsigner.1 +++ b/jdk/src/linux/doc/man/jarsigner.1 @@ -1,1567 +1,985 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jarsigner 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: jarsigner.1 +.\" +.if n .pl 99999 +.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jarsigner \- JAR Signing and Verification Tool -.LP -.LP -Generates signatures for Java ARchive (JAR) files, and verifies the signatures of signed JAR files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jarsigner\fP [ options ] jar\-file alias -.fl -\f3jarsigner\fP \-verify [ options ] jar\-file [alias...] -.fl -.fi +.SH NAME +jarsigner \- Signs and verifies Java Archive (JAR) files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -The jarsigner \-verify command can take zero or more keystore alias names after the jar filename. When specified, jarsigner will check that the certificate used to verify each signed entry in the jar file matches one of the keystore aliases. The aliases are defined in the keystore specified by \-keystore, or the default keystore. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jarsigner\fP tool is used for two purposes: -.LP -.RS 3 -.TP 3 -1. -to sign Java ARchive (JAR) files, and -.TP 3 -2. -to verify the signatures and integrity of signed JAR files. -.RE +\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR +.fi +.nf -.LP -.LP -The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution. A tool named jar(1) enables developers to produce JAR files. (Technically, any zip file can also be considered a JAR file, although when created by \f3jar\fP or processed by \f3jarsigner\fP, JAR files also contain a META\-INF/MANIFEST.MF file.) -.LP -.LP -A \f2digital signature\fP is a string of bits that is computed from some data (the data being "signed") and the private key of an entity (a person, company, etc.). Like a handwritten signature, a digital signature has many useful characteristics: -.LP -.RS 3 -.TP 2 -o -Its authenticity can be verified, via a computation that uses the public key corresponding to the private key used to generate the signature. -.TP 2 -o -It cannot be forged, assuming the private key is kept secret. -.TP 2 -o -It is a function of the data signed and thus can't be claimed to be the signature for other data as well. -.TP 2 -o -The signed data cannot be changed; if it is, the signature will no longer verify as being authentic. -.RE +\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +-verify +.br +The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks that the certificate used to verify each signed entry in the JAR file matches one of the keystore aliases\&. The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. -.LP -.LP -In order for an entity's signature to be generated for a file, the entity must first have a public/private key pair associated with it, and also one or more certificates authenticating its public key. A \f2certificate\fP is a digitally signed statement from one entity, saying that the public key of some other entity has a particular value. -.LP -.LP -\f3jarsigner\fP uses key and certificate information from a \f2keystore\fP to generate digital signatures for JAR files. A keystore is a database of private keys and their associated X.509 certificate chains authenticating the corresponding public keys. The keytool(1) utility is used to create and administer keystores. -.LP -.LP -\f3jarsigner\fP uses an entity's private key to generate a signature. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file. \f3jarsigner\fP can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file). -.LP -.LP -\f3jarsigner\fP can generate signatures that include a timestamp, thus enabling systems/deployer (including Java Plug\-in) to check whether the JAR file was signed while the signing certificate was still valid. In addition, APIs will allow applications to obtain the timestamp information. -.LP -.LP -At this time, \f3jarsigner\fP can only sign JAR files created by the SDK jar(1) tool or zip files. (JAR files are the same as zip files, except they also have a META\-INF/MANIFEST.MF file. Such a file will automatically be created when \f3jarsigner\fP signs a zip file.) -.LP -.LP -The default \f3jarsigner\fP behavior is to \f2sign\fP a JAR (or zip) file. Use the \f2\-verify\fP option to instead have it \f2verify\fP a signed JAR file. -.LP -.SS -Keystore Aliases -.LP -.LP -All keystore entities are accessed via unique \f2aliases\fP. -.LP -.LP -When using \f3jarsigner\fP to sign a JAR file, you must specify the alias for the keystore entry containing the private key needed to generate the signature. For example, the following will sign the JAR file named "MyJARFile.jar", using the private key associated with the alias "duke" in the keystore named "mystore" in the "working" directory. Since no output file is specified, it overwrites MyJARFile.jar with the signed JAR file. -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3 -.fl - \-keypass \fP\f4<private key password>\fP\f3 MyJARFile.jar duke -.fl -\fP -.fi +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. +.TP +\fIjar-file\fR +The JAR file to be signed\&. -.LP -.LP -Keystores are protected with a password, so the store password must be specified. You will be prompted for it if you don't specify it on the command line. Similarly, private keys are protected in a keystore with a password, so the private key's password must be specified, and you will be prompted for it if you don't specify it on the command line and it isn't the same as the store password. -.LP -.SS -Keystore Location -.LP -.LP -\f3jarsigner\fP has a \f2\-keystore\fP option for specifying the URL of the keystore to be used. The keystore is by default stored in a file named \f2.keystore\fP in the user's home directory, as determined by the \f2user.home\fP system property. On Solaris systems \f2user.home\fP defaults to the user's home directory. -.LP -.LP -Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based, for example, if it resides on a hardware token device. -.LP -.SS -Keystore Implementation -.LP -.LP -The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore. -.LP -.LP -Currently, there are two command\-line tools that make use of keystore implementations (\f3keytool\fP and \f3jarsigner\fP), and also a GUI\-based tool named \f3Policy Tool\fP. Since \f2KeyStore\fP is publicly available, Java 2 SDK users can write additional security applications that use it. -.LP -.LP -There is a built\-in default implementation, provided by Sun Microsystems. It implements the keystore as a file, utilizing a proprietary keystore type (format) named "JKS". It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password. -.LP -.LP -Keystore implementations are provider\-based. More specifically, the application interfaces supplied by \f2KeyStore\fP are implemented in terms of a "Service Provider Interface" (SPI). That is, there is a corresponding abstract \f2KeystoreSpi\fP class, also in the \f2java.security\fP package, which defines the Service Provider Interface methods that "providers" must implement. (The term "provider" refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API.) Thus, to provide a keystore implementation, clients must implement a provider and supply a KeystoreSpi subclass implementation, as described in -.na -\f2How to Implement a Provider for the Java Cryptography Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html. -.LP -.LP -Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible. -.LP -.LP -\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL. -.LP -.LP -For \f3jarsigner\fP and \f3keytool\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Change Keystore" command in the Edit menu. -.LP -.LP -If you don't explicitly specify a keystore type, the tools choose a keystore implementation based simply on the value of the \f2keystore.type\fP property specified in the security properties file. The security properties file is called \f2java.security\fP, and it resides in the SDK security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -.LP -Each tool gets the \f2keystore.type\fP value and then examines all the currently\-installed providers until it finds one that implements keystores of that type. It then uses the keystore implementation from that provider. -.LP -.LP -The \f2KeyStore\fP class defines a static method named \f2getDefaultType\fP that lets applications and applets retrieve the value of the \f2keystore.type\fP property. The following line of code creates an instance of the default keystore type (as specified in the \f2keystore.type\fP property): -.LP -.nf -\f3 -.fl - KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); -.fl -\fP -.fi +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. +.TP +\fIalias\fR +The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. +.SH DESCRIPTION +The \f3jarsigner\fR tool has two purposes: +.TP 0.2i +\(bu +To sign Java Archive (JAR) files\&. +.TP 0.2i +\(bu +To verify the signatures and integrity of signed JAR files\&. +.PP +The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) +.PP +A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: +.TP 0.2i +\(bu +Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. +.TP 0.2i +\(bu +It cannot be forged, assuming the private key is kept secret\&. +.TP 0.2i +\(bu +It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. +.TP 0.2i +\(bu +The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. +.PP +To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. +.PP +The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. +.PP +The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. +.PP +The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. +.PP +At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. +.PP +The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. +.PP +The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. +.SS KEYSTORE\ ALIASES +All keystore entities are accessed with unique aliases\&. +.PP +When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP +.fi +.nf +\f3\fR +.fi +.sp +Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not specify it on the command line\&. Similarly, private keys are protected in a keystore with a password, so the private key\&'s password must be specified, and you are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. +.SS KEYSTORE\ LOCATION +The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. +.PP +On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. +.PP +The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. +.SS KEYSTORE\ IMPLEMENTATION +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. +.PP +Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. +.PP +There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. +.PP +Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html +.PP +Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself\&. Keystore implementations of different types are not compatible\&. +.PP +The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. +.PP +For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. +.PP +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. +.PP +Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. +.PP +The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fR +.fi +.sp +The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fR +.fi +.sp +Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. +.PP +To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html +.SS SUPPORTED\ ALGORITHMS +By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: +.TP 0.2i +\(bu +Digital Signature Algorithm (DSA) with the SHA1 digest algorithm +.TP 0.2i +\(bu +RSA algorithm with the SHA256 digest algorithm +.TP 0.2i +\(bu +Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. +.PP +If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. +.PP +These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. +.SS THE\ SIGNED\ JAR\ FILE +When the \f3jarsigner\fR command is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META-INF directory: +.TP 0.2i +\(bu +A signature file with an \f3\&.SF\fR extension +.TP 0.2i +\(bu +A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension +.PP +The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR +.PP +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. +.PP +Signature File -.LP -.LP -The default keystore type is "jks" (the proprietary type of the keystore implementation provided by Sun). This is specified by the following line in the security properties file: -.LP -.nf -\f3 -.fl - keystore.type=jks -.fl -\fP -.fi +A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: +.TP 0.2i +\(bu +File name +.TP 0.2i +\(bu +Name of the digest algorithm (SHA) +.TP 0.2i +\(bu +SHA digest value +.PP +In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. +.PP +The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. +.PP +Signature Block File -.LP -.LP -Note: Case doesn't matter in keystore type designations. For example, "JKS" would be considered the same as "jks". -.LP -.LP -To have the tools utilize a keystore implementation other than the default, change that line to specify a different keystore type. For example, if you have a provider package that supplies a keystore implementation for a keystore type called "pkcs12", change the line to -.LP -.nf -\f3 -.fl - keystore.type=pkcs12 -.fl -\fP -.fi +The \f3\&.SF\fR file is signed and the signature is placed in the signature block file\&. This file also contains, encoded inside it, the certificate or certificate chain from the keystore that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. +.SS SIGNATURE\ TIME\ STAMP +The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. +.sp +.nf +\f3\-tsa \fIurl\fR\fP +.fi +.nf +\f3\-tsacert \fIalias\fR\fP +.fi +.nf +\f3\-altsigner \fIclass\fR\fP +.fi +.nf +\f3\-altsignerpath \fIclasspathlist\fR\fP +.fi +.nf +\f3\-tsapolicyid \fIpolicyid\fR\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS JAR\ FILE\ VERIFICATION +A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: +.TP 0.4i +1\&. +Verify the signature of the \f3\&.SF\fR file\&. -.LP -.LP -Note that if you us the PKCS#11 provider package, you should refer to the -.na -\f2KeyTool and JarSigner\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#KeyToolJarSigner section of the Java PKCS#11 Reference Guide for details. -.LP -.SS -Supported Algorithms -.LP -.LP -By default, \f3jarsigner\fP signs a JAR file using one of the following: -.LP -.RS 3 -.TP 2 -o -DSA (Digital Signature Algorithm) with the SHA1 digest algorithm -.TP 2 -o -RSA algorithm with the SHA256 digest algorithm. -.TP 2 -o -EC (Elliptic Curve) cryptography algorithm with the SHA256 with ECDSA (Elliptic Curve Digital Signature Algorithm). -.RE +The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. +.TP 0.4i +2\&. +Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. -.LP -.LP -That is, if the signer's public and private keys are DSA keys, \f3jarsigner\fP will sign the JAR file using the "SHA1withDSA" algorithm. If the signer's keys are RSA keys, \f3jarsigner\fP will attempt to sign the JAR file using the "SHA256withRSA" algorithm. If the signer's keys are EC keys, \f3jarsigner\fP will sign the JAR file using the "SHA256withECDSA" algorithm. -.LP -.LP -These default signature algorithms can be overridden using the \f2\-sigalg\fP option. -.LP -.SS -The Signed JAR File -.LP -.LP -When \f3jarsigner\fP is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META\-INF directory: -.LP -.RS 3 -.TP 2 -o -a signature file, with a .SF extension, and -.TP 2 -o -a signature block file, with a .DSA, .RSA, or .EC extension. -.RE +The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. -.LP -.LP -The base file names for these two files come from the value of the \f2\-sigFile\fP option. For example, if the option appears as -.LP -.nf -\f3 -.fl -\-sigFile MKSIGN -.fl -\fP -.fi +If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. -.LP -.LP -The files are named "MKSIGN.SF" and "MKSIGN.DSA". -.LP -.LP -If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not allowed in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. Legal characters include letters, digits, underscores, and hyphens. -.LP -\f3The Signature (.SF) File\fP -.LP -.LP -A signature file (the .SF file) looks similar to the manifest file that is always included in a JAR file when \f3jarsigner\fP is used to sign the file. That is, for each source file included in the JAR file, the .SF file has three lines, just as in the manifest file, listing the following: -.LP -.RS 3 -.TP 2 -o -the file name, -.TP 2 -o -the name of the digest algorithm used (SHA), and -.TP 2 -o -a SHA digest value. -.RE +One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. +.TP 0.4i +3\&. +Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. -.LP -.LP -In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file. In the .SF file, on the other hand, the digest value for a given source file is the hash of the three lines in the manifest file for the source file. -.LP -.LP -The signature file also, by default, includes a header containing a hash of the whole manifest file. The presence of the header enables verification optimization, as described in JAR File Verification. -.LP -\f3The Signature Block File\fP -.LP -The .SF file is signed and the signature is placed in the signature block file. This file also contains, encoded inside it, the certificate or certificate chain from the keystore which authenticates the public key corresponding to the private key used for signing. The file has the extension .DSA, .RSA, or .EC depending on the digest algorithm used. -.SS -Signature Timestamp -.LP -.LP -\f2jarsigner\fP tool can generate and store a signature timestamp when signing a JAR file. In addition, \f2jarsigner\fP supports alternative signing mechanisms. This behavior is optional and is controlled by the user at the time of signing through these options: -.LP -.RS 3 -.TP 2 -o -\f2\-tsa url\fP -.TP 2 -o -\f2\-tsacert alias\fP -.TP 2 -o -\f2\-altsigner class\fP -.TP 2 -o -\f2\-altsignerpath classpathlist\fP -.RE +If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. +.PP +\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. +.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE +A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: +.sp +.nf +\f3jarsigner myBundle\&.jar susan\fP +.fi +.nf +\f3jarsigner myBundle\&.jar kevin\fP +.fi +.nf +\f3\fR +.fi +.sp +When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: +.sp +.nf +\f3SUSAN\&.SF\fP +.fi +.nf +\f3SUSAN\&.DSA\fP +.fi +.nf +\f3KEVIN\&.SF\fP +.fi +.nf +\f3KEVIN\&.DSA\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1\&.1 by the \f3javakey\fR command and others by \f3jarsigner\fR\&. The \f3jarsigner\fR command can be used to sign JAR files that are already signed with the \f3javakey\fR command\&. +.SH OPTIONS +The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: +.TP 0.2i +\(bu +All option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options can be provided in any order\&. +.TP 0.2i +\(bu +Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. +.TP 0.2i +\(bu +The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. +.TP +-keystore \fIurl\fR +.br +Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. -.LP -.LP -Each of these options is detailed in the Options section below. -.LP -.SS -JAR File Verification -.LP -.LP -A successful JAR file verification occurs if the signature(s) are valid, and none of the files that were in the JAR file when the signatures were generated have been changed since then. JAR file verification involves the following steps: -.LP -.RS 3 -.TP 3 -1. -Verify the signature of the .SF file itself. -.br -.br -That is, the verification ensures that the signature stored in each signature block (.DSA) file was in fact generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the .DSA file. It also ensures that the signature is a valid signature of the corresponding signature (.SF) file, and thus the .SF file has not been tampered with. -.TP 3 -2. -Verify the digest listed in each entry in the .SF file with each corresponding section in the manifest. -.br -.br -The .SF file by default includes a header containing a hash of the entire manifest file. When the header is present, then the verification can check to see whether or not the hash in the header indeed matches the hash of the manifest file. If that is the case, verification proceeds to the next step. -.br -.br -If that is not the case, a less optimized verification is required to ensure that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file (see The Signature (.SF) File). -.br -.br -One reason the hash of the manifest file that is stored in the .SF file header may not equal the hash of the current manifest file would be because one or more files were added to the JAR file (using the \f2jar\fP tool) after the signature (and thus the .SF file) was generated. When the \f2jar\fP tool is used to add files, the manifest file is changed (sections are added to it for the new files), but the .SF file is not. A verification is still considered successful if none of the files that were in the JAR file when the signature was generated have been changed since then, which is the case if the hashes in the non\-header sections of the .SF file equal the hashes of the corresponding sections in the manifest file. -.TP 3 -3. -Read each file in the JAR file that has an entry in the .SF file. While reading, compute the file's digest, and then compare the result with the digest for this file in the manifest section. The digests should be the same, or verification fails. -.RE +A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. -.LP -.LP -If any serious verification failures occur during the verification process, the process is stopped and a security exception is thrown. It is caught and displayed by \f3jarsigner\fP. -.LP -.SS -Multiple Signatures for a JAR File -.LP -.LP -A JAR file can be signed by multiple people simply by running the \f3jarsigner\fP tool on the file multiple times, specifying the alias for a different person each time, as in: -.LP -.nf -\f3 -.fl - jarsigner myBundle.jar susan -.fl - jarsigner myBundle.jar kevin -.fl -\fP -.fi +A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. -.LP -.LP -When a JAR file is signed multiple times, there are multiple .SF and .DSA files in the resulting JAR file, one pair for each signature. Thus, in the example above, the output JAR file includes files with the following names: -.LP -.nf -\f3 -.fl - SUSAN.SF -.fl - SUSAN.DSA -.fl - KEVIN.SF -.fl - KEVIN.DSA -.fl -\fP -.fi +The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: +.sp +.nf +\f3\-keystore \fIfilePathAndName\fR\fP +.fi +.nf +\f3\-keystore file:\fIfilePathAndName\fR\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.LP -Note: It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1.1 \f3javakey\fP tool and others by \f3jarsigner\fP. That is, \f3jarsigner\fP can be used to sign JAR files already previously signed using \f3javakey\fP. -.LP -.SH "OPTIONS" -.LP -.LP -The various \f3jarsigner\fP options are listed and described below. Note: -.LP -.RS 3 -.TP 2 -o -All option names are preceded by a minus sign (\-). -.TP 2 -o -The options may be provided in any order. -.TP 2 -o -Items in italics (option values) represent the actual values that must be supplied. -.TP 2 -o -The \f2\-keystore\fP, \f2\-storepass\fP, \f2\-keypass\fP, \f2\-sigfile\fP, \f2\-sigalg\fP, \f2\-digestalg\fP, and \f2\-signedjar\fP options are only relevant when signing a JAR file, not when verifying a signed JAR file. Similarly, an alias is only specified on the command line when signing a JAR file. -.RE -.LP -.RS 3 -.TP 3 -\-keystore url -Specifies the URL that tells the keystore location. This defaults to the file \f2.keystore\fP in the user's home directory, as determined by the "user.home" system property. -.br -.br -A keystore is required when signing, so you must explicitly specify one if the default keystore does not exist (or you want to use one other than the default). -.br -.br -A keystore is \f2not\fP required when verifying, but if one is specified, or the default exists, and the \f2\-verbose\fP option was also specified, additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore. -.br -.br -Note: the \f2\-keystore\fP argument can actually be a file name (and path) specification rather than a URL, in which case it will be treated the same as a "file:" URL. That is, -.nf -\f3 -.fl - \-keystore \fP\f4filePathAndName\fP\f3 -.fl -\fP -.fi -is treated as equivalent to -.nf -\f3 -.fl - \-keystore file:\fP\f4filePathAndName\fP\f3 -.fl -\fP -.fi -If the Sun PKCS#11 provider has been configured in the \f2java.security\fP security properties file (located in the JRE's \f2$JAVA_HOME/lib/security\fP directory), then keytool and jarsigner can operate on the PKCS#11 token by specifying these options: -.RS 3 -.TP 2 -o -\f2\-keystore NONE\fP -.TP 2 -o -\f2\-storetype PKCS11\fP -.RE -For example, this command lists the contents of the configured PKCS#11 token: -.nf -\f3 -.fl - jarsigner \-keystore NONE \-storetype PKCS11 \-list -.fl -\fP -.fi -.TP 3 -\-storetype storetype -Specifies the type of keystore to be instantiated. The default keystore type is the one that is specified as the value of the "keystore.type" property in the security properties file, which is returned by the static \f2getDefaultType\fP method in \f2java.security.KeyStore\fP. -.br -.br -The PIN for a PCKS#11 token can also be specified using the \f2\-storepass\fP option. If none has been specified, keytool and jarsigner will prompt for the token PIN. If the token has a protected authentication path (such as a dedicated PIN\-pad or a biometric reader), then the \f2\-protected\fP option must be specified and no password options can be specified. -.TP 3 -\-storepass[:env | :file] argument -Specifies the password which is required to access the keystore. This is only needed when signing (not verifying) a JAR file. In that case, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for the password. -.br -.br -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. -.TP 3 -\-keypass[:env | :file] argument -Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line. The password is required when using \f3jarsigner\fP to sign a JAR file. If no password is provided on the command line, and the required password is different from the store password, the user is prompted for it. -.br -.br -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. -.TP 3 -\-sigfile file -Specifies the base file name to be used for the generated .SF and .DSA files. For example, if \f2file\fP is "DUKESIGN", the generated .SF and .DSA files will be named "DUKESIGN.SF" and "DUKESIGN.DSA", and will be placed in the "META\-INF" directory of the signed JAR file. -.br -.br -The characters in \f2file\fP must come from the set "a\-zA\-Z0\-9_\-". That is, only letters, numbers, underscore, and hyphen characters are allowed. Note: All lowercase characters will be converted to uppercase for the .SF and .DSA file names. -.br -.br -If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not legal in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. -.TP 3 -\-sigalg algorithm -Specifies the name of the signature algorithm to use to sign the JAR file. -.br -.br -See -.na -\f2Appendix A\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard signature algorithm names. This algorithm must be compatible with the private key used to sign the JAR file. If this option is not specified, SHA1withDSA, SHA256withRSA, or SHA256withECDSA will be used depending on the type of private key. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed. -.TP 3 -\-digestalg algorithm -Specifies the name of the message digest algorithm to use when digesting the entries of a jar file. -.br -.br -See -.na -\f2Appendix A\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard message digest algorithm names. If this option is not specified, SHA256 will be used. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed. -.TP 3 -\-signedjar file -Specifies the name to be used for the signed JAR file. -.br -.br -If no name is specified on the command line, the name used is the same as the input JAR file name (the name of the JAR file to be signed); in other words, that file is overwritten with the signed JAR file. -.TP 3 -\-verify -If this appears on the command line, the specified JAR file will be verified, not signed. If the verification is successful, "jar verified" will be displayed. If you try to verify an unsigned JAR file, or a JAR file signed with an unsupported algorithm (e.g., RSA when you don't have an RSA provider installed), the following is displayed: "jar is unsigned. (signatures missing or not parsable)" -.br -.br -It is possible to verify JAR files signed using either \f3jarsigner\fP or the JDK 1.1 \f3javakey\fP tool, or both. -.br -.br -For further information on verification, see JAR File Verification. -.TP 3 -\-certs -If this appears on the command line, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file. This information includes -.RS 3 -.TP 2 -o -the name of the type of certificate (stored in the .DSA file) that certifies the signer's public key -.TP 2 -o -if the certificate is an X.509 certificate (more specifically, an instance of \f2java.security.cert.X509Certificate\fP): the distinguished name of the signer -.RE -The keystore is also examined. If no keystore value is specified on the command line, the default keystore file (if any) will be checked. If the public key certificate for a signer matches an entry in the keystore, then the following information will also be displayed: -.RS 3 -.TP 2 -o -in parentheses, the alias name for the keystore entry for that signer. If the signer actually comes from a JDK 1.1 identity database instead of from a keystore, the alias name will appear in brackets instead of parentheses. -.RE -.TP 3 -\-certchain file -Specifies the certificate chain to be used, if the certificate chain associated with the private key of the keystore entry, addressed by the alias specified on the command line, is not complete. This may happen if the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain. The file can be a sequence of X.509 certificates concatenated together, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as BASE64 encoding) as defined by the Internet RFC 1421 standard. -.TP 3 -\-verbose -If this appears on the command line, it indicates "verbose" mode, which causes \f3jarsigner\fP to output extra information as to the progress of the JAR signing or verification. -.TP 3 -\-internalsf -In the past, the .DSA (signature block) file generated when a JAR file was signed used to include a complete encoded copy of the .SF file (signature file) also generated. This behavior has been changed. To reduce the overall size of the output JAR file, the .DSA file by default doesn't contain a copy of the .SF file anymore. But if \f2\-internalsf\fP appears on the command line, the old behavior is utilized. \f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP -.TP 3 -\-sectionsonly -If this appears on the command line, the .SF file (signature file) generated when a JAR file is signed does \f2not\fP include a header containing a hash of the whole manifest file. It just contains information and hashes related to each individual source file included in the JAR file, as described in The Signature (.SF) File . -.br -.br -By default, this header is added, as an optimization. When the header is present, then whenever the JAR file is verified, the verification can first check to see whether or not the hash in the header indeed matches the hash of the whole manifest file. If so, verification proceeds to the next step. If not, it is necessary to do a less optimized verification that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file. -.br -.br -For further information, see JAR File Verification. -.br -.br -\f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP -.TP 3 -\-protected -Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader. -.TP 3 -\-providerClass provider\-class\-name -Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file, \f2java.security\fP. -.br -.br -Used in conjunction with the \f2\-providerArg\fP \f2ConfigFilePath\fP option, keytool and jarsigner will install the provider dynamically (where \f2ConfigFilePath\fP is the path to the token configuration file). Here's an example of a command to list a PKCS#11 keystore when the Sun PKCS#11 provider has not been configured in the security properties file. -.nf -\f3 -.fl -jarsigner \-keystore NONE \-storetype PKCS11 \\ -.fl - \-providerClass sun.security.pkcs11.SunPKCS11 \\ -.fl - \-providerArg /foo/bar/token.config \\ -.fl - \-list -.fl -\fP -.fi -.TP 3 -\-providerName providerName -If more than one provider has been configured in the \f2java.security\fP security properties file, you can use the \f2\-providerName\fP option to target a specific provider instance. The argument to this option is the name of the provider. -.br -.br -For the Sun PKCS#11 provider, \f2providerName\fP is of the form \f2SunPKCS11\-\fP\f2TokenName\fP, where \f2TokenName\fP is the name suffix that the provider instance has been configured with, as detailed in the -.na -\f2configuration attributes table\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#ATTRS. For example, the following command lists the contents of the PKCS#11 keystore provider instance with name suffix \f2SmartCard\fP: -.nf -\f3 -.fl -jarsigner \-keystore NONE \-storetype PKCS11 \\ -.fl - \-providerName SunPKCS11\-SmartCard \\ -.fl - \-list -.fl -\fP -.fi -.TP 3 -\-Jjavaoption -Passes through the specified \f2javaoption\fP string directly to the Java interpreter. (\f3jarsigner\fP is actually a "wrapper" around the interpreter.) This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line. -.TP 3 -\-tsa url -If \f2"\-tsa http://example.tsa.url"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The URL, \f2http://example.tsa.url\fP, identifies the location of the Time Stamping Authority (TSA). It overrides any URL found via the \f2\-tsacert\fP option. The \f2\-tsa\fP option does not require the TSA's public key certificate to be present in the keystore. -.br -.br -To generate the timestamp, \f2jarsigner\fP communicates with the TSA using the Time\-Stamp Protocol (TSP) defined in -.na -\f2RFC 3161\fP @ -.fi -http://www.ietf.org/rfc/rfc3161.txt. If successful, the timestamp token returned by the TSA is stored along with the signature in the signature block file. -.TP 3 -\-tsacert alias -If \f2"\-tsacert alias"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The \f2alias\fP identifies the TSA's public key certificate in the keystore that is currently in effect. The entry's certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA. -.br -.br -The TSA's public key certificate must be present in the keystore when using \f2\-tsacert\fP. -.TP 3 -\-altsigner class -Specifies that an alternative signing mechanism be used. The fully\-qualified class name identifies a class file that extends the \f2com.sun.jarsigner.ContentSigner abstract class\fP. The path to this class file is defined by the \f2\-altsignerpath\fP option. If the \f2\-altsigner\fP option is used, \f2jarsigner\fP uses the signing mechanism provided by the specified class. Otherwise, \f2jarsigner\fP uses its default signing mechanism. -.br -.br -For example, to use the signing mechanism provided by a class named \f2com.sun.sun.jarsigner.AuthSigner\fP, use the \f2jarsigner\fP option \f2"\-altsigner com.sun.jarsigner.AuthSigner"\fP -.TP 3 -\-altsignerpath classpathlist -Specifies the path to the class file (the class file name is specified with the \f2\-altsigner\fP option described above) and any JAR files it depends on. If the class file is in a JAR file, then this specifies the path to that JAR file, as shown in the example below. -.br -.br -An absolute path or a path relative to the current directory may be specified. If \f2classpathlist\fP contains multiple paths or JAR files, they should be separated with a colon (\f2:\fP) on Solaris and a semi\-colon (\f2;\fP) on Windows. This option is not necessary if the class is already in the search path. -.br -.br -Example of specifying the path to a jar file that contains the class file: -.nf -\f3 -.fl -\-altsignerpath /home/user/lib/authsigner.jar -.fl -\fP -.fi -Note that the JAR file name is included. -.br -.br -Example of specifying the path to the jar file that contains the class file: -.nf -\f3 -.fl -\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/ -.fl -\fP -.fi -Note that the JAR file name is omitted. -.TP 3 -\-strict -During the signing or verifying process, some warning messages may be shown. If this option appears on the command line, the exit code of the tool will reflect the warning messages that are found. Read the "WARNINGS" section for details. -.TP 3 -\-verbose:sub\-options -For the verifying process, the \f2\-verbose\fP option takes sub\-options to determine how much information will be shown. If \f2\-certs\fP is also specified, the default mode (or sub\-option all) displays each entry as it is being processed and following that, the certificate information for each signer of the JAR file. If \f2\-certs\fP and the \f2\-verbose:grouped\fP sub\-option are specified, entries with the same signer info are grouped and displayed together along with their certificate information. If \f2\-certs\fP and the \f2\-verbose:summary\fP sub\-option are specified, then entries with the same signer info are grouped and displayed together along with their certificate information but details about each entry are summarized and displayed as "one entry (and more)". See the examples section for more information. -.RE +If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: +.sp +.nf +\f3\-keystore NONE\fP +.fi +.nf +\f3\-storetype PKCS11\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.SH "EXAMPLES" -.LP -.SS -Signing a JAR File -.LP -.LP -Suppose you have a JAR file named "bundle.jar" and you'd like to sign it using the private key of the user whose keystore alias is "jane" in the keystore named "mystore" in the "working" directory. You can use the following to sign the JAR file and name the signed JAR file "sbundle.jar": -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3 -.fl - \-keypass \fP\f4<private key password>\fP\f3 \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi -.LP -.LP -Note that there is no \f2\-sigfile\fP specified in the command above, so the generated .SF and .DSA files to be placed in the signed JAR file will have default names based on the alias name. That is, they will be named \f2JANE.SF\fP and \f2JANE.DSA\fP. -.LP -.LP -If you want to be prompted for the store password and the private key password, you could shorten the above command to -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore -.fl - \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi +For example, the following command lists the contents of the configured PKCS#11 token: +.sp +.nf +\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.LP -If the keystore to be used is the default keystore (the one named ".keystore" in your home directory), you don't need to specify a keystore, as in: -.LP -.nf -\f3 -.fl - jarsigner \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi - -.LP -.LP -Finally, if you want the signed JAR file to simply overwrite the input JAR file (\f2bundle.jar\fP), you don't need to specify a \f2\-signedjar\fP option: -.LP -.nf -\f3 -.fl - jarsigner bundle.jar jane -.fl -\fP -.fi - -.LP -.SS -Verifying a Signed JAR File -.LP -.LP -To verify a signed JAR file, that is, to verify that the signature is valid and the JAR file has not been tampered with, use a command such as the following: -.LP -.nf -\f3 -.fl - jarsigner \-verify sbundle.jar -.fl -\fP -.fi - -.LP -.LP -If the verification is successful, -.LP -.nf -\f3 -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -is displayed. Otherwise, an error message appears. -.LP -.LP -You can get more information if you use the \f2\-verbose\fP option. A sample use of \f3jarsigner\fP with the \f2\-verbose\fP option is shown below, along with sample output: -.LP -.nf -\f3 -.fl - jarsigner \-verify \-verbose sbundle.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx.class -.fl - smk 849 Fri Sep 26 16:12:46 PDT 1997 test.class -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.SS -Verification with Certificate Information -.LP -.LP -If you specify the \f2\-certs\fP option when verifying, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file, including the certificate type, the signer distinguished name information (if and only if it's an X.509 certificate), and, in parentheses, the keystore alias for the signer if the public key certificate in the JAR file matches that in a keystore entry. For example, -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST.SF -.fl - 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST.DSA -.fl - smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst.class -.fl - -.fl - X.509, CN=Test Group, OU=Java Software, O=Sun Microsystems, L=CUP, S=CA, C=US (javatest) -.fl - X.509, CN=Jane Smith, OU=Java Software, O=Sun, L=cup, S=ca, C=us (jane) -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -If the certificate for a signer is not an X.509 certificate, there is no distinguished name information. In that case, just the certificate type and the alias are shown. For example, if the certificate is a PGP certificate, and the alias is "bob", you'd get -.LP -.nf -\f3 -.fl - PGP, (bob) -.fl -\fP -.fi - -.LP -.SS -Verification of a JAR File that Includes Identity Database Signers -.LP -.LP -If a JAR file has been signed using the JDK 1.1 \f3javakey\fP tool, and thus the signer is an alias in an identity database, the verification output includes an "i" symbol. If the JAR file has been signed by both an alias in an identity database and an alias in a keystore, both "k" and "i" appear. -.LP -.LP -When the \f2\-certs\fP option is used, any identity database aliases are shown in square brackets rather than the parentheses used for keystore aliases. For example: -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-verify \-verbose \-certs writeFile.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - 199 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE.SF -.fl - 1013 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE.DSA -.fl - smki 2752 Fri Sep 26 16:12:30 PDT 1997 writeFile.html -.fl - -.fl - X.509, CN=Jane Smith, OU=Java Software, O=Sun, L=cup, S=ca, C=us (jane) -.fl - X.509, CN=Duke, OU=Java Software, O=Sun, L=cup, S=ca, C=us [duke] -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - i = at least one certificate was found in identity scope -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -Note that the alias "duke" is in brackets to denote that it is an identity database alias, not a keystore alias. -.LP -.SH "WARNINGS" -.LP -During the signing/verifying process, jarsigner may display various warnings. These warning codes are defined as follows: -.nf -\f3 -.fl - hasExpiringCert 2 -.fl - This jar contains entries whose signer certificate will expire within six months -.fl - -.fl - hasExpiredCert 4 -.fl - This jar contains entries whose signer certificate has expired. -.fl - -.fl - notYetValidCert 4 -.fl - This jar contains entries whose signer certificate is not yet valid. -.fl - -.fl - chainNotValidated 4 -.fl - This jar contains entries whose certificate chain cannot be correctly validated. -.fl - -.fl - badKeyUsage 8 -.fl - This jar contains entries whose signer certificate's KeyUsage extension doesn't allow code signing. -.fl - -.fl - badExtendedKeyUsage 8 -.fl - This jar contains entries whose signer certificate's ExtendedKeyUsage extension -.fl - doesn't allow code signing. -.fl - -.fl - badNetscapeCertType 8 -.fl - This jar contains entries whose signer certificate's NetscapeCertType extension -.fl - doesn't allow code signing. -.fl - -.fl - hasUnsignedEntry 16 -.fl - This jar contains unsigned entries which have not been integrity\-checked. -.fl - -.fl - notSignedByAlias 32 -.fl - This jar contains signed entries which are not signed by the specified alias(es) -.fl - -.fl - aliasNotInStore 32 -.fl - This jar contains signed entries that are not signed by alias in this keystore -.fl - -.fl -\fP -.fi - -.LP -.LP -When the \f2\-strict\fP option is provided, an OR\-value of warnings detected will be returned as the exit code of the tool. For example, if a certificate used to sign an entry is expired and has a keyUsage extension that does not allow it to sign a file, an exit code 12 (=4+8) will be returned. -.LP -.LP -\f3Note\fP: Exit codes are reused because only 0\-255 is legal for Unix. In any case, if the signing/verifying process fails, the following exit code will be returned: -.LP -.nf -\f3 -.fl -failure 1 -.fl -\fP -.fi - -.LP -.SS -Compatibility with JDK 1.1 -.LP -.LP -The \f3keytool\fP and \f3jarsigner\fP tools completely replace the \f3javakey\fP tool provided in JDK 1.1. These new tools provide more features than \f3javakey\fP, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them. -.LP -.LP -The new keystore architecture replaces the identity database that \f3javakey\fP created and managed. There is no backwards compatibility between the keystore format and the database format used by \f3javakey\fP in 1.1. However, -.LP -.RS 3 -.TP 2 -o -It is possible to import the information from an identity database into a keystore, via the \f3keytool\fP \f2\-identitydb\fP command. -.TP 2 -o -\f3jarsigner\fP can sign JAR files also previously signed using \f3javakey\fP. -.TP 2 -o -\f3jarsigner\fP can verify JAR files signed using \f3javakey\fP. Thus, it recognizes and can work with signer aliases that are from a JDK 1.1 identity database rather than a Java 2 SDK keystore. -.RE - -.LP -.LP -The following table explains how JAR files that were signed in JDK 1.1.x are treated in the Java 2 platform. -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 83 84 -.nr 34 \n(.lu -.eo -.am 82 +.TP +-storetype \fIstoretype\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f3Trusted Identity imported into Java 2 Platform keystore from 1.1 database (4)\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 83 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(83 .ll \n(83u -.in 0 -\f3Policy File grants privileges to Identity/Alias\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. (3) -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. (1,3) -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code plus privileges granted in policy file. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code plus privileges granted in policy file. (2) -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3JAR File Type\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wUnsigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Identity in 1.1 database\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Untrusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Untrusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 82 0 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.82 -.rm 82 -.nr 38 \n(a- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 83 0 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.83 -.rm 83 -.nr 38 \n(b- -.if \n(83<\n(38 .nr 83 \n(38 -.nr 84 0 -.nr 38 \w\f3Privileges Granted\fP -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges (1) -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges (1) -.if \n(84<\n(38 .nr 84 \n(38 -.84 -.rm 84 -.nr 38 \n(c- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(d- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(e- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(f- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(g- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(h- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(i- -.if \n(84<\n(38 .nr 84 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr 43 \n(82+(3*\n(38) -.nr 83 +\n(43 -.nr 44 \n(83+(3*\n(38) -.nr 84 +\n(44 -.nr TW \n(84 -.if t .if \n(TW>\n(.li .tm Table at line 1082 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.ne \n(b|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3JAR File Type\fP\h'|\n(41u'\f3Identity in 1.1 database\fP\h'|\n(42u'\h'|\n(43u'\h'|\n(44u'\f3Privileges Granted\fP -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(43u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Unsigned JAR\h'|\n(41u'NO\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'YES\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Untrusted\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Untrusted\h'|\n(42u'NO\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'YES\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'YES\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u'All privileges -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'YES\h'|\n(43u'NO\h'|\n(44u'All privileges (1) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'NO\h'|\n(43u'YES\h'|\n(44u'All privileges (1) -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-42 +Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. -.LP -.LP -Notes: -.LP -.RS 3 -.TP 3 -1. -If an identity/alias is mentioned in the policy file, it must be imported into the keystore for the policy file to have any effect on privileges granted. -.TP 3 -2. -The policy file/keystore combination has precedence over a trusted identity in the identity database. -.TP 3 -3. -Untrusted identities are ignored in the Java 2 platform. -.TP 3 -4. -Only trusted identities can be imported into Java 2 SDK keystores. -.RE +The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands prompt for the token PIN\&. If the token has a protected authentication path (such as a dedicated PIN-pad or a biometric reader), then the \f3-protected\fR option must be specified and no password options can be specified\&. +.TP +-storepass[:env | :file] \fIargument\fR +.br +Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jar(1) tool documentation -.TP 2 -o -keytool(1) tool documentation -.TP 2 -o -the -.na -\f4Security\fP @ -.fi -http://download.oracle.com/javase/tutorial/security/index.html trail of the -.na -\f4Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/index.html for examples of the use of the \f3jarsigner\fP tool -.RE +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE -.LP - + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-keypass [:env | :file] \fIargument\fR +.br +Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line\&. The password is required when using \f3jarsigner\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-sigfile \fIfile\fR +.br +Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. + +The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. + +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to upper case\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. +.TP +-sigalg \fIalgorithm\fR +.br +Specifies the name of the signature algorithm to use to sign the JAR file\&. + +For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are used depending on the type of private key\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-digestalg \fIalgorithm\fR +.br +Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. + +For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-certs +.br +If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. + +The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. If the signer comes from a JDK 1\&.1 identity database instead of from a keystore, then the alias name displays in brackets instead of parentheses\&. +.TP +-certchain \fIfile\fR +.br +Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. +.TP +-verbose +.br +When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. +.TP +-internalsf +.br +In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. +.TP +-sectionsonly +.br +If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. + +By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. + +The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. +.TP +-protected +.br +Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. +.TP +-providerClass \fIprovider-class-name\fR +.br +Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. + +Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP +.fi +.nf +\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-providerName \fIproviderName\fR +.br +If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. + +For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerName SunPKCS11\-SmartCard \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-J\fIjavaoption\fR +.br +Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is a wrapper around the interpreter\&. This option should not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.TP +-tsa \fIurl\fR +.br +If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. + +To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. +.TP +-tsacert \fIalias\fR +.br +When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. + +The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. +.TP +-tsapolicyid \fIpolicyid\fR +.br +Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. + +Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. +.TP +-altsigner \fIclass\fR +.br +This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. + +For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. +.TP +-altsignerpath \fIclasspathlist\fR +.br +Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. + +An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. + +The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. +.sp +.nf +\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. +.sp +.nf +\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-strict +.br +During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. +.TP +-verbose \fIsuboptions\fR +.br +For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. +.SH ERRORS\ AND\ WARNINGS +During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. +.PP +If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. +.PP +For example, if a certificate used to sign an entry is expired and has a KeyUsage extension that does not allow it to sign a file, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. +.PP +\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. +.PP +The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. +.SS FAILURE +Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. +.TP +failure +Code 1\&. The signing or verifying fails\&. +.SS SEVERE\ WARNINGS +\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. +.PP +Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. +.TP +hasExpiredCert +Code 4\&. This jar contains entries whose signer certificate has expired\&. +.TP +notYetValidCert +Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. +.TP +chainNotValidated +Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. +.TP +badKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. +.TP +badExtendedKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. +.TP +badNetscapeCertType +Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. +.TP +hasUnsignedEntry +Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. +.TP +notSignedByAlias +Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. +.TP +aliasNotInStore +Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. +.SS INFORMATIONAL\ WARNINGS +Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. +.TP +hasExpiringCert +This jar contains entries whose signer certificate will expire within six months\&. +.TP +noTimestamp +This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. +.SH EXAMPLES +.SS SIGN\ A\ JAR\ FILE +Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password>\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. +.PP +If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: +.sp +.nf +\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: +.sp +.nf +\f3jarsigner bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFY\ A\ SIGNED\ JAR\ FILE +To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: +.sp +.nf +\f3jarsigner \-verify sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp +When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: +.sp +.nf +\f3jarsigner \-verify \-verbose sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP +.fi +.nf +\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION +If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP +.fi +.nf +\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. +.SS VERIFICATION\ THAT\ INCLUDES\ IDENTITY\ DATABASE\ SIGNERS +If a JAR file was signed with the JDK 1\&.1 \f3javakey\fR tool, and the signer is an alias in an identity database, then the verification output includes an \f3i\fR\&. If the JAR file was signed by both an alias in an identity database and an alias in a keystore, then both \f3k\fR and \f3i\fR appear\&. +.PP +When the \f3-certs\fR option is used, any identity database aliases are shown in brackets rather than the parentheses used for keystore aliases, for example: +.sp +.nf +\f3 jarsigner \-keystore /working/mystore \-verify \-verbose \-certs writeFile\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 199 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE\&.DSA\fP +.fi +.nf +\f3 smki 2752 Fri Sep 26 16:12:30 PDT 1997 writeFile\&.html\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3 X\&.509, CN=Duke, OU=Java Software, O=Oracle, L=cup, S=ca, C=us [duke]\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3 i = at least one certificate was found in identity scope\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR The alias \f3duke\fR is in brackets to denote that it is an identity database alias, and not a keystore alias\&. +.SH JDK\ 1\&.1\ COMPATIBILITY +The \f3keytool\fR and \f3jarsigner\fR tools replace the \f3javakey\fR tool in JDK 1\&.1\&. These new tools provide more features than \f3javakey\fR, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them\&. +.PP +The new keystore architecture replaces the identity database that \f3javakey\fR created and managed\&. There is no backward compatibility between the keystore format and the database format used by \f3javakey\fR in JDK 1\&.1\&. However, be aware of the following: +.TP 0.2i +\(bu +It is possible to import the information from an identity database into a keystore through the \f3keytool -identitydb\fR command\&. +.TP 0.2i +\(bu +The \f3jarsigner\fR command can sign JAR files that were signed with the \f3javakey\fR command\&. +.TP 0.2i +\(bu +The \f3jarsigner\fR command can verify JAR files signed with \f3javakey\fR\&. The \f3jarsigner\fR command recognizes and can work with signer aliases that are from a JDK 1\&.1 identity database rather than a JDK keystore\&. +.SS UNSIGNED\ JARS +Unsigned JARs have the default privileges that are granted to all code\&. +.SS SIGNED\ JARS +Signed JARs have the privilege configurations based on their JDK 1\&.1\&.\fIn\fR identity and policy file status as described\&. Only trusted identities can be imported into the JDK keystore\&. +.PP +Default Privileges Granted to All Code + +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: Yes/Untrusted +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.br +See 3 in Notes Regarding Privileges of Signed JARs\&. +.PP + +.PP +Identity in 1\&.1 database: Yes/Untrusted +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 1 and 3 in Notes Regarding Privileges of Signed JARs\&. +.PP +Default Privileges and Policy File Privileges Granted + +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.PP + +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 2 in Notes Regarding Privileges of Signed JARs\&. +.PP +All Privileges Granted + +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.br +See 1 in Notes Regarding Privileges of Signed JARs\&. +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 1 in Notes Regarding Privileges of Signed JARs\&. +.PP +Notes Regarding Privileges of Signed JARs +.TP 0.4i +1\&. +If an identity or alias is mentioned in the policy file, then it must be imported into the keystore for the policy file to have any effect on privileges granted\&. +.TP 0.4i +2\&. +The policy file/keystore combination has precedence over a trusted identity in the identity database\&. +.TP 0.4i +3\&. +Untrusted identities are ignored in the Java platform\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +keytool(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/java.1 b/jdk/src/linux/doc/man/java.1 index 2e885083a8b..250396d33c4 100644 --- a/jdk/src/linux/doc/man/java.1 +++ b/jdk/src/linux/doc/man/java.1 @@ -1,517 +1,1991 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH java 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: java.1 +.\" +.if n .pl 99999 +.TH java 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -java \- the Java application launcher -.LP -.SH "SYNOPSIS" -.LP +.SH NAME +java \- Launches a Java application\&. +.SH SYNOPSIS +.sp +.nf + +\fBjava\fR [\fIoptions\fR] \fIclassname\fR [\fIargs\fR] +.fi +.nf + +\fBjava\fR [\fIoptions\fR] \fB\-jar\fR \fIfilename\fR [\fIargs\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options separated by spaces\&. See Options\&. +.TP +\fIclassname\fR +The name of the class to be launched\&. +.TP +\fIfilename\fR +The name of the Java Archive (JAR) file to be called\&. Used only with the \f3-jar\fR option\&. +.TP +\fIargs\fR +The arguments passed to the \f3main()\fR method separated by spaces\&. +.SH DESCRIPTION +The \f3java\fR command starts a Java application\&. It does this by starting the Java Runtime Environment (JRE), loading the specified class, and calling that class\&'s \f3main()\fR method\&. The method must be declared \fIpublic\fR and \fIstatic\fR, it must not return any value, and it must accept a \f3String\fR array as a parameter\&. The method declaration has the following form: +.sp +.nf +\f3public static void main(String[] args)\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3java\fR command can be used to launch a JavaFX application by loading a class that either has a \f3main()\fR method or that extends \f3javafx\&.application\&.Application\fR\&. In the latter case, the launcher constructs an instance of the \f3Application\fR class, calls its \f3init()\fR method, and then calls the \f3start(javafx\&.stage\&.Stage)\fR method\&. +.PP +By default, the first argument that is not an option of the \f3java\fR command is the fully qualified name of the class to be called\&. If the \f3-jar\fR option is specified, its argument is the name of the JAR file containing class and resource files for the application\&. The startup class must be indicated by the \f3Main-Class\fR manifest header in its source code\&. +.PP +The JRE searches for the startup class (and other classes used by the application) in three sets of locations: the bootstrap class path, the installed extensions, and the user\(cqs class path\&. +.PP +Arguments after the class file name or the JAR file name are passed to the \f3main()\fR method\&. +.SH OPTIONS +The \f3java\fR command supports a wide range of options that can be divided into the following categories: +.TP 0.2i +\(bu +Standard Options +.TP 0.2i +\(bu +Non-Standard Options +.TP 0.2i +\(bu +Advanced Runtime Options +.TP 0.2i +\(bu +Advanced JIT Compiler Options +.TP 0.2i +\(bu +Advanced Serviceability Options +.TP 0.2i +\(bu +Advanced Garbage Collection Options +.PP +Standard options are guaranteed to be supported by all implementations of the Java Virtual Machine (JVM)\&. They are used for common actions, such as checking the version of the JRE, setting the class path, enabling verbose output, and so on\&. +.PP +Non-standard options are general purpose options that are specific to the Java HotSpot Virtual Machine, so they are not guaranteed to be supported by all JVM implementations, and are subject to change\&. These options start with \f3-X\fR\&. +.PP +Advanced options are not recommended for casual use\&. These are developer options used for tuning specific areas of the Java HotSpot Virtual Machine operation that often have specific system requirements and may require privileged access to system configuration parameters\&. They are also not guaranteed to be supported by all JVM implementations, and are subject to change\&. Advanced options start with \f3-XX\fR\&. +.PP +To keep track of the options that were deprecated or removed in the latest release, there is a section named Deprecated and Removed Options at the end of the document\&. +.PP +Boolean options are used to either enable a feature that is disabled by default or disable a feature that is enabled by default\&. Such options do not require a parameter\&. Boolean \f3-XX\fR options are enabled using the plus sign (\f3-XX:+\fR\fIOptionName\fR) and disabled using the minus sign (\f3-XX:-\fR\fIOptionName\fR)\&. +.PP +For options that require an argument, the argument may be separated from the option name by a space, a colon (:), or an equal sign (=), or the argument may directly follow the option (the exact syntax differs for each option)\&. If you are expected to specify the size in bytes, you can use no suffix, or use the suffix \f3k\fR or \f3K\fR for kilobytes (KB), \f3m\fR or \f3M\fR for megabytes (MB), \f3g\fR or \f3G\fR for gigabytes (GB)\&. For example, to set the size to 8 GB, you can specify either \f38g\fR, \f38192m\fR, \f38388608k\fR, or \f38589934592\fR as the argument\&. If you are expected to specify the percentage, use a number from 0 to 1 (for example, specify \f30\&.25\fR for 25%)\&. +.SS STANDARD\ OPTIONS +These are the most commonly used options that are supported by all implementations of the JVM\&. +.TP +-agentlib:\fIlibname\fR[=\fIoptions\fR] +.br +Loads the specified native agent library\&. After the library name, a comma-separated list of options specific to the library can be used\&. + +If the option \f3-agentlib:foo\fR is specified, then the JVM attempts to load the library named \f3libfoo\&.so\fR in the location specified by the \f3LD_LIBRARY_PATH\fR system variable (on OS X this variable is \f3DYLD_LIBRARY_PATH\fR)\&. + +The following example shows how to load the heap profiling tool (HPROF) library and get sample CPU information every 20 ms, with a stack depth of 3: +.sp +.nf +\f3\-agentlib:hprof=cpu=samples,interval=20,depth=3\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example shows how to load the Java Debug Wire Protocol (JDWP) library and listen for the socket connection on port 8000, suspending the JVM before the main class loads: +.sp +.nf +\f3\-agentlib:jdwp=transport=dt_socket,server=y,address=8000\fP +.fi +.nf +\f3\fP +.fi +.sp + + +For more information about the native agent libraries, refer to the following: +.RS +.TP 0.2i +\(bu +The \f3java\&.lang\&.instrument\fR package description at http://docs\&.oracle\&.com/javase/8/docs/api/java/lang/instrument/package-summary\&.html +.TP 0.2i +\(bu +Agent Command Line Options in the JVM Tools Interface guide at http://docs\&.oracle\&.com/javase/8/docs/platform/jvmti/jvmti\&.html#starting +.RE + +.TP +-agentpath:\fIpathname\fR[=\fIoptions\fR] +.br +Loads the native agent library specified by the absolute path name\&. This option is equivalent to \f3-agentlib\fR but uses the full path and file name of the library\&. +.TP +-client +.br +Selects the Java HotSpot Client VM\&. The 64-bit version of the Java SE Development Kit (JDK) currently ignores this option and instead uses the Server JVM\&. + +For default JVM selection, see Server-Class Machine Detection at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/server-class\&.html +.TP +-D\fIproperty\fR=\fIvalue\fR +.br +Sets a system property value\&. The \fIproperty\fR variable is a string with no spaces that represents the name of the property\&. The \fIvalue\fR variable is a string that represents the value of the property\&. If \fIvalue\fR is a string with spaces, then enclose it in quotation marks (for example \f3-Dfoo="foo bar"\fR)\&. +.TP +-d32 +.br +Runs the application in a 32-bit environment\&. If a 32-bit environment is not installed or is not supported, then an error will be reported\&. By default, the application is run in a 32-bit environment unless a 64-bit system is used\&. +.TP +-d64 +.br +Runs the application in a 64-bit environment\&. If a 64-bit environment is not installed or is not supported, then an error will be reported\&. By default, the application is run in a 32-bit environment unless a 64-bit system is used\&. + +Currently only the Java HotSpot Server VM supports 64-bit operation, and the \f3-server\fR option is implicit with the use of \f3-d64\fR\&. The \f3-client\fR option is ignored with the use of \f3-d64\fR\&. This is subject to change in a future release\&. +.TP .nf -\f3 -.fl - \fP\f3java\fP [ options ] class [ argument ... ] -.fl - \f3java\fP [ options ] \f3\-jar\fP file.jar [ argument ... ] -.fl +-disableassertions[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR], -da[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR] +.br .fi +Disables assertions\&. By default, assertions are disabled in all packages and classes\&. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -class -Name of the class to be invoked. -.TP 3 -file.jar -Name of the jar file to be invoked. Used only with \f2\-jar\fP. -.TP 3 -argument -Argument passed to the \f3main\fP function. +With no arguments, \f3-disableassertions\fR (\f3-da\fR) disables assertions in all packages and classes\&. With the \fIpackagename\fR argument ending in \f3\&.\&.\&.\fR, the switch disables assertions in the specified package and any subpackages\&. If the argument is simply \f3\&.\&.\&.\fR, then the switch disables assertions in the unnamed package in the current working directory\&. With the \fIclassname\fR argument\f3\fR, the switch disables assertions in the specified class\&. + +The \f3-disableassertions\fR (\f3-da\fR) option applies to all class loaders and to system classes (which do not have a class loader)\&. There is one exception to this rule: if the option is provided with no arguments, then it does not apply to system classes\&. This makes it easy to disable assertions in all classes except for system classes\&. The \f3-disablesystemassertions\fR option enables you to disable assertions in all system classes\&. + +To explicitly enable assertions in specific packages or classes, use the \f3-enableassertions\fR (\f3-ea\fR) option\&. Both options can be used at the same time\&. For example, to run the \f3MyClass\fR application with assertions enabled in package \f3com\&.wombat\&.fruitbat\fR (and any subpackages) but disabled in class \f3com\&.wombat\&.fruitbat\&.Brickbat\fR, use the following command: +.sp +.nf +\f3java \-ea:com\&.wombat\&.fruitbat\&.\&.\&. \-da:com\&.wombat\&.fruitbat\&.Brickbat MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-disablesystemassertions, -dsa +.br +Disables assertions in all system classes\&. +.TP +.nf +-enableassertions[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR], -ea[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR] +.br +.fi +Enables assertions\&. By default, assertions are disabled in all packages and classes\&. + +With no arguments, \f3-enableassertions\fR (\f3-ea\fR) enables assertions in all packages and classes\&. With the \fIpackagename\fR argument ending in \f3\&.\&.\&.\fR, the switch enables assertions in the specified package and any subpackages\&. If the argument is simply \f3\&.\&.\&.\fR, then the switch enables assertions in the unnamed package in the current working directory\&. With the \fIclassname\fR argument\f3\fR, the switch enables assertions in the specified class\&. + +The \f3-enableassertions\fR (\f3-ea\fR) option applies to all class loaders and to system classes (which do not have a class loader)\&. There is one exception to this rule: if the option is provided with no arguments, then it does not apply to system classes\&. This makes it easy to enable assertions in all classes except for system classes\&. The \f3-enablesystemassertions\fR option provides a separate switch to enable assertions in all system classes\&. + +To explicitly disable assertions in specific packages or classes, use the \f3-disableassertions\fR (\f3-da\fR) option\&. If a single command contains multiple instances of these switches, then they are processed in order before loading any classes\&. For example, to run the \f3MyClass\fR application with assertions enabled only in package \f3com\&.wombat\&.fruitbat\fR (and any subpackages) but disabled in class \f3com\&.wombat\&.fruitbat\&.Brickbat\fR, use the following command: +.sp +.nf +\f3java \-ea:com\&.wombat\&.fruitbat\&.\&.\&. \-da:com\&.wombat\&.fruitbat\&.Brickbat MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-enablesystemassertions, -esa +.br +Enables assertions in all system classes\&. +.TP +-help, -? +.br +Displays usage information for the \f3java\fR command without actually running the JVM\&. +.TP +-jar \fIfilename\fR +.br +Executes a program encapsulated in a JAR file\&. The \fIfilename\fR argument is the name of a JAR file with a manifest that contains a line in the form \f3Main-Class:\fR\fIclassname\fR that defines the class with the \f3public static void main(String[] args)\fR method that serves as your application\&'s starting point\&. + +When you use the \f3-jar\fR option, the specified JAR file is the source of all user classes, and other class path settings are ignored\&. + +For more information about JAR files, see the following resources: +.RS +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +The Java Archive (JAR) Files guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jar/index\&.html +.TP 0.2i +\(bu +Lesson: Packaging Programs in JAR Files at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE + +.TP +-javaagent:\fIjarpath\fR[=\fIoptions\fR] +.br +Loads the specified Java programming language agent\&. For more information about instrumenting Java applications, see the \f3java\&.lang\&.instrument\fR package description in the Java API documentation at http://docs\&.oracle\&.com/javase/8/docs/api/java/lang/instrument/package-summary\&.html +.TP +-jre-restrict-search +.br +Includes user-private JREs in the version search\&. +.TP +-no-jre-restrict-search +.br +Excludes user-private JREs from the version search\&. +.TP +-server +.br +Selects the Java HotSpot Server VM\&. The 64-bit version of the JDK supports only the Server VM, so in that case the option is implicit\&. + +For default JVM selection, see Server-Class Machine Detection at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/server-class\&.html +.TP +-showversion +.br +Displays version information and continues execution of the application\&. This option is equivalent to the \f3-version\fR option except that the latter instructs the JVM to exit after displaying version information\&. +.TP +-splash:\fIimgname\fR +.br +Shows the splash screen with the image specified by \fIimgname\fR\&. For example, to show the \f3splash\&.gif\fR file from the \f3images\fR directory when starting your application, use the following option: +.sp +.nf +\f3\-splash:images/splash\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-verbose:class +.br +Displays information about each loaded class\&. +.TP +-verbose:gc +.br +Displays information about each garbage collection (GC) event\&. +.TP +-verbose:jni +.br +Displays information about the use of native methods and other Java Native Interface (JNI) activity\&. +.TP +-version +.br +Displays version information and then exits\&. This option is equivalent to the \f3-showversion\fR option except that the latter does not instruct the JVM to exit after displaying version information\&. +.TP +-version:\fIrelease\fR +.br +Specifies the release version to be used for running the application\&. If the version of the \f3java\fR command called does not meet this specification and an appropriate implementation is found on the system, then the appropriate implementation will be used\&. + +The \fIrelease\fR argument specifies either the exact version string, or a list of version strings and ranges separated by spaces\&. A \fIversion string\fR is the developer designation of the version number in the following form: \f31\&.\fR\fIx\fR\f3\&.0_\fR\fIu\fR (where \fIx\fR is the major version number, and \fIu\fR is the update version number)\&. A \fIversion range\fR is made up of a version string followed by a plus sign (\f3+\fR) to designate this version or later, or a part of a version string followed by an asterisk (\f3*\fR) to designate any version string with a matching prefix\&. Version strings and ranges can be combined using a space for a logical \fIOR\fR combination, or an ampersand (\f3&\fR) for a logical \fIAND\fR combination of two version strings/ranges\&. For example, if running the class or JAR file requires either JRE 6u13 (1\&.6\&.0_13), or any JRE 6 starting from 6u10 (1\&.6\&.0_10), specify the following: +.sp +.nf +\f3\-version:"1\&.6\&.0_13 1\&.6* & 1\&.6\&.0_10+"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Quotation marks are necessary only if there are spaces in the \fIrelease\fR parameter\&. + +For JAR files, the preference is to specify version requirements in the JAR file manifest rather than on the command line\&. +.SS NON-STANDARD\ OPTIONS +These options are general purpose options that are specific to the Java HotSpot Virtual Machine\&. +.TP +-X +.br +Displays help for all available \f3-X\fR options\&. +.TP +-Xbatch +.br +Disables background compilation\&. By default, the JVM compiles the method as a background task, running the method in interpreter mode until the background compilation is finished\&. The \f3-Xbatch\fR flag disables background compilation so that compilation of all methods proceeds as a foreground task until completed\&. + +This option is equivalent to \f3-XX:-BackgroundCompilation\fR\&. +.TP +-Xbootclasspath:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to search for boot class files\&. These are used in place of the boot class files included in the JDK\&. + +\fI\fRDo not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to append to the end of the default bootstrap class path\&. + +Do not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to prepend to the front of the default bootstrap class path\&. + +Do not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xboundthreads +.br +Binds user-level threads to kernel threads\&. +.TP +-Xcheck:jni +.br +Performs additional checks for Java Native Interface (JNI) functions\&. Specifically, it validates the parameters passed to the JNI function and the runtime environment data before processing the JNI request\&. Any invalid data encountered indicates a problem in the native code, and the JVM will terminate with an irrecoverable error in such cases\&. Expect a performance degradation when this option is used\&. +.TP +-Xcomp +.br +Disables interpretation of Java code and compile methods on first invocation\&. By default, the JIT compiler performs 10,000 interpreted method invocations to gather information for efficient compilation\&. To increase compilation performance at the expense of efficiency, use the \f3-Xcomp\fR flag to disable interpreted method invocations\&. + +You can also change the number of interpreted method invocations before compilation using the \f3-XX:CompileThreshold\fR option\&. +.TP +-Xdebug +.br +Does nothing\&. Provided for backward compatibility\&. +.TP +-Xdiag +.br +Shows additional diagnostic messages\&. +.TP +-Xfuture +.br +Enables strict class-file format checks that enforce close conformance to the class-file format specification\&. Developers are encouraged to use this flag when developing new code because the stricter checks will become the default in future releases\&. +.TP +-Xincgc +.br +Enables incremental GC\&. +.TP +-Xint +.br +Runs the application in interpreted-only mode\&. Compilation to native code is disabled, and all bytecode is executed by the interpreter\&. The performance benefits offered by the just in time (JIT) compiler are not present in this mode\&. +.TP +-Xinternalversion +.br +Displays more detailed JVM version information than the \f3-version\fR option, and then exits\&. +.TP +-Xloggc:\fIfilename\fR +.br +Sets the file to which verbose GC events information should be redirected for logging\&. The information written to this file is similar to the output of \f3-verbose:gc\fR with the time elapsed since the first GC event preceding each logged event\&. The \f3-Xloggc\fR option overrides \f3-verbose:gc\fR if both are given with the same \f3java\fR command\&. + +Example: +.sp +.nf +\f3\-Xloggc:garbage\-collection\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xmaxjitcodesize=\fIsize\fR +.br +Specifies the maximum code cache size (in bytes) for JIT-compiled code\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the value is set to 48 MB: +.sp +.nf +\f3\-Xmaxjitcodesize=48m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This option is equivalent to \f3-XX:ReservedCodeCacheSize\fR\&. +.TP +-Xmixed +.br +Executes all bytecode by the interpreter except for hot methods, which are compiled to native code\&. +.TP +-Xmn\fIsize\fR +.br +Sets the initial and maximum size (in bytes) of the heap for the young generation (nursery)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The young generation region of the heap is used for new objects\&. GC is performed in this region more often than in other regions\&. If the size for the young generation is too small, then a lot of minor garbage collections will be performed\&. If the size is too large, then only full garbage collections will be performed, which can take a long time to complete\&. Oracle recommends that you keep the size for the young generation between a half and a quarter of the overall heap size\&. + +The following examples show how to set the initial and maximum size of young generation to 256 MB using various units: +.sp +.nf +\f3\-Xmn256m\fP +.fi +.nf +\f3\-Xmn262144k\fP +.fi +.nf +\f3\-Xmn268435456\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Instead of the \f3-Xmn\fR option to set both the initial and maximum size of the heap for the young generation, you can use \f3-XX:NewSize\fR to set the initial size and \f3-XX:MaxNewSize\fR to set the maximum size\&. +.TP +-Xms\fIsize\fR +.br +Sets the initial size (in bytes) of the heap\&. This value must be a multiple of 1024 and greater than 1 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The following examples show how to set the size of allocated memory to 6 MB using various units: +.sp +.nf +\f3\-Xms6291456\fP +.fi +.nf +\f3\-Xms6144k\fP +.fi +.nf +\f3\-Xms6m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If you do not set this option, then the initial size will be set as the sum of the sizes allocated for the old generation and the young generation\&. The initial size of the heap for the young generation can be set using the \f3-Xmn\fR option or the \f3-XX:NewSize\fR option\&. +.TP +-Xmx\fIsize\fR +.br +Specifies the maximum size (in bytes) of the memory allocation pool in bytes\&. This value must be a multiple of 1024 and greater than 2 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For server deployments, \f3-Xms\fR and \f3-Xmx\fR are often set to the same value\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the maximum allowed size of allocated memory to 80 MB using various units: +.sp +.nf +\f3\-Xmx83886080\fP +.fi +.nf +\f3\-Xmx81920k\fP +.fi +.nf +\f3\-Xmx80m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The \f3-Xmx\fR option is equivalent to \f3-XX:MaxHeapSize\fR\&. +.TP +-Xnoclassgc +.br +Disables garbage collection (GC) of classes\&. This can save some GC time, which shortens interruptions during the application run\&. + +When you specify \f3-Xnoclassgc\fR at startup, the class objects in the application will be left untouched during GC and will always be considered live\&. This can result in more memory being permanently occupied which, if not used carefully, will throw an out of memory exception\&. +.TP +-Xprof +.br +Profiles the running program and sends profiling data to standard output\&. This option is provided as a utility that is useful in program development and is not intended to be used in production systems\&. +.TP +-Xrs +.br +Reduces the use of operating system signals by the JVM\&. + +Shutdown hooks enable orderly shutdown of a Java application by running user cleanup code (such as closing database connections) at shutdown, even if the JVM terminates abruptly\&. + +The JVM catches signals to implement shutdown hooks for unexpected termination\&. The JVM uses \f3SIGHUP\fR, \f3SIGINT\fR, and \f3SIGTERM\fR to initiate the running of shutdown hooks\&. + +The JVM uses a similar mechanism to implement the feature of dumping thread stacks for debugging purposes\&. The JVM uses \f3SIGQUIT\fR to perform thread dumps\&. + +Applications embedding the JVM frequently need to trap signals such as \f3SIGINT\fR or \f3SIGTERM\fR, which can lead to interference with the JVM signal handlers\&. The \f3-Xrs\fR option is available to address this issue\&. When \f3-Xrs\fR is used, the signal masks for \f3SIGINT\fR, \f3SIGTERM\fR, \f3SIGHUP\fR, and \f3SIGQUIT\fR are not changed by the JVM, and signal handlers for these signals are not installed\&. + +There are two consequences of specifying \f3-Xrs\fR: +.RS +.TP 0.2i +\(bu +\f3SIGQUIT\fR thread dumps are not available\&. +.TP 0.2i +\(bu +User code is responsible for causing shutdown hooks to run, for example, by calling \f3System\&.exit()\fR when the JVM is to be terminated\&. +.RE + +.TP +-Xshare:\fImode\fR +.br +Sets the class data sharing mode\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +auto +Use shared class data if possible\&. This is the default value for Java HotSpot 32-Bit Client VM\&. +.TP +on +Require the use of class data sharing\&. Print an error message and exit if class data sharing cannot be used\&. +.TP +off +Do not use shared class data\&. This is the default value for Java HotSpot 32-Bit Server VM, Java HotSpot 64-Bit Client VM, and Java HotSpot 64-Bit Server VM\&. +.TP +dump +Manually generate the class data sharing archive\&. +.RE + +.TP +-XshowSettings:\fIcategory\fR +.br +Shows settings and continues\&. Possible \fIcategory\fR arguments for this option include the following: +.RS +.TP +all +Shows all categories of settings\&. This is the default value\&. +.TP +locale +Shows settings related to locale\&. +.TP +properties +Shows settings related to system properties\&. +.TP +vm +Shows the settings of the JVM\&. +.RE + +.TP +-Xss\fIsize\fR +.br +Sets the thread stack size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate KB, \f3m\fR or \f3M\fR to indicate MB, \f3g\fR or \f3G\fR to indicate GB\&. The default value depends on the platform: +.RS +.TP 0.2i +\(bu +Linux/ARM (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +OS X (64-bit): 1024 KB +.TP 0.2i +\(bu +Oracle Solaris/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Oracle Solaris/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +Windows: depends on virtual memory .RE +.RS +The following examples set the thread stack size to 1024 KB in different units: +.sp +.nf +\f3\-Xss1m\fP +.fi +.nf +\f3\-Xss1024k\fP +.fi +.nf +\f3\-Xss1048576\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3java\fP tool launches a Java application. It does this by starting a Java runtime environment, loading a specified class, and invoking that class's \f3main\fP method. -.LP -.LP -The method must be declared public and static, it must not return any value, and it must accept a \f2String\fP array as a parameter. The method declaration must look like the following: -.LP -.nf -\f3 -.fl -public static void main(String args[]) -.fl -\fP -.fi -.LP -.LP -By default, the first non\-option argument is the name of the class to be invoked. A fully\-qualified class name should be used. If the \f3\-jar\fP option is specified, the first non\-option argument is the name of a \f3JAR\fP archive containing class and resource files for the application, with the startup class indicated by the \f3Main\-Class\fP manifest header. -.LP -.LP -The Java runtime searches for the startup class, and other classes used, in three sets of locations: the bootstrap class path, the installed extensions, and the user class path. -.LP -.LP -Non\-option arguments after the class name or JAR file name are passed to the \f3main\fP function. -.LP -.SH "OPTIONS" -.LP -.LP -The launcher has a set of standard options that are supported on the current runtime environment and will be supported in future releases. In addition, the current implementations of the virtual machines support a set of non\-standard options that are subject to change in future releases. -.LP -.SH "Standard Options" -.LP -.RS 3 -.TP 3 -\-client -Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM. -.br -.br -For default VM selection, see -.na -\f2Server\-Class Machine Detection\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html -.TP 3 -\-server -Select the Java HotSpot Server VM. On a 64\-bit capable jdk only the Java Hotspot Server VM is supported so the \-server option is implicit. -.br -.br -For default VM selection, see -.na -\f2Server\-Class Machine Detection\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html -.TP 3 -\-agentlib:libname[=options] -Load native agent library \f2libname\fP, e.g. -.br -.br -\-agentlib:hprof -.br -.br -\-agentlib:jdwp=help -.br -.br -\-agentlib:hprof=help -.br -.br -For more information, see -.na -\f2JVMTI Agent Command Line Options\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting. -.TP 3 -\-agentpath:pathname[=options] -Load a native agent library by full pathname. For more information, see -.na -\f2JVMTI Agent Command Line Options\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting. -.TP 3 -\-classpath classpath -.TP 3 -\-cp classpath -Specify a list of directories, JAR archives, and ZIP archives to search for class files. Class path entries are separated by colons (\f3:\fP). Specifying \f3\-classpath\fP or \f3\-cp\fP overrides any setting of the \f3CLASSPATH\fP environment variable. -.br -.br -If \f3\-classpath\fP and \f3\-cp\fP are not used and \f3CLASSPATH\fP is not set, the user class path consists of the current directory (\f4.\fP). -.br -.br -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations). -.br -.br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.br -.br -For more information on class paths, see -.na -\f2Setting the Class Path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath. -.TP 3 -\-Dproperty=value -Set a system property value. -.TP 3 -\-d32 -.TP 3 -\-d64 -Request that the program to be run in a 32\-bit or 64\-bit environment, respectively. If the requested environment is not installed or is not supported, an error is reported. -.br -.br -Currently only the Java HotSpot Server VM supports 64\-bit operation, and the "\-server" option is implicit with the use of \-d64. And the "\-client" option is ignored with the use of \-d64. This is subject to change in a future release. -.br -.br -If neither \f3\-d32\fP nor \f3\-d64\fP is specified, the default is to run in a 32\-bit environment, except for 64\-bit only systems. This is subject to change in a future release. -.TP 3 -\-enableassertions[:<package name>"..." | :<class name> ] -.TP 3 -\-ea[:<package name>"..." | :<class name> ] -Enable assertions. Assertions are disabled by default. -.br -.br -With no arguments, \f3enableassertions\fP or \f3\-ea\fP enables assertions. With one argument ending in \f2"..."\fP, the switch enables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch enables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch enables assertions in the specified class. -.br -.br -If a single command line contains multiple instances of these switches, they are processed in order before loading any classes. So, for example, to run a program with assertions enabled only in package \f2com.wombat.fruitbat\fP (and any subpackages), the following command could be used: -.nf -\f3 -.fl -java \-ea:com.wombat.fruitbat... <Main Class> -.fl -\fP -.fi -The \f3\-enableassertions\fP and \f3\-ea\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-enablesystemassertions\fP below. -.TP 3 -\-disableassertions[:<package name>"..." | :<class name> ] -.TP 3 -\-da[:<package name>"..." | :<class name> ] -Disable assertions. This is the default. -.br -.br -With no arguments, \f3disableassertions\fP or \f3\-da\fP disables assertions. With one argument ending in \f2"..."\fP, the switch disables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch disables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch disables assertions in the specified class. -.br -.br -To run a program with assertions enabled in package \f2com.wombat.fruitbat\fP but disabled in class \f2com.wombat.fruitbat.Brickbat\fP, the following command could be used: -.nf -\f3 -.fl -java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat \fP\f4<Main Class>\fP\f3 -.fl -\fP -.fi -The \f3\-disableassertions\fP and \f3\-da\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-disablesystemassertions\fP below. -.TP 3 -\-enablesystemassertions -.TP 3 -\-esa -Enable asserts in all system classes (sets the \f2default assertion status\fP for system classes to \f2true\fP). -.TP 3 -\-disablesystemassertions -.TP 3 -\-dsa -Disables asserts in all system classes. -.TP 3 -\-jar -Execute a program encapsulated in a JAR file. The first argument is the name of a JAR file instead of a startup class name. In order for this option to work, the manifest of the JAR file must contain a line of the form \f3Main\-Class: \fP\f4classname\fP. Here, \f2classname\fP identifies the class having the \f2public\ static\ void\ main(String[]\ args)\fP method that serves as your application's starting point. See the jar(1) and the Jar trail of the -.na -\f2Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar for information about working with Jar files and Jar\-file manifests. -.br -.br -When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored. -.br -.br -Note that JAR files that can be run with the "java \-jar" option can have their execute permissions set so they can be run without using "java \-jar". Refer to -.na -\f2Java Archive (JAR) Files\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/index.html. -.TP 3 -\-javaagent:jarpath[=options] -Load a Java programming language agent, see -.na -\f2java.lang.instrument\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/lang/instrument/package\-summary.html. -.TP 3 -\-jre\-restrict\-search -Include user\-private JREs in the version search. -.TP 3 -\-no\-jre\-restrict\-search -Exclude user\-private JREs in the version search. -.TP 3 -\-verbose -.TP 3 -\-verbose:class -Display information about each class loaded. -.TP 3 -\-verbose:gc -Report on each garbage collection event. -.TP 3 -\-verbose:jni -Report information about use of native methods and other Java Native Interface activity. -.TP 3 -\-version -Display version information and exit. -.TP 3 -\-version:release -Specifies that the version specified by \f2release\fP is required by the class or jar file specified on the command line. If the version of the java command invoked does not meet this specification and an appropriate implementation is found on the system, the appropriate implementation will be used. -.br -.br -\f2release\fP not only can specify an exact version, but can also specify a list of versions called a version string. A version string is an ordered list of version ranges separated by spaces. A version range is either a version\-id, a version\-id followed by a star (*), a version\-id followed by a plus sign (+) , or two version\-ranges combined using an ampersand (&). The star means prefix match, the plus sign means this version or greater, and the ampersand means the logical anding of the two version\-ranges. For example: -.nf -\f3 -.fl -\-version:"1.6.0_13 1.6*&1.6.0_10+" -.fl -\fP -.fi -The meaning of the above is that the class or jar file requires either version 1.6.0_13, or a version with 1.6 as a version\-id prefix and that is not less than 1.6.0_10.. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56). -.br -.br -For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line. -.br -.br -See the following NOTES section for important policy information on the use of this option. -.TP 3 -\-showversion -Display version information and continue. -.TP 3 -\-? -.TP 3 -\-help -Display usage information and exit. -.TP 3 -\-splash:imagepath -Show splash screen with image specified by \f2imagepath\fP. -.TP 3 -\-X -Display information about non\-standard options and exit. +This option is equivalent to \f3-XX:ThreadStackSize\fR\&. + .RE +.TP +-Xusealtsigs +.br +Use alternative signals instead of \f3SIGUSR1\fR and \f3SIGUSR2\fR for JVM internal signals\&. This option is equivalent to \f3-XX:+UseAltSigs\fR\&. +.TP +-Xverify:\fImode\fR +.br +Sets the mode of the bytecode verifier\&. Bytecode verification helps to troubleshoot some problems, but it also adds overhead to the running application\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +none +Do not verify the bytecode\&. This reduces startup time and also reduces the protection provided by Java\&. +.TP +remote +Verify only those classes that are loaded remotely over the network\&. This is the default behavior if you do not specify the \f3-Xverify\fR option\&. +.TP +all +Verify all classes\&. +.RE -.LP -.SS -Non\-Standard Options -.LP -.RS 3 -.TP 3 -\-Xint -Operate in interpreted\-only mode. Compilation to native code is disabled, and all bytecodes are executed by the interpreter. The performance benefits offered by the Java HotSpot VMs' adaptive compiler will not be present in this mode. -.TP 3 -\-Xbatch -Disable background compilation. Normally the VM will compile the method as a background task, running the method in interpreter mode until the background compilation is finished. The \f2\-Xbatch\fP flag disables background compilation so that compilation of all methods proceeds as a foreground task until completed. -.TP 3 -\-Xbootclasspath:bootclasspath -Specify a colon\-separated list of directories, JAR archives, and ZIP archives to search for boot class files. These are used in place of the boot class files included in the Java platform JDK. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java Runtime Environment binary code license.\fP -.TP 3 -\-Xbootclasspath/a:path -Specify a colon\-separated path of directires, JAR archives, and ZIP archives to append to the default bootstrap class path. -.TP 3 -\-Xbootclasspath/p:path -Specify a colon\-separated path of directires, JAR archives, and ZIP archives to prepend in front of the default bootstrap class path. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java Runtime Environment binary code license.\fP -.TP 3 -\-Xcheck:jni -Perform additional checks for Java Native Interface (JNI) functions. Specifically, the Java Virtual Machine validates the parameters passed to the JNI function as well as the runtime environment data before processing the JNI request. Any invalid data encountered indicates a problem in the native code, and the Java Virtual Machine will terminate with a fatal error in such cases. Expect a performance degradation when this option is used. -.TP 3 -\-Xfuture -Perform strict class\-file format checks. For purposes of backwards compatibility, the default format checks performed by the JDK's virtual machine are no stricter than the checks performed by 1.1.x versions of the JDK software. The \f3\-Xfuture\fP flag turns on stricter class\-file format checks that enforce closer conformance to the class\-file format specification. Developers are encouraged to use this flag when developing new code because the stricter checks will become the default in future releases of the Java application launcher. -.TP 3 -\-Xnoclassgc -Disable class garbage collection. Use of this option will prevent memory recovery from loaded classes thus increasing overall memory usage. This could cause OutOfMemoryError to be thrown in some applications. -.TP 3 -\-Xincgc -Enable the incremental garbage collector. The incremental garbage collector, which is off by default, will reduce the occasional long garbage\-collection pauses during program execution. The incremental garbage collector will at times execute concurrently with the program and during such times will reduce the processor capacity available to the program. -.TP 3 -\-Xloggc:file -Report on each garbage collection event, as with \-verbose:gc, but log this data to \f2file\fP. In addition to the information \f2\-verbose:gc\fP gives, each reported event will be preceeded by the time (in seconds) since the first garbage\-collection event. +.SS ADVANCED\ RUNTIME\ OPTIONS +These options control the runtime behavior of the Java HotSpot VM\&. +.TP +-XX:+DisableAttachMechanism .br +Enables the option that disables the mechanism that lets tools attach to the JVM\&. By default, this option is disabled, meaning that the attach mechanism is enabled and you can use tools such as \f3jcmd\fR, \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR\&. +.TP +-XX:ErrorFile=\fIfilename\fR .br -Always use a local file system for storage of this file to avoid stalling the JVM due to network latency. The file may be truncated in the case of a full file system and logging will continue on the truncated file. This option overrides \f2\-verbose:gc\fP if both are given on the command line. -.TP 3 -\-Xmsn -Specify the initial size, in bytes, of the memory allocation pool. This value must be a multiple of 1024 greater than 1MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see -.na -\f2HotSpot Ergonomics\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html -.br -.br -Examples: -.nf -\f3 -.fl - \-Xms6291456 -.fl - \-Xms6144k -.fl - \-Xms6m -.fl +Specifies the path and file name to which error data is written when an irrecoverable error occurs\&. By default, this file is created in the current working directory and named \f3hs_err_pid\fR\fIpid\fR\f3\&.log\fR where \fIpid\fR is the identifier of the process that caused the error\&. The following example shows how to set the default log file (note that the identifier of the process is specified as \f3%p\fR): +.sp +.nf +\f3\-XX:ErrorFile=\&./hs_err_pid%p\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -\fP -.fi -.TP 3 -\-Xmxn -Specify the maximum size, in bytes, of the memory allocation pool. This value must a multiple of 1024 greater than 2MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see -.na -\f2HotSpot Ergonomics\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html -.br -.br -Examples: -.nf -\f3 -.fl - \-Xmx83886080 -.fl - \-Xmx81920k -.fl - \-Xmx80m -.fl -.fl -\fP -.fi -On Solaris 7 and Solaris 8 SPARC platforms, the upper limit for this value is approximately 4000m minus overhead amounts. On Solaris 2.6 and x86 platforms, the upper limit is approximately 2000m minus overhead amounts. On Linux platforms, the upper limit is approximately 2000m minus overhead amounts. -.TP 3 -\-Xprof -Profiles the running program, and sends profiling data to standard output. This option is provided as a utility that is useful in program development and is not intended to be used in production systems. -.TP 3 -\-Xrs -Reduces use of operating\-system signals by the Java virtual machine (JVM). +The following example shows how to set the error log to \f3/var/log/java/java_error\&.log\fR: +.sp +.nf +\f3\-XX:ErrorFile=/var/log/java/java_error\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the file cannot be created in the specified directory (due to insufficient space, permission problem, or another issue), then the file is created in the temporary directory for the operating system\&. The temporary directory is \f3/tmp\fR\&. +.TP +-XX:LargePageSizeInBytes=\fIsize\fR .br +Sets the maximum size (in bytes) for large pages used for Java heap\&. The \fIsize\fR argument must be a power of 2 (2, 4, 8, 16, \&.\&.\&.)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the size is set to 0, meaning that the JVM chooses the size for large pages automatically\&. + +The following example illustrates how to set the large page size to 4 megabytes (MB): +.sp +.nf +\f3\-XX:LargePageSizeInBytes=4m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxDirectMemorySize=\fIsize\fR .br -In a previous release, the Shutdown Hooks facility was added to allow orderly shutdown of a Java application. The intent was to allow user cleanup code (such as closing database connections) to run at shutdown, even if the JVM terminates abruptly. +Sets the maximum total size (in bytes) of the New I/O (the \f3java\&.nio\fR package) direct-buffer allocations\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the size is set to 0, meaning that the JVM chooses the size for NIO direct-buffer allocations automatically\&. + +The following examples illustrate how to set the NIO size to 1024 KB in different units: +.sp +.nf +\f3\-XX:MaxDirectMemorySize=1m\fP +.fi +.nf +\f3\-XX:MaxDirectMemorySize=1024k\fP +.fi +.nf +\f3\-XX:MaxDirectMemorySize=1048576\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NativeMemoryTracking=\fImode\fR .br +Specifies the mode for tracking JVM native memory usage\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +off +Do not track JVM native memory usage\&. This is the default behavior if you do not specify the \f3-XX:NativeMemoryTracking\fR option\&. +.TP +summary +Only track memory usage by JVM subsystems, such as Java heap, class, code, and thread\&. +.TP +detail +In addition to tracking memory usage by JVM subsystems, track memory usage by individual \f3CallSite\fR, individual virtual memory region and its committed regions\&. +.RE + +.TP +-XX:OnError=\fIstring\fR .br -Sun's JVM catches signals to implement shutdown hooks for abnormal JVM termination. The JVM uses SIGHUP, SIGINT, and SIGTERM to initiate the running of shutdown hooks. +Sets a custom command or a series of semicolon-separated commands to run when an irrecoverable error occurs\&. If the string contains spaces, then it must be enclosed in quotation marks\&. + +\fI\fRThe following example shows how the \f3-XX:OnError\fR option can be used to run the \f3gcore\fR command to create the core image, and the debugger is started to attach to the process in case of an irrecoverable error (the \f3%p\fR designates the current process): +.sp +.nf +\f3\-XX:OnError="gcore %p;dbx \- %p"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:OnOutOfMemoryError=\fIstring\fR .br +Sets a custom command or a series of semicolon-separated commands to run when an \f3OutOfMemoryError\fR exception is first thrown\&. If the string contains spaces, then it must be enclosed in quotation marks\&. For an example of a command string, see the description of the \f3-XX:OnError\fR option\&. +.TP +-XX:+PrintCommandLineFlags .br -The JVM uses a similar mechanism to implement the pre\-1.2 feature of dumping thread stacks for debugging purposes. Sun's JVM uses SIGQUIT to perform thread dumps. +Enables printing of ergonomically selected JVM flags that appeared on the command line\&. It can be useful to know the ergonomic values set by the JVM, such as the heap space size and the selected garbage collector\&. By default, this option is disabled and flags are not printed\&. +.TP +-XX:+PrintNMTStatistics .br +Enables printing of collected native memory tracking data at JVM exit when native memory tracking is enabled (see \f3-XX:NativeMemoryTracking\fR)\&. By default, this option is disabled and native memory tracking data is not printed\&. +.TP +-XX:+ShowMessageBoxOnError .br -Applications embedding the JVM frequently need to trap signals like SIGINT or SIGTERM, which can lead to interference with the JVM's own signal handlers. The \f3\-Xrs\fP command\-line option is available to address this issue. When \f3\-Xrs\fP is used on Sun's JVM, the signal masks for SIGINT, SIGTERM, SIGHUP, and SIGQUIT are not changed by the JVM, and signal handlers for these signals are not installed. +Enables displaying of a dialog box when the JVM experiences an irrecoverable error\&. This prevents the JVM from exiting and keeps the process active so that you can attach a debugger to it to investigate the cause of the error\&. By default, this option is disabled\&. +.TP +-XX:ThreadStackSize=\fIsize\fR .br -.br -There are two consequences of specifying \f3\-Xrs\fP: -.RS 3 -.TP 2 -o -SIGQUIT thread dumps are not available. -.TP 2 -o -User code is responsible for causing shutdown hooks to run, for example by calling System.exit() when the JVM is to be terminated. -.RE -.TP 3 -\-Xssn -Set thread stack size. -.TP 3 -\-XX:+UseAltSigs -The VM uses \f2SIGUSR1\fP and \f2SIGUSR2\fP by default, which can sometimes conflict with applications that signal\-chain \f2SIGUSR1\fP and \f2SIGUSR2\fP. The \f2\-XX:+UseAltSigs\fP option will cause the VM to use signals other than \f2SIGUSR1\fP and \f2SIGUSR2\fP as the default. +Sets the thread stack size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value depends on the platform: +.RS +.TP 0.2i +\(bu +Linux/ARM (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +OS X (64-bit): 1024 KB +.TP 0.2i +\(bu +Oracle Solaris/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Oracle Solaris/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +Windows: depends on virtual memory .RE +.RS +The following examples show how to set the thread stack size to 1024 KB in different units: +.sp +.nf +\f3\-XX:ThreadStackSize=1m\fP +.fi +.nf +\f3\-XX:ThreadStackSize=1024k\fP +.fi +.nf +\f3\-XX:ThreadStackSize=1048576\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "NOTES" -.LP -.LP -The \f3\-version:\fP\f2release\fP command line option places no restrictions on the complexity of the release specification. However, only a restricted subset of the possible release specifications represent sound policy and only these are fully supported. These policies are: -.LP -.RS 3 -.TP 3 -1. -Any version, represented by not using this option. -.TP 3 -2. -Any version greater than an arbitrarily precise version\-id. For example: + +This option is equivalent to \f3-Xss\fR\&. + +.RE +.TP +-XX:+TraceClassLoading +.br +Enables tracing of classes as they are loaded\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceClassLoadingPreorder +.br +Enables tracing of all loaded classes in the order in which they are referenced\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceClassResolution +.br +Enables tracing of constant pool resolutions\&. By default, this option is disabled and constant pool resolutions are not traced\&. +.TP +-XX:+TraceClassUnloading +.br +Enables tracing of classes as they are unloaded\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceLoaderConstraints +.br +Enables tracing of the loader constraints recording\&. By default, this option is disabled and loader constraints recoding is not traced\&. +.TP +-XX:+UseAltSigs +.br +Enables the use of alternative signals instead of \f3SIGUSR1\fR and \f3SIGUSR2\fR for JVM internal signals\&. By default, this option is disabled and alternative signals are not used\&. This option is equivalent to \f3-Xusealtsigs\fR\&. +.TP +-XX:+UseBiasedLocking +.br +Enables the use of biased locking\&. Some applications with significant amounts of uncontended synchronization may attain significant speedups with this flag enabled, whereas applications with certain patterns of locking may see slowdowns\&. For more information about the biased locking technique, see the example in Java Tuning White Paper at http://www\&.oracle\&.com/technetwork/java/tuning-139912\&.html#section4\&.2\&.5 + +By default, this option is disabled and biased locking is not used\&. +.TP +-XX:+UseCompressedOops +.br +Enables the use of compressed pointers\&. When this option is enabled, object references are represented as 32-bit offsets instead of 64-bit pointers, which typically increases performance when running the application with Java heap sizes less than 32 GB\&. This option works only for 64-bit JVMs\&. + +By default, this option is disabled and compressed pointers are not used\&. +.TP +-XX:+UseLargePages +.br +Enables the use of large page memory\&. This option is enabled by default\&. To disable the use of large page memory, specify \f3-XX:-UseLargePages\fR\&. + +For more information, see Java Support for Large Memory Pages at http://www\&.oracle\&.com/technetwork/java/javase/tech/largememory-jsp-137182\&.html +.TP +-XX:+UseMembar +.br +Enables issuing of membars on thread state transitions\&. This option is disabled by default on all platforms except Power PC and ARM servers, where it is enabled\&. To disable issuing of membars on thread state transitions for Power PC and ARM, specify \f3-XX:-UseMembar\fR\&. +.TP +-XX:+UsePerfData +.br +Enables the \f3perfdata\fR feature\&. This option is enabled by default to allow JVM monitoring and performance testing\&. Disabling it suppresses the creation of the \f3hsperfdata_userid\fR directories\&. To disable the \f3perfdata\fR feature, specify \f3-XX:-UsePerfData\fR\&. +.TP +-XX:+AllowUserSignalHandlers +.br +Enables installation of signal handlers by the application\&. By default, this option is disabled and the application is not allowed to install signal handlers\&. +.SS ADVANCED\ JIT\ COMPILER\ OPTIONS +These options control the dynamic just-in-time (JIT) compilation performed by the Java HotSpot VM\&. +.TP +-XX:+AggressiveOpts +.br +Enables the use of aggressive performance optimization features, which are expected to become default in upcoming releases\&. By default, this option is disabled and experimental performance features are not used\&. +.TP +-XX:AllocateInstancePrefetchLines=\fIlines\fR +.br +Sets the number of lines to prefetch ahead of the instance allocation pointer\&. By default, the number of lines to prefetch is set to 1: +.sp +.nf +\f3\-XX:AllocateInstancePrefetchLines=1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchInstr=\fIinstruction\fR +.br +Sets the prefetch instruction to prefetch ahead of the allocation pointer\&. Possible values are from 0 to 3\&. The actual instructions behind the values depend on the platform\&. By default, the prefetch instruction is set to 0: +.sp +.nf +\f3\-XX:AllocatePrefetchInstr=0\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchStepSize=\fIsize\fR +.br +Sets the step size (in bytes) for sequential prefetch instructions\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the step size is set to 16 bytes: +.sp +.nf +\f3\-XX:AllocatePrefetchStepSize=16\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+BackgroundCompilation +.br +Enables background compilation\&. This option is enabled by default\&. To disable background compilation, specify \f3-XX:-BackgroundCompilation\fR (this is equivalent to specifying \f3-Xbatch\fR)\&. +.TP +-XX:CICompilerCount=\fIthreads\fR +.br +Sets the number of compiler threads to use for compilation\&. By default, the number of threads is set to 2 for the server JVM, to 1 for the client JVM, and it scales to the number of cores if tiered compilation is used\&. The following example shows how to set the number of threads to 2: +.sp +.nf +\f3\-XX:CICompilerCount=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CodeCacheMinimumFreeSpace=\fIsize\fR +.br +Sets the minimum free space (in bytes) required for compilation\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. When less than the minimum free space remains, compiling stops\&. By default, this option is set to 500 KB\&. The following example shows how to set the minimum free space to 1024 MB: +.sp +.nf +\f3\-XX:CodeCacheMinimumFreeSpace=1024m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP .nf -\f3 -.fl -"1.6.0_10+" -.fl -\fP +-XX:CompileCommand=\fIcommand\fR,\fIclass\fR\&.\fImethod\fR[,\fIoption\fR] +.br .fi -This would utilize any version greater than \f21.6.0_10\fP. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified. -.TP 3 -3. -A version greater than an arbitrarily precise version\-id, bounded by the upper bound of that release family. For example: -.nf -\f3 -.fl -"1.6.0_10+&1.6*" -.fl -\fP -.fi -.TP 3 -4. -"Or" expressions of items 2. or 3. above. For example: -.nf -\f3 -.fl -"1.6.0_10+&1.6* 1.7+" -.fl -\fP -.fi -Similar to item 2. this is useful when a change was introduced in a release (1.7) but also made available in updates to previous releases. -.RE +Attaches a line to the \f3\&.hotspot_compiler\fR file with the command for the specific method of the class\&. For example, to exclude the \f3indexOf()\fR method of the \f3String\fR class from being compiled, use the following: +.sp +.nf +\f3\-XX:CompileCommand=exclude,java/lang/String\&.indexOf\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are generally returned by the launcher, typically when the launcher is called with the wrong arguments, serious errors, or exceptions thrown from the Java Virtual Machine. However, a Java application may choose to return any value using the API call \f2System.exit(exitValue)\fP. -.LP -.RS 3 -.TP 2 -o -\f20\fP: Successful completion -.TP 2 -o -\f2>0\fP: An error occurred -.RE -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -javac(1) -.TP 2 -o -jdb(1) -.TP 2 -o -javah(1) -.TP 2 -o -jar(1) -.TP 2 -o -.na -\f2The Java Extensions Framework\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html -.TP 2 -o -.na -\f2Security Features\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/index.html. -.TP 2 -o -.na -\f2HotSpot VM Specific Options\fP @ -.fi -http://java.sun.com/docs/hotspot/VMOptions.html. -.RE +Note that you must specify the full class name, including all packages and subpackages separated by a slash (\f3/\fR)\&. -.LP - +To add several commands, either specify this option multiple times, or separate each argument with the newline separator (\f3\en\fR)\&. To better understand the syntax of the JVM compiler commands, refer to the description of the \f3-XX:CompileCommandFile\fR option, which enables you to specify the file from which to read compiler commands\&. Notice how the syntax of the command file differs rom the syntax of the argument for the \f3-XX:CompileCommand\fR option\&. The commas and periods in the argument are aliases for spaces in the command file, making it easier to pass compiler commands through a shell\&. To pass arguments to \f3-XX:CompileCommand\fR with the same syntax as that used in the command file, you can enclose the argument in quotation marks: +.sp +.nf +\f3\-XX:CompileCommand="exclude java/lang/String indexOf"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +For easier cut and paste operations, it is also possible to use the method name format produced by the \f3-XX:+PrintCompilation\fR and \f3-XX:+LogCompilation\fR options: +.sp +.nf +\f3\-XX:CompileCommand="exclude java\&.lang\&.String::indexOf"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands are available: +.RS +.TP +break +Set a breakpoint when debugging the JVM to stop at the beginning of compilation of the specified method\&. +.TP +compileonly +Exclude all methods from compilation except for the specified method\&. +.TP +dontinline +Prevent inlining of the specified method\&. +.TP +exclude +Exclude the specified method from compilation\&. +.TP +help +Print a help message for the \f3-XX:CompileCommand\fR option\&. +.TP +inline +Attempt to inline the specified method\&. +.TP +log +Exclude compilation logging (with the \f3-XX:+LogCompilation\fR option) for all methods except for the specified method\&. By default, logging is performed for all compiled methods\&. +.TP +print +Print generated assembler code after compilation of the specified method\&. +.TP +quiet +Do not print the compile commands\&. By default, the commands that you specify with the -\f3XX:CompileCommand\fR option are printed; for example, if you exclude from compilation the \f3indexOf()\fR method of the \f3String\fR class, then the following will be printed to standard output: +.sp +.nf +\f3CompilerOracle: exclude java/lang/String\&.indexOf\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can suppress this by specifying the \f3-XX:CompileCommand=quiet\fR option before other \f3-XX:CompileCommand\fR options\&. +.RE + + +.RS +The optional last argument (\fIoption\fR) can be used to pass a JIT compilation option to the specified method\&. The compilation option is set at the end, after the method name\&. For example, to enable the \f3BlockLayoutByFrequency\fR option for the \f3append()\fR method of the \f3StringBuffer\fR class, use the following: +.sp +.nf +\f3\-XX:CompileCommand=option,java/lang/StringBuffer\&.append,BlockLayoutByFrequency\fP +.fi +.nf +\f3\fP +.fi +.sp + + +.RE +.TP +-XX:CompileCommandFile=\fIfilename\fR +.br +Sets the file from which compiler commands are read\&. By default, the \f3\&.hotspot_compiler\fR file is used to store commands performed by the JVM compiler\&. + +Each line in the command file represents a command, a class name, and a method name for which the command is used (all three parts are separated by spaces)\&. For example, this line prints assembly code for the \f3toString()\fR method of the \f3String\fR class: +.sp +.nf +\f3print java/lang/String toString\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To add commands to the beginning of the \f3\&.hotspot_compiler\fR file, use the \f3-XX:CompileCommand\fR option\&. Note how the syntax of the command file is different from the syntax of the argument for the \f3-XX:CompileCommand\fR option\&. The commas and periods in the argument are aliases for spaces in the command file, making it easier to pass compiler commands through a shell\&. Although it is possible to pass arguments to \f3-XX:CompileCommand\fR with the same syntax as that used in the command file, you would have to enclose the string argument in quotation marks\&. +.TP +-XX:CompileOnly=\fImethods\fR +.br +Sets the list of methods (separated by commas) to which compilation should be restricted\&. Only the specified methods will be compiled\&. Specify each method with the full class name (including the packages and subpackages)\&. For example, to compile only the \f3length()\fR method of the \f3String\fR class and the \f3size()\fR method of the \f3List\fR class, use the following: +.sp +.nf +\f3\-XX:CompileOnly=java/lang/String\&.length,java/util/List\&.size\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CompileThreshold=\fIinvocations\fR +.br +Sets the number of interpreted method invocations before compilation\&. By default, in the server JVM, the JIT compiler performs 10,000 interpreted method invocations to gather information for efficient compilation\&. For the client JVM, the default setting is 1,500 invocations\&. The following example shows how to set the number of interpreted method invocations to 5,000: +.sp +.nf +\f3\-XX:CompileThreshold=5000\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can completely disable interpretation of Java methods before compilation by specifying the \f3-Xcomp\fR option\&. +.TP +-XX:+DoEscapeAnalysis +.br +Enables the use of escape analysis\&. This option is enabled by default\&. To disable the use of escape analysis, specify \f3-XX:-DoEscapeAnalysis\fR\&. +.TP +-XX:+FailOverToOldVerifier +.br +Enables automatic failover to the old verifier when the new type checker fails\&. By default, this option is disabled and it is ignored (that is, treated as disabled) for classes with a recent bytecode version\&. You can enable it for classes with older versions of the bytecode\&. +.TP +-XX:InitialCodeCacheSize=\fIsize\fR +.br +Sets the initial code cache size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is set to 500 KB\&. The following example shows how to set the initial code cache size to 32 KB: +.sp +.nf +\f3\-XX:InitialCodeCacheSize=32k\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+Inline +.br +Enables method inlining\&. This option is enabled by default to increase performance\&. To disable method inlining, specify \f3-XX:-Inline\fR\&. +.TP +-XX:InlineSmallCode=\fIsize\fR +.br +Sets the maximum code size (in bytes) for compiled methods that should be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. Only compiled methods with the size smaller than the specified size will be inlined\&. By default, the maximum code size is set to 1000 bytes: +.sp +.nf +\f3\-XX:InlineSmallCode=1000\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+LogCompilation +.br +Enables logging of compilation activity to a file named \f3hotspot\&.log\fR in the current working directory\&. You can specify a different log file path and name using the \f3-XX:LogFile\fR option\&. + +By default, this option is disabled and compilation activity is not logged\&. The \f3-XX:+LogCompilation\fR option has to be used together with the \f3-XX:UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. + +You can enable verbose diagnostic output with a message printed to the console every time a method is compiled by using the \f3-XX:+PrintCompilation\fR option\&. +.TP +-XX:MaxInlineSize=\fIsize\fR +.br +Sets the maximum bytecode size (in bytes) of a method to be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the maximum bytecode size is set to 35 bytes: +.sp +.nf +\f3\-XX:MaxInlineSize=35\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxNodeLimit=\fInodes\fR +.br +Sets the maximum number of nodes to be used during single method compilation\&. By default, the maximum number of nodes is set to 65,000: +.sp +.nf +\f3\-XX:MaxNodeLimit=65000\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxTrivialSize=\fIsize\fR +.br +Sets the maximum bytecode size (in bytes) of a trivial method to be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the maximum bytecode size of a trivial method is set to 6 bytes: +.sp +.nf +\f3\-XX:MaxTrivialSize=6\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+OptimizeStringConcat +.br +Enables the optimization of \f3String\fR concatenation operations\&. This option is enabled by default\&. To disable the optimization of \f3String\fR concatenation operations, specify \f3-XX:-OptimizeStringConcat\fR\&. +.TP +-XX:+PrintAssembly +.br +Enables printing of assembly code for bytecoded and native methods by using the external \f3disassembler\&.so\fR library\&. This enables you to see the generated code, which may help you to diagnose performance issues\&. + +By default, this option is disabled and assembly code is not printed\&. The \f3-XX:+PrintAssembly\fR option has to be used together with the \f3-XX:UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. +.TP +-XX:+PrintCompilation +.br +Enables verbose diagnostic output from the JVM by printing a message to the console every time a method is compiled\&. This enables you to see which methods actually get compiled\&. By default, this option is disabled and diagnostic output is not printed\&. + +You can also log compilation activity to a file by using the \f3-XX:+LogCompilation\fR option\&. +.TP +-XX:+PrintInlining +.br +Enables printing of inlining decisions\&. This enables you to see which methods are getting inlined\&. + +By default, this option is disabled and inlining information is not printed\&. The \f3-XX:+PrintInlining\fR option has to be used together with the \f3-XX:+UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. +.TP +-XX:+RelaxAccessControlCheck +.br +Decreases the amount of access control checks in the verifier\&. By default, this option is disabled, and it is ignored (that is, treated as disabled) for classes with a recent bytecode version\&. You can enable it for classes with older versions of the bytecode\&. +.TP +-XX:ReservedCodeCacheSize=\fIsize\fR +.br +Sets the maximum code cache size (in bytes) for JIT-compiled code\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. This option is equivalent to \f3-Xmaxjitcodesize\fR\&. +.TP +-XX:+TieredCompilation +.br +Enables the use of tiered compilation\&. By default, this option is disabled and tiered compilation is not used\&. +.TP +-XX:+UseCodeCacheFlushing +.br +Enables flushing of the code cache before shutting down the compiler\&. This option is enabled by default\&. To disable flushing of the code cache before shutting down the compiler, specify \f3-XX:-UseCodeCacheFlushing\fR\&. +.TP +-XX:+UseCondCardMark +.br +Enables checking of whether the card is already marked before updating the card table\&. This option is disabled by default and should only be used on machines with multiple sockets, where it will increase performance of Java applications that rely heavily on concurrent operations\&. +.TP +-XX:+UseSuperWord +.br +Enables the transformation of scalar operations into superword operations\&. This option is enabled by default\&. To disable the transformation of scalar operations into superword operations, specify \f3-XX:-UseSuperWord\fR\&. +.SS ADVANCED\ SERVICEABILITY\ OPTIONS +These options provide the ability to gather system information and perform extensive debugging\&. +.TP +-XX:+ExtendedDTraceProbes +.br +Enables additional \f3dtrace\fR tool probes that impact the performance\&. By default, this option is disabled and \f3dtrace\fR performs only standard probes\&. +.TP +-XX:+HeapDumpOnOutOfMemory +.br +Enables the dumping of the Java heap to a file in the current directory by using the heap profiler (HPROF) when a \f3java\&.lang\&.OutOfMemoryError\fR exception is thrown\&. You can explicitly set the heap dump file path and name using the \f3-XX:HeapDumpPath\fR option\&. By default, this option is disabled and the heap is not dumped when an \f3OutOfMemoryError\fR exception is thrown\&. +.TP +-XX:HeapDumpPath=\fIpath\fR +.br +Sets the path and file name for writing the heap dump provided by the heap profiler (HPROF) when the \f3-XX:+HeapDumpOnOutOfMemoryError\fR option is set\&. By default, the file is created in the current working directory, and it is named \f3java_pid\fR\fIpid\fR\f3\&.hprof\fR where \fIpid\fR is the identifier of the process that caused the error\&. The following example shows how to set the default file explicitly (\f3%p\fR represents the current process identificator): +.sp +.nf +\f3\-XX:HeapDumpPath=\&./java_pid%p\&.hprof\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fI\fRThe following example shows how to set the heap dump file to \f3/var/log/java/java_heapdump\&.hprof\fR: +.sp +.nf +\f3\-XX:HeapDumpPath=/var/log/java/java_heapdump\&.hprof\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:LogFile=\fIpath\fR +.br +Sets the path and file name where log data is written\&. By default, the file is created in the current working directory, and it is named \f3hotspot\&.log\fR\&. + +\fI\fRThe following example shows how to set the log file to \f3/var/log/java/hotspot\&.log\fR: +.sp +.nf +\f3\-XX:LogFile=/var/log/java/hotspot\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+PrintClassHistogram +.br +\fI\fREnables printing of a class instance histogram after a \f3Control+C\fR event (\f3SIGTERM\fR)\&. By default, this option is disabled\&. + +Setting this option is equivalent to running the \f3jmap -histo\fR command, or the \f3jcmd\fR\fIpid\fR\f3GC\&.class_histogram\fR command, where \fIpid\fR is the current Java process identifier\&. +.TP +-XX:+PrintConcurrentLocks + + +Enables printing of j\f3ava\&.util\&.concurrent\fR locks after a \f3Control+C\fR event (\f3SIGTERM\fR)\&. By default, this option is disabled\&. + +Setting this option is equivalent to running the \f3jstack -l\fR command or the \f3jcmd\fR\fIpid\fR\f3Thread\&.print -l\fR command, where \fIpid\fR is the current Java process identifier\&. +.TP +-XX:+UnlockDiagnosticVMOptions +.br +Unlocks the options intended for diagnosing the JVM\&. By default, this option is disabled and diagnostic options are not available\&. +.SS ADVANCED\ GARBAGE\ COLLECTION\ OPTIONS +These options control how garbage collection (GC) is performed by the Java HotSpot VM\&. +.TP +-XX:+AggressiveHeap +.br +Enables Java heap optimization\&. This sets various parameters to be optimal for long-running jobs with intensive memory allocation, based on the configuration of the computer (RAM and CPU)\&. By default, the option is disabled and the heap is not optimized\&. +.TP +-XX:AllocatePrefetchDistance=\fIsize\fR +.br +Sets the size (in bytes) of the prefetch distance for object allocation\&. Memory about to be written with the value of new objects is prefetched up to this distance starting from the address of the last allocated object\&. Each Java thread has its own allocation point\&. + +Negative values denote that prefetch distance is chosen based on the platform\&. Positive values are bytes to prefetch\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is set to -1\&. + +The following example shows how to set the prefetch distance to 1024 bytes: +.sp +.nf +\f3\-XX:AllocatePrefetchDistance=1024\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchLines=\fIlines\fR +.br +Sets the number of cache lines to load after the last object allocation by using the prefetch instructions generated in compiled code\&. The default value is 1 if the last allocated object was an instance, and 3 if it was an array\&. + +The following example shows how to set the number of loaded cache lines to 5: +.sp +.nf +\f3\-XX:AllocatePrefetchLines=5\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchStyle=\fIstyle\fR +.br +Sets the generated code style for prefetch instructions\&. The \fIstyle\fR argument is an integer from 0 to 3: +.RS +.TP +0 +Do not generate prefetch instructions\&. +.TP +1 +Execute prefetch instructions after each allocation\&. This is the default parameter\&. +.TP +2 +Use the thread-local allocation block (TLAB) watermark pointer to determine when prefetch instructions are executed\&. +.TP +3 +Use BIS instruction on SPARC for allocation prefetch\&. +.RE + +.TP +-XX:+AlwaysPreTouch +.br +Enables touching of every page on the Java heap during JVM initialization\&. This gets all pages into the memory before entering the \f3main()\fR method\&. The option can be used in testing to simulate a long-running system with all virtual memory mapped to physical memory\&. By default, this option is disabled and all pages are committed as JVM heap space fills\&. +.TP +-XX:+CMSClassUnloadingEnabled +.br +Enables class unloading when using the concurrent mark-sweep (CMS) garbage collector\&. This option is enabled by default\&. To disable class unloading for the CMS garbage collector, specify \f3-XX:-CMSClassUnloadingEnabled\fR\&. +.TP +-XX:CMSExpAvgFactor=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) used to weight the current sample when computing exponential averages for the concurrent collection statistics\&. By default, the exponential averages factor is set to 25%\&. The following example shows how to set the factor to 15%: +.sp +.nf +\f3\-XX:CMSExpAvgFactor=15\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSIncrementalDutyCycle=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) between minor collections that the concurrent collector is allowed to run\&. When \f3-XX:+CMSIncrementalPacing\fR is enabled, the duty cycle is set automatically, and this option sets only the initial value\&. + +By default, the duty cycle is set to 10%\&. The following example shows how to set the duty cycle to 20%: +.sp +.nf +\f3\-XX:CMSIncrementalDutyCycle=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSIncrementalDutyCycleMin=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) between minor collections that is the lower bound for the duty cycle when \f3-XX:+CMSIncrementalPacing\fR is enabled\&. By default, the lower bound for the duty cycle is set to 0%\&. The following example shows how to set the lower bound to 10%: +.sp +.nf +\f3\-XX:CMSIncrementalDutyCycleMin=10\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSIncrementalMode +.br +Enables the incremental mode for the CMS collector\&. This option is disabled by default and should only be enabled for configurations with no more than two GC threads\&. All options that start with \f3CMSIncremental\fR apply only when this option is enabled\&. +.TP +-XX:CMSIncrementalOffset=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) by which the incremental mode duty cycle is shifted to the right within the period between minor collections\&. By default, the offset is set to 0%\&. The following example shows how to set the duty cycle offset to 25%: +.sp +.nf +\f3\-XX:CMSIncrementalOffset=25\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSIncrementalPacing +.br +Enables automatic adjustment of the incremental mode duty cycle based on statistics collected while the JVM is running\&. This option is enabled by default\&. To disable automatic adjustment of the incremental mode duty cycle, specify \f3-XX:-CMSIncrementalPacing\fR\&. +.TP +-XX:CMSIncrementalSafetyFactor=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) used to add conservatism when computing the duty cycle\&. By default, the safety factor is set to 10%\&. The example below shows how to set the safety factor to 5%: +.sp +.nf +\f3\-XX:CMSIncrementalSafetyFactor=5\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSInitiatingOccupancyFraction=\fIpercent\fR +.br +Sets the percentage of the old generation occupancy (0 to 100) at which to start a CMS collection cycle\&. The default value is set to -1\&. Any negative value (including the default) implies that \f3-XX:CMSTriggerRatio\fR is used to define the value of the initiating occupancy fraction\&. + +The following example shows how to set the occupancy fraction to 20%: +.sp +.nf +\f3\-XX:CMSInitiatingOccupancyFraction=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSScavengeBeforeRemark +.br +Enables scavenging attempts before the CMS remark step\&. By default, this option is disabled\&. +.TP +-XX:CMSTriggerRatio=\fIpercent\fR +.br +Sets the percentage (0 to 100) of the value specified by \f3-XX:MinHeapFreeRatio\fR that is allocated before a CMS collection cycle commences\&. The default value is set to 80%\&. + +The following example shows how to set the occupancy fraction to 75%: +.sp +.nf +\f3\-XX:CMSTriggerRatio=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:ConcGCThreads=\fIthreads\fR +.br +Sets the number of threads used for concurrent GC\&. The default value depends on the number of CPUs available to the JVM\&. + +For example, to set the number of threads for concurrent GC to 2, specify the following option: +.sp +.nf +\f3\-XX:ConcGCThreads=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+DisableExplicitGC +.br +Enables the option that disables processing of calls to \f3System\&.gc()\fR\&. This option is disabled by default, meaning that calls to \f3System\&.gc()\fR are processed\&. If processing of calls to \f3System\&.gc()\fR is disabled, the JVM still performs GC when necessary\&. +.TP +-XX:+ExplicitGCInvokesConcurrent +.br +Enables invoking of concurrent GC by using the \f3System\&.gc()\fR request\&. This option is disabled by default and can be enabled only together with the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:+ExplicitGCInvokesConcurrentAndUnloadsClasses +.br +Enables invoking of concurrent GC by using the \f3System\&.gc()\fR request and unloading of classes during the concurrent GC cycle\&. This option is disabled by default and can be enabled only together with the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:G1HeapRegionSize=\fIsize\fR +.br +Sets the size of the regions into which the Java heap is subdivided when using the garbage-first (G1) collector\&. The value can be between 1 MB and 32 MB\&. The default region size is determined ergonomically based on the heap size\&. + +The following example shows how to set the size of the subdivisions to 16 MB: +.sp +.nf +\f3\-XX:G1HeapRegionSize=16m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+G1PrintHeapRegions +.br +Enables the printing of information about which regions are allocated and which are reclaimed by the G1 collector\&. By default, this option is disabled\&. +.TP +-XX:G1ReservePercent=\fIpercent\fR +.br +Sets the percentage of the heap (0 to 50) that is reserved as a false ceiling to reduce the possibility of promotion failure for the G1 collector\&. By default, this option is set to 10%\&. + +The following example shows how to set the reserved heap to 20%: +.sp +.nf +\f3\-XX:G1ReservePercent=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:InitialHeapSize=\fIsize\fR +.br +Sets the initial size (in bytes) of the memory allocation pool\&. This value must be either 0, or a multiple of 1024 and greater than 1 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the size of allocated memory to 6 MB using various units: +.sp +.nf +\f3\-XX:InitialHeapSize=6291456\fP +.fi +.nf +\f3\-XX:InitialHeapSize=6144k\fP +.fi +.nf +\f3\-XX:InitialHeapSize=6m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If you set this option to 0, then the initial size will be set as the sum of the sizes allocated for the old generation and the young generation\&. The size of the heap for the young generation can be set using the \f3-XX:NewSize\fR option\&. +.TP +-XX:InitialSurvivorRatio=\fIratio\fR +.br +Sets the initial survivor space ratio used by the throughput garbage collector (which is enabled by the \f3-XX:+UseParallelGC\fR and/or -\f3XX:+UseParallelOldGC\fR options)\&. Adaptive sizing is enabled by default with the throughput garbage collector by using the \f3-XX:+UseParallelGC\fR and \f3-XX:+UseParallelOldGC\fR options, and survivor space is resized according to the application behavior, starting with the initial value\&. If adaptive sizing is disabled (using the \f3-XX:-UseAdaptiveSizePolicy\fR option), then the \f3-XX:SurvivorRatio\fR option should be used to set the size of the survivor space for the entire execution of the application\&. + +The following formula can be used to calculate the initial size of survivor space (S) based on the size of the young generation (Y), and the initial survivor space ratio (R): +.sp +.nf +\f3S=Y/(R+2)\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The 2 in the equation denotes two survivor spaces\&. The larger the value specified as the initial survivor space ratio, the smaller the initial survivor space size\&. + +By default, the initial survivor space ratio is set to 8\&. If the default value for the young generation space size is used (2 MB), the initial size of the survivor space will be 0\&.2 MB\&. + +The following example shows how to set the initial survivor space ratio to 4: +.sp +.nf +\f3\-XX:InitialSurvivorRatio=4\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:InitiatingHeapOccupancyPercent=\fIpercent\fR +.br +Sets the percentage of the heap occupancy (0 to 100) at which to start a concurrent GC cycle\&. It is used by garbage collectors that trigger a concurrent GC cycle based on the occupancy of the entire heap, not just one of the generations (for example, the G1 garbage collector)\&. + +By default, the initiating value is set to 45%\&. A value of 0 implies nonstop GC cycles\&. The following example shows how to set the initiating heap occupancy to 75%: +.sp +.nf +\f3\-XX:InitiatingHeapOccupancyPercent=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxGCPauseMillis=\fItime\fR +.br +Sets a target for the maximum GC pause time (in milliseconds)\&. This is a soft goal, and the JVM will make its best effort to achieve it\&. By default, there is no maximum pause time value\&. + +The following example shows how to set the maximum target pause time to 500 ms: +.sp +.nf +\f3\-XX:MaxGCPauseMillis=500\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxHeapSize=\fIsize\fR +.br +Sets the maximum size (in byes) of the memory allocation pool\&. This value must be a multiple of 1024 and greater than 2 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For server deployments, \f3-XX:InitialHeapSize\fR and \f3-XX:MaxHeapSize\fR are often set to the same value\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the maximum allowed size of allocated memory to 80 MB using various units: +.sp +.nf +\f3\-XX:MaxHeapSize=83886080\fP +.fi +.nf +\f3\-XX:MaxHeapSize=81920k\fP +.fi +.nf +\f3\-XX:MaxHeapSize=80m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +On Oracle Solaris 7 and Oracle Solaris 8 SPARC platforms, the upper limit for this value is approximately 4,000 MB minus overhead amounts\&. On Oracle Solaris 2\&.6 and x86 platforms, the upper limit is approximately 2,000 MB minus overhead amounts\&. On Linux platforms, the upper limit is approximately 2,000 MB minus overhead amounts\&. + +The \f3-XX:MaxHeapSize\fR option is equivalent to \f3-Xmx\fR\&. +.TP +-XX:MaxHeapFreeRatio=\fIpercent\fR +.br +Sets the maximum allowed percentage of free heap space (0 to 100) after a GC event\&. If free heap space expands above this value, then the heap will be shrunk\&. By default, this value is set to 70%\&. + +The following example shows how to set the maximum free heap ratio to 75%: +.sp +.nf +\f3\-XX:MaxHeapFreeRatio=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxMetaspaceSize=\fIsize\fR +.br +Sets the maximum amount of native memory that can be allocated for class metadata\&. By default, the size is not limited\&. The amount of metadata for an application depends on the application itself, other running applications, and the amount of memory available on the system\&. + +The following example shows how to set the maximum class metadata size to 256 MB: +.sp +.nf +\f3\-XX:MaxMetaspaceSize=256m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxNewSize=\fIsize\fR +.br +Sets the maximum size (in bytes) of the heap for the young generation (nursery)\&. The default value is set ergonomically\&. +.TP +-XX:MaxTenuringThreshold=\fIthreshold\fR +.br +Sets the maximum tenuring threshold for use in adaptive GC sizing\&. The largest value is 15\&. The default value is 15 for the parallel (throughput) collector, and 6 for the CMS collector\&. + +The following example shows how to set the maximum tenuring threshold to 10: +.sp +.nf +\f3\-XX:MaxTenuringThreshold=10\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MetaspaceSize=\fIsize\fR +.br +Sets the size of the allocated class metadata space that will trigger a garbage collection the first time it is exceeded\&. This threshold for a garbage collection is increased or decreased depending on the amount of metadata used\&. The default size depends on the platform\&. +.TP +-XX:MinHeapFreeRatio=\fIpercent\fR +.br +Sets the minimum allowed percentage of free heap space (0 to 100) after a GC event\&. If free heap space falls below this value, then the heap will be expanded\&. By default, this value is set to 40%\&. + +The following example shows how to set the minimum free heap ratio to 25%: +.sp +.nf +\f3\-XX:MinHeapFreeRatio=25\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NewRatio=\fIratio\fR +.br +Sets the ratio between young and old generation sizes\&. By default, this option is set to 2\&. The following example shows how to set the young/old ratio to 1: +.sp +.nf +\f3\-XX:NewRatio=1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NewSize=\fIsize\fR +.br +Sets the initial size (in bytes) of the heap for the young generation (nursery)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The young generation region of the heap is used for new objects\&. GC is performed in this region more often than in other regions\&. If the size for the young generation is too low, then a large number of minor GCs will be performed\&. If the size is too high, then only full GCs will be performed, which can take a long time to complete\&. Oracle recommends that you keep the size for the young generation between a half and a quarter of the overall heap size\&. + +The following examples show how to set the initial size of young generation to 256 MB using various units: +.sp +.nf +\f3\-XX:NewSize=256m\fP +.fi +.nf +\f3\-XX:NewSize=262144k\fP +.fi +.nf +\f3\-XX:NewSize=268435456\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The \f3-XX:NewSize\fR option is equivalent to \f3-Xmn\fR\&. +.TP +-XX:ParallelGCThreads=\fIthreads\fR +.br +Sets the number of threads used for parallel garbage collection in the young and old generations\&. The default value depends on the number of CPUs available to the JVM\&. + +For example, to set the number of threads for parallel GC to 2, specify the following option: +.sp +.nf +\f3\-XX:ParallelGCThreads=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+ParallelRefProcEnabled +.br +Enables parallel reference processing\&. By default, this option is disabled\&. +.TP +-XX:+PrintAdaptiveSizePolicy +.br +Enables printing of information about adaptive generation sizing\&. By default, this option is disabled\&. +.TP +-XX:+PrintGC +.br +Enables printing of messages at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCApplicationConcurrentTime +.br +Enables printing of how much time elapsed since the last pause (for example, a GC pause)\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCApplicationStoppedTime +.br +Enables printing of how much time the pause (for example, a GC pause) lasted\&. By default, this option is disabled\&. +.TP +-XX+PrintGCDateStamp +.br +Enables printing of a date stamp at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCDetails +.br +Enables printing of detailed messages at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCTaskTimeStamps +.br +Enables printing of time stamps for every individual GC worker thread task\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCTimeStamp +.br +Enables printing of time stamps at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintTenuringDistribution +.br +Enables printing of tenuring age information\&. The following is an example of the output: +.sp +.nf +\f3Desired survivor size 48286924 bytes, new threshold 10 (max 10)\fP +.fi +.nf +\f3\- age 1: 28992024 bytes, 28992024 total\fP +.fi +.nf +\f3\- age 2: 1366864 bytes, 30358888 total\fP +.fi +.nf +\f3\- age 3: 1425912 bytes, 31784800 total\fP +.fi +.nf +\f3\&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Age 1 objects are the youngest survivors (they were created after the previous scavenge, survived the latest scavenge, and moved from eden to survivor space)\&. Age 2 objects have survived two scavenges (during the second scavenge they were copied from one survivor space to the next)\&. And so on\&. + +In the preceding example, 28 992 024 bytes survived one scavenge and were copied from eden to survivor space, 1 366 864 bytes are occupied by age 2 objects, etc\&. The third value in each row is the cumulative size of objects of age n or less\&. + +By default, this option is disabled\&. +.TP +-XX:+ScavengeBeforeFullGC +.br +Enables GC of the young generation before each full GC\&. This option is enabled by default\&. Oracle recommends that you \fIdo not\fR disable it, because scavenging the young generation before a full GC can reduce the number of objects reachable from the old generation space into the young generation space\&. To disable GC of the young generation before each full GC, specify \f3-XX:-ScavengeBeforeFullGC\fR\&. +.TP +-XX:SoftRefLRUPolicyMSPerMB=\fItime\fR +.br +Sets the amount of time (in milliseconds) a softly reachable object is kept active on the heap after the last time it was referenced\&. The default value is one second of lifetime per free megabyte in the heap\&. The \f3-XX:SoftRefLRUPolicyMSPerMB\fR option accepts integer values representing milliseconds per one megabyte of the current heap size (for Java HotSpot Client VM) or the maximum possible heap size (for Java HotSpot Server VM)\&. This difference means that the Client VM tends to flush soft references rather than grow the heap, whereas the Server VM tends to grow the heap rather than flush soft references\&. In the latter case, the value of the \f3-Xmx\fR option has a significant effect on how quickly soft references are garbage collected\&. + +The following example shows how to set the value to 2\&.5 seconds: +.sp +.nf +\f3\-XX:SoftRefLRUPolicyMSPerMB=2500\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:SurvivorRatio=\fIratio\fR +.br +Sets the ratio between eden space size and survivor space size\&. By default, this option is set to 8\&. The following example shows how to set the eden/survivor space ratio to 4: +.sp +.nf +\f3\-XX:SurvivorRatio=4\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:TargetSurvivorRatio=\fIpercent\fR +.br +Sets the desired percentage of survivor space (0 to 100) used after young garbage collection\&. By default, this option is set to 50%\&. + +The following example shows how to set the target survivor space ratio to 30%: +.sp +.nf +\f3\-XX:TargetSurvivorRatio=30\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:TLABSize=\fIsize\fR +.br +Sets the initial size (in bytes) of a thread-local allocation buffer (TLAB)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. If this option is set to 0, then the JVM chooses the initial size automatically\&. + +The following example shows how to set the initial TLAB size to 512 KB: +.sp +.nf +\f3\-XX:TLABSize=512k\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+UseAdaptiveSizePolicy +.br +Enables the use of adaptive generation sizing\&. This option is enabled by default\&. To disable adaptive generation sizing, specify \f3-XX:-UseAdaptiveSizePolicy\fR and set the size of the memory allocation pool explicitly (see the \f3-XX:SurvivorRatio\fR option)\&. +.TP +-XX:+UseCMSInitiatingOccupancyOnly +.br +Enables the use of the occupancy value as the only criterion for initiating the CMS collector\&. By default, this option is disabled and other criteria may be used\&. +.TP +-XX:+UseConcMarkSweepGC +.br +Enables the use of the CMS garbage collector for the old generation\&. Oracle recommends that you use the CMS garbage collector when application latency requirements cannot be met by the throughput (\f3-XX:+UseParallelGC\fR) garbage collector\&. The G1 garbage collector (\f3-XX:+UseG1GC\fR) is another alternative\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. When this option is enabled, the \f3-XX:+UseParNewGC\fR option is automatically set\&. +.TP +-XX:+UseG1GC +.br +Enables the use of the G1 garbage collector\&. It is a server-style garbage collector, targeted for multiprocessor machines with a large amount of RAM\&. It meets GC pause time goals with high probability, while maintaining good throughput\&. The G1 collector is recommended for applications requiring large heaps (sizes of around 6 GB or larger) with limited GC latency requirements (stable and predictable pause time below 0\&.5 seconds)\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. +.TP +-XX:+UseGCOverheadLimit +.br +Enables the use of a policy that limits the proportion of time spent by the JVM on GC before an \f3OutOfMemoryError\fR exception is thrown\&. This option is enabled, by default and the parallel GC will throw an \f3OutOfMemoryError\fR if more than 98% of the total time is spent on garbage collection and less than 2% of the heap is recovered\&. When the heap is small, this feature can be used to prevent applications from running for long periods of time with little or no progress\&. To disable this option, specify \f3-XX:-UseGCOverheadLimit\fR\&. +.TP +-XX:+UseNUMA +.br +Enables performance optimization of an application on a machine with nonuniform memory architecture (NUMA) by increasing the application\&'s use of lower latency memory\&. By default, this option is disabled and no optimization for NUMA is made\&. The option is only available when the parallel garbage collector is used (\f3-XX:+UseParallelGC\fR)\&. +.TP +-XX:+UseParallelGC +.br +Enables the use of the parallel scavenge garbage collector (also known as the throughput collector) to improve the performance of your application by leveraging multiple processors\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. If it is enabled, then the \f3-XX:+UseParallelOldGC\fR option is automatically enabled, unless you explicitly disable it\&. +.TP +-XX:+UseParallelOldGC +.br +Enables the use of the parallel garbage collector for full GCs\&. By default, this option is disabled\&. Enabling it automatically enables the \f3-XX:+UseParallelGC\fR option\&. +.TP +-XX:+UseParNewGC +.br +Enables the use of parallel threads for collection in the young generation\&. By default, this option is disabled\&. It is automatically enabled when you set the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:+UseSerialGC +.br +Enables the use of the serial garbage collector\&. This is generally the best choice for small and simple applications that do not require any special functionality from garbage collection\&. By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. +.TP +-XX:+UseTLAB +.br +Enables the use of thread-local allocation blocks (TLABs) in the young generation space\&. This option is enabled by default\&. To disable the use of TLABs, specify \f3-XX:-UseTLAB\fR\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +These options were included in the previous release, but have since been considered unnecessary\&. +.TP +-Xrun\fIlibname\fR +.br +Loads the specified debugging/profiling library\&. This option was superseded by the \f3-agentlib\fR option\&. +.TP +-XX:CMSInitiatingPermOccupancyFraction=\fIpercent\fR +.br +Sets the percentage of the permanent generation occupancy (0 to 100) at which to start a GC\&. This option was deprecated in JDK 8 with no replacement\&. +.TP +-XX:MaxPermSize=\fIsize\fR +.br +Sets the maximum permanent generation space size (in bytes)\&. This option was deprecated in JDK 8, and superseded by the \f3-XX:MaxMetaspaceSize\fR option\&. +.TP +-XX:PermSize=\fIsize\fR +.br +Sets the space (in bytes) allocated to the permanent generation that triggers a garbage collection if it is exceeded\&. This option was deprecated un JDK 8, and superseded by the \f3-XX:MetaspaceSize\fR option\&. +.TP +-XX:+UseSplitVerifier +.br +Enables splitting of the verification process\&. By default, this option was enabled in the previous releases, and verification was split into two phases: type referencing (performed by the compiler) and type checking (performed by the JVM runtime)\&. This option was deprecated in JDK 8, and verification is now split by default without a way to disable it\&. +.TP +-XX:+UseStringCache +.br +Enables caching of commonly allocated strings\&. This option was removed from JDK 8 with no replacement\&. +.SH PERFORMANCE\ TUNING\ EXAMPLES +The following examples show how to use experimental tuning flags to either optimize throughput or to provide lower response time\&. +.PP +\f3Example 1 Tuning for Higher Throughput\fR +.sp +.nf +\f3java \-d64 \-server \-XX:+AggressiveOpts \-XX:+UseLargePages \-Xmn10g \-Xms26g \-Xmx26g\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Tuning for Lower Response Time\fR +.sp +.nf +\f3java \-d64 \-XX:+UseG1GC \-Xms26g Xmx26g \-XX:MaxGCPauseMillis=500 \-XX:+PrintGCTimeStamp\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXIT\ STATUS +The following exit values are typically returned by the launcher when the launcher is called with the wrong arguments, serious errors, or exceptions thrown by the JVM\&. However, a Java application may choose to return any value by using the API call \f3System\&.exit(exitValue)\fR\&. The values are: +.TP 0.2i +\(bu +\f30\fR: Successful completion +.TP 0.2i +\(bu +\f3>0\fR: An error occurred +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +jar(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/javac.1 b/jdk/src/linux/doc/man/javac.1 index 3f3b5733f0a..3cbc97614b8 100644 --- a/jdk/src/linux/doc/man/javac.1 +++ b/jdk/src/linux/doc/man/javac.1 @@ -1,1205 +1,1364 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javac 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javac.1 +.\" +.if n .pl 99999 +.TH javac 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javac \- Java programming language compiler -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl - \fP\f3javac\fP [ options ] [ sourcefiles ] [ classes ] [ @argfiles ] -.fl +.SH NAME +javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi +\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] +.fi +.sp +Arguments can be in any order: +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIsourcefiles\fR +One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. +.TP +\fIclasses\fR +One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. +.TP +\fI@argfiles\fR +One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. +.SH DESCRIPTION +The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. +.PP +There are two ways to pass source code file names to \f3javac\fR\&. +.TP 0.2i +\(bu +For a small number of source files, list the file names on the command line\&. +.TP 0.2i +\(bu +For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. +.PP +Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. +.PP +Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. +.PP +Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. +.PP +By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. +.SH OPTIONS +The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. +.TP 0.2i +\(bu +See also Cross-Compilation Options +.TP 0.2i +\(bu +See also Nonstandard Options +.SS STANDARD\ OPTIONS +.TP +-A\fIkey\fR[\fI=value\fR] +.br +Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. +.TP +-cp \fIpath\fR or -classpath \fIpath\fR +.br +Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. -.LP -.LP -Arguments may be in any order. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -sourcefiles -One or more source files to be compiled (such as MyClass.java). -.TP 3 -classes -One or more classes to be processed for annotations (such as MyPackage.MyClass). -.TP 3 -@argfiles -One or more files that lists options and source files. The \f2\-J\fP options are not allowed in these files. -.RE +If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3javac\fP tool reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files. It can also process annotations in Java source files and classes. -.LP -.LP -There are two ways to pass source code file names to \f3javac\fP: -.LP -.RS 3 -.TP 2 -o -For a small number of source files, simply list the file names on the command line. -.TP 2 -o -For a large number of source files, list the file names in a file, separated by blanks or line breaks. Then use the list file name on the \f3javac\fP command line, preceded by an \f3@\fP character. -.RE +If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. +.TP +-Djava\&.ext\&.dirs=\fIdirectories\fR +.br +Overrides the location of installed extensions\&. +.TP +-Djava\&.endorsed\&.dirs=\fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-d \fIdirectory\fR +.br +Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. -.LP -.LP -Source code file names must have \f2.java\fP suffixes, class file names must have \f2.class\fP suffixes, and both source and class files must have root names that identify the class. For example, a class called \f2MyClass\fP would be written in a source file called \f2MyClass.java\fP and compiled into a bytecode class file called \f2MyClass.class\fP. -.LP -.LP -Inner class definitions produce additional class files. These class files have names combining the inner and outer class names, such as \f2MyClass$MyInnerClass.class\fP. -.LP -.LP -You should arrange source files in a directory tree that reflects their package tree. For example, if you keep all your source files in \f3/workspace\fP, the source code for \f2com.mysoft.mypack.MyClass\fP should be in \f3/workspace/com/mysoft/mypack/MyClass.java\fP. -.LP -.LP -By default, the compiler puts each class file in the same directory as its source file. You can specify a separate destination directory with \f3\-d\fP (see Options, below). -.LP -.SH "OPTIONS" -.LP -.LP -The compiler has a set of standard options that are supported on the current development environment and will be supported in future releases. An additional set of non\-standard options are specific to the current virtual machine and compiler implementations and are subject to change in the future. Non\-standard options begin with \f3\-X\fP. -.LP -.SS -Standard Options -.LP -.RS 3 -.TP 3 -\-Akey[=value] -Options to pass to annotation processors. These are not interpreted by javac directly, but are made available for use by individual processors. \f2key\fP should be one or more identifiers separated by ".". -.TP 3 -\-cp path or \-classpath path -Specify where to find user class files, and (optionally) annotation processors and source files. This class path overrides the user class path in the \f3CLASSPATH\fP environment variable. If neither \f3CLASSPATH\fP, \f3\-cp\fP nor \f3\-classpath\fP is specified, the user class path consists of the current directory. See Setting the Class Path for more details. -.br -.br ->If the \f3\-sourcepath\fP option is not specified, the user class path is also searched for source files. -.br -.br -If the \f3\-processorpath\fP option is not specified, the class path is also searched for annotation processors. -.TP 3 -\-Djava.ext.dirs=directories -Override the location of installed extensions. -.TP 3 -\-Djava.endorsed.dirs=directories -Override the location of endorsed standards path. -.TP 3 -\-d directory -Set the destination directory for class files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, \f3javac\fP puts the class file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-d /home/myclasses\fP and the class is called \f2com.mypackage.MyClass\fP, then the class file is called \f2/home/myclasses/com/mypackage/MyClass.class\fP. -.br -.br -If \f3\-d\fP is not specified, \f3javac\fP puts each class files in the same directory as the source file from which it was generated. -.br -.br -\f3Note:\fP The directory specified by \f3\-d\fP is not automatically added to your user class path. -.TP 3 -\-deprecation -Show a description of each use or override of a deprecated member or class. Without \f3\-deprecation\fP, \f3javac\fP shows a summary of the source files that use or override deprecated members or classes. \f3\-deprecation\fP is shorthand for \f3\-Xlint:deprecation\fP. -.TP 3 -\-encoding encoding -Set the source file encoding name, such as \f2EUC\-JP and UTF\-8\fP. If \f3\-encoding\fP is not specified, the platform default converter is used. -.TP 3 -\-endorseddirs directories -Override the location of endorsed standards path. -.TP 3 -\-extdirs directories -Overrides the location of the \f2ext\fP directory. The \f2directories\fP variable is a colon\-separated list of directories. Each JAR archive in the specified directories is searched for class files. All JAR archives found are automatically part of the class path. -.br -.br -If you are cross\-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), this option specifies the directories that contain the extension classes. See Cross\-Compilation Options for more information. -.TP 3 -\-g -Generate all debugging information, including local variables. By default, only line number and source file information is generated. -.TP 3 -\-g:none -Do not generate any debugging information. -.TP 3 -\-g:{keyword list} -Generate only some kinds of debugging information, specified by a comma separated list of keywords. Valid keywords are: -.RS 3 -.TP 3 -source -Source file debugging information -.TP 3 -lines -Line number debugging information -.TP 3 -vars -Local variable debugging information -.RE -.TP 3 -\-help -Print a synopsis of standard options. -.TP 3 -\-implicit:{class,none} -Controls the generation of class files for implicitly loaded source files. To automatically generate class files, use \f3\-implicit:class\fP. To suppress class file generation, use \f3\-implicit:none\fP. If this option is not specified, the default is to automatically generate class files. In this case, the compiler will issue a warning if any such class files are generated when also doing annotation processing. The warning will not be issued if this option is set explicitly. See Searching For Types. -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.br -.br -\f3Note:\fP \f3CLASSPATH\fP, \f3\-classpath\fP, \f3\-bootclasspath\fP, and \f3\-extdirs\fP do \f2not\fP specify the classes used to run \f3javac\fP. Fiddling with the implementation of the compiler in this way is usually pointless and always risky. If you do need to do this, use the \f3\-J\fP option to pass through options to the underlying \f3java\fP launcher. -.TP 3 -\-nowarn -Disable warning messages. This has the same meaning as \f3\-Xlint:none\fP. -.TP 3 -\-proc: {none,only} -Controls whether annotation processing and/or compilation is done. \f3\-proc:none\fP means that compilation takes place without annotation processing. \f3\-proc:only\fP means that only annotation processing is done, without any subsequent compilation. -.TP 3 -\-processor class1[,class2,class3...] -Names of the annotation processors to run. This bypasses the default discovery process. -.TP 3 -\-processorpath path -Specify where to find annotation processors; if this option is not used, the class path will be searched for processors. -.TP 3 -\-s dir -Specify the directory where to place generated source files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, the compiler puts the source file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-s /home/mysrc\fP and the class is called \f2com.mypackage.MyClass\fP, then the source file will be placed in \f2/home/mysrc/com/mypackage/MyClass.java\fP. -.TP 3 -\-source release -Specifies the version of source code accepted. The following values for \f2release\fP are allowed: -.RS 3 -.TP 3 -1.3 -The compiler does \f2not\fP support assertions, generics, or other language features introduced after JDK 1.3. -.TP 3 -1.4 -The compiler accepts code containing assertions, which were introduced in JDK 1.4. -.TP 3 -1.5 -The compiler accepts code containing generics and other language features introduced in JDK 5. -.TP 3 -5 -Synonym for 1.5. -.TP 3 -1.6 -This is the default value. No language changes were introduced in Java SE 6. However, encoding errors in source files are now reported as errors, instead of warnings, as previously. -.TP 3 -6 -Synonym for 1.6. -.TP 3 -1.7 -The compiler accepts code with features introduced in JDK 7. -.TP 3 -7 -Synonym for 1.7. -.RE -.TP 3 -\-sourcepath sourcepath -Specify the source code path to search for class or interface definitions. As with the user class path, source path entries are separated by colons (\f3:\fP) and can be directories, JAR archives, or ZIP archives. If packages are used, the local path name within the directory or archive must reflect the package name. -.br -.br -\f3Note:\fP Classes found through the class path may be subject to automatic recompilation if their sources are also found. See Searching For Types. -.TP 3 -\-verbose -Verbose output. This includes information about each class loaded and each source file compiled. -.TP 3 -\-version -Print version information. -.TP 3 -\-Werror -Terminate compilation if warnings occur. -.TP 3 -\-X -Display information about non\-standard options and exit. -.RE +If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. -.LP -.SS -Cross\-Compilation Options -.LP -.LP -By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fP shipped with. But \f3javac\fP also supports \f2cross\-compiling\fP, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation. It is important to use \f3\-bootclasspath\fP and \f3\-extdirs\fP when cross\-compiling; see Cross\-Compilation Example below. -.LP -.RS 3 -.TP 3 -\-target version -Generate class files that target a specified version of the VM. Class files will run on the specified target and on later versions, but not on earlier versions of the VM. Valid targets are \f31.1\fP \f31.2\fP \f31.3\fP \f31.4\fP \f31.5\fP (also \f35\fP) \f31.6\fP (also \f36\fP) and \f31.7\fP (also \f37\fP). -.br -.br -The default for \f3\-target\fP depends on the value of \f3\-source\fP: -.RS 3 -.TP 2 -o -If \-source is \f3not specified\fP, the value of \-target is \f31.7\fP -.TP 2 -o -If \-source is \f31.2\fP, the value of \-target is \f31.4\fP -.TP 2 -o -If \-source is \f31.3\fP, the value of \-target is \f31.4\fP -.TP 2 -o -For \f3all other values\fP of \-source, the value of \f3\-target\fP is the value of \f3\-source\fP. -.RE -.TP 3 -\-bootclasspath bootclasspath -Cross\-compile against the specified set of boot classes. As with the user class path, boot class path entries are separated by colons (\f3:\fP) and can be directories, JAR archives, or ZIP archives. -.RE +If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. -.LP -.SS -Non\-Standard Options -.LP -.RS 3 -.TP 3 -\-Xbootclasspath/p:path -Prepend to the bootstrap class path. -.TP 3 -\-Xbootclasspath/a:path -Append to the bootstrap class path. -.TP 3 -\-Xbootclasspath/:path -Override location of bootstrap class files. -.TP 3 -\-Xlint -Enable all recommended warnings. In this release, enabling all available warnings is recommended. -.TP 3 -\-Xlint:all -Enable all recommended warnings. In this release, enabling all available warnings is recommended. -.TP 3 -\-Xlint:none -Disable all warnings. -.TP 3 -\-Xlint:name -Enable warning \f2name\fP. See the section Warnings That Can Be Enabled or Disabled with \-Xlint Option for a list of warnings you can enable with this option. -.TP 3 -\-Xlint:\-name -Disable warning \f2name\fP. See the section Warnings That Can Be Enabled or Disabled with \-Xlint Option for a list of warnings you can disable with this option. -.TP 3 -\-Xmaxerrs number -Set the maximum number of errors to print. -.TP 3 -\-Xmaxwarns number -Set the maximum number of warnings to print. -.TP 3 -\-Xstdout filename -Send compiler messages to the named file. By default, compiler messages go to \f2System.err\fP. -.TP 3 -\-Xprefer:{newer,source} -Specify which file to read when both a source file and class file are found for a type. (See Searching For Types). If \f2\-Xprefer:newer\fP is used, it reads the newer of the source or class file for a type (default). If the \f2\-Xprefer:source\fP option is used, it reads source file. Use \f2\-Xprefer:source\fP when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f2SOURCE\fP. -.TP 3 -\-Xpkginfo:{always,legacy,nonempty} -Specify handling of package\-info files -.TP 3 -\-Xprint -Print out textual representation of specified types for debugging purposes; perform neither annotation processing nor compilation. The format of the output may change. -.TP 3 -\-XprintProcessorInfo -Print information about which annotations a processor is asked to process. -.TP 3 -\-XprintRounds -Print information about initial and subsequent annotation processing rounds. -.RE +\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. +.TP +-deprecation +.br +Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. +.TP +-encoding \fIencoding\fR +.br +Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. +.TP +-endorseddirs \fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-extdirs \fIdirectories\fR +.br +Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. -.LP -.SS -Warnings That Can Be Enabled or Disabled with \-Xlint Option -.LP -.LP -Enable warning \f2name\fP with the option \f3\-Xlint:\fP\f2name\fP, where \f2name\fP is one of the following warning names. Similarly, you can disable warning \f2name\fP with the option \f3\-Xlint:\-\fP\f2name\fP: -.LP -.RS 3 -.TP 3 -cast -Warn about unnecessary and redundant casts. For example: -.nf -\f3 -.fl -String s = (String)"Hello!" -.fl -\fP -.fi -.TP 3 -classfile -Warn about issues related to classfile contents. -.TP 3 -deprecation -Warn about use of deprecated items. For example: -.nf -\f3 -.fl - java.util.Date myDate = new java.util.Date(); -.fl - int currentDay = myDate.getDay(); -.fl -\fP -.fi -The method \f2java.util.Date.getDay\fP has been deprecated since JDK 1.1. -.TP 3 -dep\-ann -Warn about items that are documented with an \f2@deprecated\fP Javadoc comment, but do not have a \f2@Deprecated\fP annotation. For example: -.nf -\f3 -.fl - /** -.fl - * @deprecated As of Java SE 7, replaced by {@link #newMethod()} -.fl - */ -.fl +If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. +.TP +-g +.br +Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. +.TP +-g:none +.br +Does not generate any debugging information\&. +.TP +-g:[\fIkeyword list\fR] +.br +Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: +.RS +.TP +source +Source file debugging information\&. +.TP +lines +Line number debugging information\&. +.TP +vars +Local variable debugging information\&. +.RE -.fl - public static void deprecatedMethood() { } -.fl +.TP +-help +.br +Prints a synopsis of standard options\&. +.TP +-implicit:[\fIclass, none\fR] +.br +Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.fl - public static void newMethod() { } -.fl -\fP -.fi -.TP 3 -divzero -Warn about division by constant integer 0. For example: -.nf -\f3 -.fl - int divideByZero = 42 / 0; -.fl -\fP -.fi -.TP 3 -empty -Warn about empty statements after \f2if\fP statements. For example: -.nf -\f3 -.fl -class E { -.fl - void m() { -.fl - if (true) ; -.fl - } -.fl -} -.fl -\fP -.fi -.TP 3 -fallthrough -Check \f2switch\fP blocks for fall\-through cases and provide a warning message for any that are found. Fall\-through cases are cases in a \f2switch\fP block, other than the last case in the block, whose code does not include a \f2break\fP statement, allowing code execution to "fall through" from that case to the next case. For example, the code following the \f2case 1\fP label in this \f2switch\fP block does not end with a \f2break\fP statement: -.nf -\f3 -.fl -switch (x) { -.fl -case 1: -.fl - System.out.println("1"); -.fl - // No break statement here. -.fl -case 2: -.fl - System.out.println("2"); -.fl -} -.fl -\fP -.fi -If the \f2\-Xlint:fallthrough\fP flag were used when compiling this code, the compiler would emit a warning about "possible fall\-through into case," along with the line number of the case in question. -.TP 3 -finally -Warn about \f2finally\fP clauses that cannot complete normally. For example: -.nf -\f3 -.fl - public static int m() { -.fl - try { -.fl - throw new NullPointerException(); -.fl - } catch (NullPointerException e) { -.fl - System.err.println("Caught NullPointerException."); -.fl - return 1; -.fl - } finally { -.fl - return 0; -.fl - } -.fl - } -.fl -\fP -.fi -The compiler generates a warning for \f2finally\fP block in this example. When this method is called, it returns a value of \f20\fP, not \f21\fP. A \f2finally\fP block always executes when the \f2try\fP block exits. In this example, if control is transferred to the \f2catch\fP, then the method exits. However, the \f2finally\fP block must be executed, so it is executed, even though control has already been transferred outside the method. -.TP 3 -options -Warn about issues relating to the use of command line options. See Cross\-Compilation Example for an example of this kind of warning. -.TP 3 -overrides -Warn about issues regarding method overrides. For example, consider the following two classes: -.nf -\f3 -.fl -public class ClassWithVarargsMethod { -.fl - void varargsMethod(String... s) { } -.fl -} -.fl -\fP -.fi -.nf -\f3 -.fl -public class ClassWithOverridingMethod extends ClassWithVarargsMethod { -.fl - @Override -.fl - void varargsMethod(String[] s) { } -.fl -} -.fl -\fP -.fi -The compiler generates a warning similar to the following: +\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. +.TP +-nowarn .br +Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. +.TP +-parameters .br -\f2warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod overrides varargsMethod(String...) in ClassWithVarargsMethod; overriding method is missing '...'\fP +Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. +.TP +-proc: [\fInone\fR, \fIonly\fR] .br +Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. +.TP +-processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] .br -When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. In the method \f2ClassWithVarargsMethod.varargsMethod\fP, the compiler translates the varargs formal parameter \f2String... s\fP to the formal parameter \f2String[] s\fP, an array, which matches the formal parameter of the method \f2ClassWithOverridingMethod.varargsMethod\fP. Consequently, this example compiles. -.TP 3 -path -Warn about invalid path elements and nonexistent path directories on the command line (with regards to the class path, the source path, and other paths). Such warnings cannot be suppressed with the \f2@SuppressWarnings\fP annotation. For example: -.nf -\f3 -.fl -javac \-Xlint:path \-classpath /nonexistentpath Example.java -.fl -\fP -.fi -.TP 3 -processing -Warn about issues regarding annotation processing. The compiler generates this warning if you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception. For example, the following is a simple annotation processor: +Names of the annotation processors to run\&. This bypasses the default discovery process\&. +.TP +-processorpath \fIpath\fR .br +Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. +.TP +-s \fIdir\fR .br -\f3Source file \fP\f4AnnoProc.java\fP: -.nf -\f3 -.fl -import java.util.*; -.fl -import javax.annotation.processing.*; -.fl -import javax.lang.model.*; -.fl -import javax.lang.model.element.*; -.fl +Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. -.fl -@SupportedAnnotationTypes("NotAnno") -.fl -public class AnnoProc extends AbstractProcessor { -.fl - public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv) { -.fl - return true; -.fl - } -.fl - -.fl - public SourceVersion getSupportedSourceVersion() { -.fl - return SourceVersion.latest(); -.fl - } -.fl -} -.fl -\fP -.fi -\f3Source file \fP\f4AnnosWithoutProcessors.java\fP\f3:\fP -.nf -\f3 -.fl -@interface Anno { } -.fl - -.fl -@Anno -.fl -class AnnosWithoutProcessors { } -.fl -\fP -.fi -The following commands compile the annotation processor \f2AnnoProc\fP, then run this annotation processor against the source file \f2AnnosWithoutProcessors.java\fP: -.nf -\f3 -.fl -% javac AnnoProc.java -.fl -% javac \-cp . \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors.java -.fl -\fP -.fi -When the compiler runs the annotation processor against the source file \f2AnnosWithoutProcessors.java\fP, it generates the following warning: +If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. +.TP +-source \fIrelease\fR .br -.br -\f2warning: [processing] No processor claimed any of these annotations: Anno\fP -.br -.br -To resolve this issue, you can rename the annotation defined and used in the class \f2AnnosWithoutProcessors\fP from \f2Anno\fP to \f2NotAnno\fP. -.TP 3 -rawtypes -Warn about unchecked operations on raw types. The following statement generates a \f2rawtypes\fP warning: -.nf -\f3 -.fl -void countElements(List l) { ... } -.fl -\fP -.fi -The following does not generate a \f2rawtypes\fP warning: -.nf -\f3 -.fl -void countElements(List<?> l) { ... } -.fl -\fP -.fi -\f2List\fP is a raw type. However, \f2List<?>\fP is a unbounded wildcard parameterized type. Because \f2List\fP is a parameterized interface, you should always specify its type argument. In this example, the \f2List\fP formal argument is specified with a unbounded wildcard (\f2?\fP) as its formal type parameter, which means that the \f2countElements\fP method can accept any instantiation of the \f2List\fP interface. -.TP 3 -serial -Warn about missing \f2serialVersionUID\fP definitions on serializable classes. For example: -.nf -\f3 -.fl -public class PersistentTime implements Serializable -.fl -{ -.fl - private Date time; -.fl +Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: +.RS +.TP +1\&.3 +The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. +.TP +1\&.4 +The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. +.TP +1\&.5 +The compiler accepts code containing generics and other language features introduced in Java SE 5\&. +.TP +5 +Synonym for 1\&.5\&. +.TP +1\&.6 +No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. +.TP +6 +Synonym for 1\&.6\&. +.TP +1\&.7 +This is the default value\&. The compiler accepts code with features introduced in Java SE 7\&. +.TP +7 +Synonym for 1\&.7\&. +.RE + +.TP +-sourcepath \fIsourcepath\fR +.br +Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. + +\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. +.TP +-verbose +.br +Uses verbose output, which includes information about each class loaded and each source file compiled\&. +.TP +-version +.br +Prints release information\&. +.TP +-werror +.br +Terminates compilation when warnings occur\&. +.TP +-X +.br +Displays information about nonstandard options and exits\&. +.SS CROSS-COMPILATION\ OPTIONS +By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. +.TP +-target \fIversion\fR +.br +Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), and 1\&.7 (also 7)\&. + +The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: +.RS +.TP 0.2i +\(bu +If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.7 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.7 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.7 +.TP 0.2i +\(bu +For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. +.RE + +.TP +-bootclasspath \fIbootclasspath\fR +.br +Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. +.SS COMPACT\ PROFILE\ OPTION +Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. +.PP +The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. +.TP +-profile +.br +When using compact profiles, this option specifies the profile name when compiling\&. For example: +.sp +.nf +\f3javac \-profile compact1 Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: +.sp +.nf +\f3cd jdk1\&.8\&.0/bin\fP +.fi +.nf +\f3\&./javac \-profile compact1 Paint\&.java\fP +.fi +.nf +\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP +.fi +.nf +\f3import java\&.applet\&.Applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) + +An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. +.SS NONSTANDARD\ OPTIONS +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Adds a suffix to the bootstrap class path\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Adds a prefix to the bootstrap class path\&. +.TP +-Xbootclasspath/:\fIpath\fR +.br +Overrides the location of the bootstrap class files\&. +.TP +-Xdoclint:[-]\fIgroup\fR [\fI/access\fR] +.br +Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. + +The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): +.sp +.nf +\f3\-Xdoclint:all/protected\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): +.sp +.nf +\f3\-Xdoclint:all,\-html/package\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xdoclint:none +.br +Disables all groups of checks\&. +.TP +-Xdoclint:all[\fI/access\fR] +.br +Enables all groups of checks\&. +.TP +-Xlint +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:all +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:none +.br +Disables all warnings\&. +.TP +-Xlint:\fIname\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. +.TP +-Xlint:\fI-name\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. +.TP +-Xmaxerrs \fInumber\fR +.br +Sets the maximum number of errors to print\&. +.TP +-Xmaxwarns \fInumber\fR +.br +Sets the maximum number of warnings to print\&. +.TP +-Xstdout \fIfilename\fR +.br +Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. +.TP +-Xprefer:[\fInewer,source\fR] +.br +Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. +.TP +-Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] +.br +Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. +.RS +.TP +always +Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. +.TP +legacy +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. + +\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. +.TP +nonempty +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. +.RE + +.TP +-Xprint +.br +Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. +.TP +-XprintProcessorInfo +.br +Prints information about which annotations a processor is asked to process\&. +.TP +-XprintRounds +.br +Prints information about initial and subsequent annotation processing rounds\&. +.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION +Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. +.TP +cast +Warns about unnecessary and redundant casts, for example: +.sp +.nf +\f3String s = (String) "Hello!"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +classfile +Warns about issues related to class file contents\&. +.TP +deprecation +Warns about the use of deprecated items, for example: +.sp +.nf +\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP +.fi +.nf +\f3int currentDay = myDate\&.getDay();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 +.TP +dep-ann +Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static void deprecatedMethood() { }\fP +.fi +.nf +\f3public static void newMethod() { }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +divzero +Warns about division by the constant integer 0, for example: +.sp +.nf +\f3int divideByZero = 42 / 0;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +empty +Warns about empty statements after \f3if\fRstatements, for example: +.sp +.nf +\f3class E {\fP +.fi +.nf +\f3 void m() {\fP +.fi +.nf +\f3 if (true) ;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +fallthrough +Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: +.sp +.nf +\f3switch (x) {\fP +.fi +.nf +\f3case 1:\fP +.fi +.nf +\f3 System\&.out\&.println("1");\fP +.fi +.nf +\f3 // No break statement here\&.\fP +.fi +.nf +\f3case 2:\fP +.fi +.nf +\f3 System\&.out\&.println("2");\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. +.TP +finally +Warns about \f3finally\fR clauses that cannot complete normally, for example: +.sp +.nf +\f3public static int m() {\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3 throw new NullPointerException();\fP +.fi +.nf +\f3 } catch (NullPointerException(); {\fP +.fi +.nf +\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP +.fi +.nf +\f3 return 1;\fP +.fi +.nf +\f3 } finally {\fP +.fi +.nf +\f3 return 0;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. +.TP +options +Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. +.TP +overrides +Warns about issues regarding method overrides\&. For example, consider the following two classes: +.sp +.nf +\f3public class ClassWithVarargsMethod {\fP +.fi +.nf +\f3 void varargsMethod(String\&.\&.\&. s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP +.fi +.nf +\f3 @Override\fP +.fi +.nf +\f3 void varargsMethod(String[] s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning similar to the following:\&. +.sp +.nf +\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP +.fi +.nf +\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP +.fi +.nf +\f3method is missing \&'\&.\&.\&.\&'\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. +.TP +path +Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: +.sp +.nf +\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +processing +Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: + +\fISource file AnnocProc\&.java\fR: +.sp +.nf +\f3import java\&.util\&.*;\fP +.fi +.nf +\f3import javax\&.annotation\&.processing\&.*;\fP +.fi +.nf +\f3import javax\&.lang\&.model\&.*;\fP +.fi +.nf +\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@SupportedAnnotationTypes("NotAnno")\fP +.fi +.nf +\f3public class AnnoProc extends AbstractProcessor {\fP +.fi +.nf +\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP +.fi +.nf +\f3 return true;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public SourceVersion getSupportedSourceVersion() {\fP +.fi +.nf +\f3 return SourceVersion\&.latest();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISource file AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3@interface Anno { }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@Anno\fP +.fi +.nf +\f3class AnnosWithoutProcessors { }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3javac AnnoProc\&.java\fP +.fi +.nf +\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: +.sp +.nf +\f3warning: [processing] No processor claimed any of these annotations: Anno\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. +.TP +rawtypes +Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: +.sp +.nf +\f3void countElements(List l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example does not generate a \f3rawtypes\fR warning +.sp +.nf +\f3void countElements(List<?> l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. +.TP +Serial +Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: +.sp +.nf +\f3public class PersistentTime implements Serializable\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 private Date time;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public PersistentTime() {\fP +.fi +.nf +\f3 time = Calendar\&.getInstance()\&.getTime();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public Date getTime() {\fP +.fi +.nf +\f3 return time;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - public PersistentTime() { -.fl - time = Calendar.getInstance().getTime(); -.fl - } -.fl -.fl - public Date getTime() { -.fl - return time; -.fl - } -.fl -} -.fl -\fP -.fi The compiler generates the following warning: -.br -.br -\f2warning: [serial] serializable class PersistentTime has no definition of serialVersionUID\fP -.br -.br -If a serializable class does not explicitly declare a field named \f2serialVersionUID\fP, then the serialization runtime will calculate a default \f2serialVersionUID\fP value for that class based on various aspects of the class, as described in the Java Object Serialization Specification. However, it is strongly recommended that all serializable classes explicitly declare \f2serialVersionUID\fP values because the default process of computing \f2serialVersionUID\fP vales is highly sensitive to class details that may vary depending on compiler implementations, and can thus result in unexpected \f2InvalidClassExceptions\fP during deserialization. Therefore, to guarantee a consistent \f2serialVersionUID\fP value across different Java compiler implementations, a serializable class must declare an explicit \f2serialVersionUID\fP value. -.TP 3 -static -Warn about issues relating to use of statics. For example: -.nf -\f3 -.fl -class XLintStatic { -.fl - static void m1() { } -.fl - void m2() { this.m1(); } -.fl -} -.fl -\fP -.fi -The compiler generates the following warning: -.nf -\f3 -.fl -warning: [static] static method should be qualified by type name, XLintStatic, instead of by an expression -.fl -\fP -.fi -To resolve this issue, you can call the static method \f2m1\fP as follows: -.nf -\f3 -.fl -XLintStatic.m1(); -.fl -\fP -.fi -Alternatively, you can remove the \f2static\fP keyword from the declaration of the method \f2m1\fP. -.TP 3 -try -Warn about issues relating to use of \f2try\fP blocks, including try\-with\-resources statements. For example, a warning is generated for the following statement because the resource \f2ac\fP declared in the \f2try\fP statement is not used: -.nf -\f3 -.fl -try ( AutoCloseable ac = getResource() ) { -.fl - // do nothing -.fl -} -.fl -\fP -.fi -.TP 3 -unchecked -Give more detail for unchecked conversion warnings that are mandated by the Java Language Specification. For example: -.nf -\f3 -.fl - List l = new ArrayList<Number>(); -.fl - List<String> ls = l; // unchecked warning -.fl -\fP -.fi -During type erasure, the types \f2ArrayList<Number>\fP and \f2List<String>\fP become \f2ArrayList\fP and \f2List\fP, respectively. -.br -.br -The variable \f2ls\fP has the parameterized type \f2List<String>\fP. When the \f2List\fP referenced by \f2l\fP is assigned to \f2ls\fP, the compiler generates an unchecked warning; the compiler is unable to determine at compile time, and moreover knows that the JVM will not be able to determine at runtime, if \f2l\fP refers to a \f2List<String>\fP type; it does not. Consequently, heap pollution occurs. -.br -.br -In detail, a heap pollution situation occurs when the \f2List\fP object \f2l\fP, whose static type is \f2List<Number>\fP, is assigned to another \f2List\fP object, \f2ls\fP, that has a different static type, \f2List<String>\fP. However, the compiler still allows this assignment. It must allow this assignment to preserve backwards compatibility with versions of Java SE that do not support generics. Because of type erasure, \f2List<Number>\fP and \f2List<String>\fP both become \f2List\fP. Consequently, the compiler allows the assignment of the object \f2l\fP, which has a raw type of \f2List\fP, to the object \f2ls\fP. -.TP 3 -varargs -Warn about unsafe usages of variable arguments (varargs) methods, in particular, those that contain non\-reifiable arguments. For example: -.nf -\f3 -.fl -public class ArrayBuilder { -.fl - public static <T> void addToList (List<T> listArg, T... elements) { -.fl - for (T x : elements) { -.fl - listArg.add(x); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi -The compiler generates the following warning for the definition of the method \f2ArrayBuilder.addToList\fP: -.nf -\f3 -.fl -warning: [varargs] Possible heap pollution from parameterized vararg type T -.fl -\fP -.fi -When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. However, the Java programming language does not permit the creation of arrays of parameterized types. In the method \f2ArrayBuilder.addToList\fP, the compiler translates the varargs formal parameter \f2T... elements\fP to the formal parameter \f2T[] elements\fP, an array. However, because of type erasure, the compiler converts the varargs formal parameter to \f2Object[] elements\fP. Consequently, there is a possibility of heap pollution. -.RE +.sp +.nf +\f3warning: [serial] serializable class PersistentTime has no definition of\fP +.fi +.nf +\f3serialVersionUID\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "COMMAND LINE ARGUMENT FILES" -.LP -.LP -To shorten or simplify the javac command line, you can specify one or more files that themselves contain arguments to the \f2javac\fP command (except \f2\-J\fP options). This enables you to create javac commands of any length on any operating system. -.LP -.LP -An argument file can include javac options and source filenames in any combination. The arguments within a file can be space\-separated or newline\-separated. If a filename contains embedded spaces, put the whole filename in double quotes. -.LP -.LP -Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying \f2*.java\fP). Use of the '\f2@\fP' character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -.LP -When executing javac, pass in the path and name of each argument file with the '\f2@\fP' leading character. When javac encounters an argument beginning with the character `\f2@\fP', it expands the contents of that file into the argument list. -.LP -.SS -Example \- Single Arg File -.LP -.LP -You could use a single argument file named "\f2argfile\fP" to hold all javac arguments: -.LP -.nf -\f3 -.fl -% \fP\f3javac @argfile\fP -.fl -.fi -.LP -.LP -This argument file could contain the contents of both files shown in the next example. -.LP -.SS -Example \- Two Arg Files -.LP -.LP -You can create two argument files \-\- one for the javac options and the other for the source filenames: (Notice the following lists have no line\-continuation characters.) -.LP -.LP -Create a file named "\f2options\fP" containing: -.LP -.nf -\f3 -.fl - \-d classes -.fl - \-g -.fl - \-sourcepath /java/pubs/ws/1.3/src/share/classes -.fl +If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. +.TP +static +Warns about issues relating to the use of statics, for example: +.sp +.nf +\f3class XLintStatic {\fP +.fi +.nf +\f3 static void m1() { }\fP +.fi +.nf +\f3 void m2() { this\&.m1(); }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -\fP -.fi -.LP -.LP -Create a file named "\f2classes\fP" containing: -.LP -.nf -\f3 -.fl - MyClass1.java -.fl - MyClass2.java -.fl - MyClass3.java -.fl +The compiler generates the following warning: +.sp +.nf +\f3warning: [static] static method should be qualified by type name, \fP +.fi +.nf +\f3XLintStatic, instead of by an expression\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -\fP -.fi -.LP -.LP -You would then run \f3javac\fP with: -.LP -.nf -\f3 -.fl - % \fP\f3javac @options @classes\fP -.fl +To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: +.sp +.nf +\f3XLintStatic\&.m1();\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -.fi -.LP -.SS -Example \- Arg Files with Paths -.LP -.LP -The argument files can have paths, but any filenames inside the files are relative to the current working directory (not \f2path1\fP or \f2path2\fP): -.LP -.nf -\f3 -.fl -% \fP\f3javac @path1/options @path2/classes\fP -.fl -.fi +Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. +.TP +try +Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: +.sp +.nf +\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "ANNOTATION PROCESSING" -.LP -.LP -\f3javac\fP provides direct support for annotation processing, superseding the need for the separate annotation processing tool, \f3apt\fP. -.LP -.LP -The API for annotation processors is defined in the \f2javax.annotation.processing\fP and \f2javax.lang.model\fP packages and subpackages. -.LP -.SS -Overview of annotation processing -.LP -.LP -Unless annotation processing is disabled with the \f3\-proc:none\fP option, the compiler searches for any annotation processors that are available. The search path can be specified with the \f3\-processorpath\fP option; if it is not given, the user class path is used. Processors are located by means of service provider\-configuration files named \f2META\-INF/services/javax.annotation.processing.Processor\fP on the search path. Such files should contain the names of any annotation processors to be used, listed one per line. Alternatively, processors can be specified explicitly, using the \f3\-processor\fP option. -.LP -.LP -After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process. When a match is found, the processor will be invoked. A processor may "claim" the annotations it processes, in which case no further attempt is made to find any processors for those annotations. Once all annotations have been claimed, the compiler does not look for additional processors. -.LP -.LP -If any processors generate any new source files, another round of annotation processing will occur: any newly generated source files will be scanned, and the annotations processed as before. Any processors invoked on previous rounds will also be invoked on all subsequent rounds. This continues until no new source files are generated. -.LP -.LP -After a round occurs where no new source files are generated, the annotation processors will be invoked one last time, to give them a chance to complete any work they may need to do. Finally, unless the \f3\-proc:only\fP option is used, the compiler will compile the original and all the generated source files. -.LP -.SS -Implicitly loaded source files -.LP -.LP -To compile a set of source files, the compiler may need to implicitly load additional source files. (See Searching For Types). Such files are currently not subject to annotation processing. By default, the compiler will give a warning if annotation processing has occurred and any implicitly loaded source files are compiled. See the \-implicit option for ways to suppress the warning. -.LP -.SH "SEARCHING FOR TYPES" -.LP -.LP -When compiling a source file, the compiler often needs information about a type whose definition did not appear in the source files given on the command line. The compiler needs type information for every class or interface used, extended, or implemented in the source file. This includes classes and interfaces not explicitly mentioned in the source file but which provide information through inheritance. -.LP -.LP -For example, when you subclass \f3java.applet.Applet\fP, you are also using \f3Applet's\fP ancestor classes: \f3java.awt.Panel\fP, \f3java.awt.Container\fP, \f3java.awt.Component\fP, and \f3java.lang.Object\fP. -.LP -.LP -When the compiler needs type information, it looks for a source file or class file which defines the type. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory). The user class path is defined by setting the \f3CLASSPATH\fP environment variable or by using the \f3\-classpath\fP command line option. (For details, see Setting the Class Path). -.LP -.LP -If you set the \-sourcepath option, the compiler searches the indicated path for source files; otherwise the compiler searches the user class path for both class files and source files. -.LP -.LP -You can specify different bootstrap or extension classes with the \f3\-bootclasspath\fP and \f3\-extdirs\fP options; see Cross\-Compilation Options below. -.LP -.LP -A successful type search may produce a class file, a source file, or both. If both are found, you can use the \-Xprefer option to instruct the compiler which to use. If \f3newer\fP is given, the compiler will use the newer of the two files. If \f3source\fP is given, it will use the source file. The default is \f3newer\fP. -.LP -.LP -If a type search finds a source file for a required type, either by itself, or as a result of the setting for \f3\-Xprefer\fP, the compiler will read the source file to get the information it needs. In addition, it will by default compile the source file as well. You can use the \-implicit option to specify the behavior. If \f3none\fP is given, no class files will be generated for the source file. If \f3class\fP is given, class files will be generated for the source file. -.LP -.LP -The compiler may not discover the need for some type information until after annotation processing is complete. If the type information is found in a source file and no \f3\-implicit\fP option is given, the compiler will give a warning that the file is being compiled without being subject to annotation processing. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3\-implicit\fP option to specify whether or not class files should be generated for such source files. -.LP -.SH "PROGRAMMATIC INTERFACE" -.LP -.LP -\f3javac\fP supports the new Java Compiler API defined by the classes and interfaces in the \f2javax.tools\fP package. -.LP -.SS -Example -.LP -.LP -To perform a compilation using arguments as you would give on the command line, you can use the following: -.LP -.nf -\f3 -.fl -JavaCompiler javac = ToolProvider.getSystemJavaCompiler(); -.fl -int rc = javac.run(null, null, null, args); -.fl -\fP -.fi +.TP +unchecked +Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: +.sp +.nf +\f3List l = new ArrayList<Number>();\fP +.fi +.nf +\f3List<String> ls = l; // unchecked warning\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -This will write any diagnostics to the standard output stream, and return the exit code that \f3javac\fP would give when invoked from the command line. -.LP -.LP -You can use other methods on the \f2javax.tools.JavaCompiler\fP interface to handle diagnostics, control where files are read from and written to, and so on. -.LP -.SS -Old Interface -.LP -.LP -\f3Note:\fP This API is retained for backwards compatibility only; all new code should use the Java Compiler API, described above. -.LP -.LP -The \f2com.sun.tools.javac.Main\fP class provides two static methods to invoke the compiler from a program: -.LP -.nf -\f3 -.fl -public static int compile(String[] args); -.fl -public static int compile(String[] args, PrintWriter out); -.fl -\fP -.fi -.LP -.LP -The \f2args\fP parameter represents any of the command line arguments that would normally be passed to the javac program and are outlined in the above Synopsis section. -.LP -.LP -The \f2out\fP parameter indicates where the compiler's diagnostic output is directed. -.LP -.LP -The return value is equivalent to the exit value from \f3javac\fP. -.LP -.LP -Note that all \f3other\fP classes and methods found in a package whose name starts with \f2com.sun.tools.javac\fP (informally known as sub\-packages of \f2com.sun.tools.javac\fP) are strictly internal and subject to change at any time. -.LP -.SH "EXAMPLES" -.LP -.SS -Compiling a Simple Program -.LP -.LP -One source file, \f2Hello.java\fP, defines a class called \f3greetings.Hello\fP. The \f2greetings\fP directory is the package directory both for the source file and the class file and is off the current directory. This allows us to use the default user class path. It also makes it unnecessary to specify a separate destination directory with \f3\-d\fP. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -greetings/ -.fl -% \f3ls greetings\fP -.fl -Hello.java -.fl -% \f3cat greetings/Hello.java\fP -.fl -package greetings; -.fl +During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. -.fl -public class Hello { -.fl - public static void main(String[] args) { -.fl - for (int i=0; i < args.length; i++) { -.fl - System.out.println("Hello " + args[i]); -.fl - } -.fl - } -.fl -} -.fl -% \f3javac greetings/Hello.java\fP -.fl -% \f3ls greetings\fP -.fl -Hello.class Hello.java -.fl -% \f3java greetings.Hello World Universe Everyone\fP -.fl -Hello World -.fl -Hello Universe -.fl -Hello Everyone -.fl -.fi +The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. -.LP -.SS -Compiling Multiple Source Files -.LP -.LP -This example compiles all the source files in the package \f2greetings\fP. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -greetings/ -.fl -% \f3ls greetings\fP -.fl -Aloha.java GutenTag.java Hello.java Hi.java -.fl -% \f3javac greetings/*.java\fP -.fl -% \f3ls greetings\fP -.fl -Aloha.class GutenTag.class Hello.class Hi.class -.fl -Aloha.java GutenTag.java Hello.java Hi.java -.fl -.fi +A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. +.TP +varargs +Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: +.sp +.nf +\f3public class ArrayBuilder {\fP +.fi +.nf +\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP +.fi +.nf +\f3 for (T x : elements) {\fP +.fi +.nf +\f3 listArg\&.add(x);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SS -Specifying a User Class Path -.LP -.LP -Having changed one of the source files in the previous example, we recompile it: -.LP -.nf -\f3 -.fl -% \fP\f3pwd\fP -.fl -/examples -.fl -% \f3javac greetings/Hi.java\fP -.fl -.fi -.LP -.LP -Since \f2greetings.Hi\fP refers to other classes in the \f2greetings\fP package, the compiler needs to find these other classes. The example above works, because our default user class path happens to be the directory containing the package directory. But suppose we want to recompile this file and not worry about which directory we're in? Then we need to add \f2/examples\fP to the user class path. We can do this by setting \f3CLASSPATH\fP, but here we'll use the \f3\-classpath\fP option. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-classpath /examples /examples/greetings/Hi.java\fP -.fl -.fi +\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. -.LP -.LP -If we change \f2greetings.Hi\fP again, to use a banner utility, that utility also needs to be accessible through the user class path. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-classpath /examples:/lib/Banners.jar \\ -.fl - /examples/greetings/Hi.java\fP -.fl -.fi +The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR +.sp +.nf +\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -To execute a class in \f2greetings\fP, we need access both to \f2greetings\fP and to the classes it uses. -.LP -.nf -\f3 -.fl -% \fP\f3java \-classpath /examples:/lib/Banners.jar greetings.Hi\fP -.fl -.fi -.LP -.SS -Separating Source Files and Class Files -.LP -.LP -It often makes sense to keep source files and class files in separate directories, especially on large projects. We use \f3\-d\fP to indicate the separate class file destination. Since the source files are not in the user class path, we use \f3\-sourcepath\fP to help the compiler find them. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -classes/ lib/ src/ -.fl -% \f3ls src\fP -.fl -farewells/ -.fl -% \f3ls src/farewells\fP -.fl -Base.java GoodBye.java -.fl -% \f3ls lib\fP -.fl -Banners.jar -.fl -% \f3ls classes\fP -.fl -% \f3javac \-sourcepath src \-classpath classes:lib/Banners.jar \\ -.fl - src/farewells/GoodBye.java \-d classes\fP -.fl -% \f3ls classes\fP -.fl -farewells/ -.fl -% \f3ls classes/farewells\fP -.fl -Base.class GoodBye.class -.fl -.fi - -.LP -.LP -\f3Note:\fP The compiler compiled \f2src/farewells/Base.java\fP, even though we didn't specify it on the command line. To trace automatic compiles, use the \f3\-verbose\fP option. -.LP -.SS -Cross\-Compilation Example -.LP -.LP -Here we use \f3javac\fP to compile code that will run on a 1.6 VM. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-source 1.6 \-target 1.6 \-bootclasspath jdk1.6.0/lib/rt.jar \\ -.fl - \-extdirs "" OldCode.java\fP -.fl -.fi - -.LP -.LP -The \f2\-source 1.6\fP option specifies that version 1.6 (or 6) of the Java programming language be used to compile \f2OldCode.java\fP. The option \f3\-target 1.6\fP option ensures that the generated class files will be compatible with 1.6 VMs. Note that in most cases, the value of the \f3\-target\fP option is the value of the \f3\-source\fP option; in this example, you can omit the \f3\-target\fP option. -.LP -.LP -You must specify the \f3\-bootclasspath\fP option to specify the correct version of the bootstrap classes (the \f2rt.jar\fP library). If not, the compiler generates a warning: -.LP -.nf -\f3 -.fl -% \fP\f3javac \-source 1.6 OldCode.java\fP -.fl -warning: [options] bootstrap class path not set in conjunction with \-source 1.6 -.fl -.fi - -.LP -.LP -If you do not specify the correct version of bootstrap classes, the compiler will use the old language rules (in this example, it will use version 1.6 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to non\-existent methods can get included. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -.na -\f2The javac Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javac/index.html -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jdb(1) \- Java Application Debugger -.TP 2 -o -javah(1) \- C Header and Stub File Generator -.TP 2 -o -javap(1) \- Class File Disassembler -.TP 2 -o -javadoc(1) \- API Documentation Generator -.TP 2 -o -jar(1) \- JAR Archive Tool -.TP 2 -o -.na -\f2The Java Extensions Framework\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html -.RE - -.LP - +When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: +.sp +.nf +\f3javac @argfile\fP +.fi +.nf +\f3\fP +.fi +.sp +This argument file could contain the contents of both files shown in Example 2 +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains the following: +.sp +.nf +\f3\-d classes\fP +.fi +.nf +\f3\-g\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named classes that contains the following: +.sp +.nf +\f3MyClass1\&.java\fP +.fi +.nf +\f3MyClass2\&.java\fP +.fi +.nf +\f3MyClass3\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Then, run the \f3javac\fR command as follows: +.sp +.nf +\f3javac @options @classes\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javac @path1/options @path2/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH ANNOTATION\ PROCESSING +The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. +.PP +The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. +.SS HOW\ ANNOTATION\ PROCESSING\ WORKS +Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. +.PP +After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. +.PP +If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. +.PP +After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. +.SS IMPLICITLY\ LOADED\ SOURCE\ FILES +To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. +.SH SEARCHING\ FOR\ TYPES +To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. +.PP +For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. +.PP +When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. +.PP +If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. +.PP +You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. +.PP +A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. +.PP +If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. +.PP +The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. +.SH PROGRAMMATIC\ INTERFACE +The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. +.SS EXAMPLE +To compile as though providing command-line arguments, use the following syntax: +.sp +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3\fP +.fi +.sp +The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. +.PP +You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. +.SS OLD\ INTERFACE +\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. +.PP +The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: +.sp +.nf +\f3public static int compile(String[] args);\fP +.fi +.nf +\f3public static int compile(String[] args, PrintWriter out);\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. +.PP +The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. +.PP +The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. +.PP +\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. +.SH EXAMPLES +\f3Example 1 Compile a Simple Program\fR +.PP +This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. +.PP +The source code in \f3Hello\&.java\fR: +.sp +.nf +\f3package greetings;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Hello {\fP +.fi +.nf +\f3 public static void main(String[] args) {\fP +.fi +.nf +\f3 for (int i=0; i < args\&.length; i++) {\fP +.fi +.nf +\f3 System\&.out\&.println("Hello " + args[i]);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +Compile greetings\&.Hello: +.sp +.nf +\f3javac greetings/Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Run \f3greetings\&.Hello\fR: +.sp +.nf +\f3java greetings\&.Hello World Universe Everyone\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3Hello Universe\fP +.fi +.nf +\f3Hello Everyone\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Compile Multiple Source Files\fR +.PP +This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. +.sp +.nf +\f3% javac greetings/*\&.java\fP +.fi +.nf +\f3% ls greetings\fP +.fi +.nf +\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP +.fi +.nf +\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Specify a User Class Path\fR +.PP +After changing one of the source files in the previous example, recompile it: +.sp +.nf +\f3pwd\fP +.fi +.nf +\f3/examples\fP +.fi +.nf +\f3javac greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. +.sp +.nf +\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. +.sp +.nf +\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP +.fi +.nf +\f3 /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. +.sp +.nf +\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Separate Source Files and Class Files\fR +.PP +The following example uses \f3javac\fR to compile code that runs on JVM 1\&.6\&. +.sp +.nf +\f3javac \-source 1\&.6 \-target 1\&.6 \-bootclasspath jdk1\&.6\&.0/lib/rt\&.jar \e \fP +.fi +.nf +\f3\-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3-source 1\&.6\fR option specifies that release 1\&.6 (or 6) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.6\fR option ensures that the generated class files are compatible with JVM 1\&.6\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.6 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \fP +.fi +.nf +\f3\-source 1\&.6\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.6 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to nonexistent methods can get included\&. +.PP +\f3Example 5 Cross Compile\fR +.PP +This example uses \f3javac\fR to compile code that runs on JVM 1\&.6\&. +.sp +.nf +\f3javac \-source 1\&.6 \-target 1\&.6 \-bootclasspath jdk1\&.6\&.0/lib/rt\&.jar \e\fP +.fi +.nf +\f3 \-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The\f3-source 1\&.6\fR option specifies that release 1\&.6 (or 6) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.6\fR option ensures that the generated class files are compatible with JVM 1\&.6\&. In most cases, the value of the \f3-target\fR is the value of \f3-source\fR\&. In this example, the \f3-target\fR option is omitted\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.6 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.6\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.6 of the Java programming language\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jdb(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/javadoc.1 b/jdk/src/linux/doc/man/javadoc.1 index 34ac8103628..b48535a388a 100644 --- a/jdk/src/linux/doc/man/javadoc.1 +++ b/jdk/src/linux/doc/man/javadoc.1 @@ -1,4226 +1,2997 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javadoc 1 "10 May 2011" -.SH "Name" -javadoc \- The Java API Documentation Generator -.LP -Generates HTML pages of API documentation from Java source files. This document contains Javadoc examples for Solaris. -.SH "SYNOPSIS" -.LP -\f4javadoc\fP\f2\ [\ \fP\f2options\fP\f2\ ]\ [\ packagenames\ ]\ [\ sourcefilenames\ ]\ [\ \-subpackages\fP\ \f2pkg1:pkg2:...\fP\f2\ ]\ [\ \fP\f2@argfiles\fP\f2\ ]\fP -.LP -Arguments can be in any order. See processing of Source Files for details on how the Javadoc tool determines which "\f2.java\fP" files to process. -.RS 3 -.TP 3 -options -Command\-line options, as specified in this document. To see a typical use of javadoc options, see Real\-World Example. -.TP 3 -packagenames -A series of names of packages, separated by spaces, such as \f2java.lang\ java.lang.reflect\ java.awt\fP. You must separately specify each package you want to document. Wildcards are not allowed; use \-subpackages for recursion. The Javadoc tool uses \f2\-sourcepath\fP to look for these package names. See Example \- Documenting One or More Packages -.TP 3 -sourcefilenames -A series of source file names, separated by spaces, each of which can begin with a path and contain a wildcard such as asterisk (*). The Javadoc tool will process every file whose name ends with ".java", and whose name, when stripped of that suffix, is actually a legal class name (see the Java Language Specification). Therefore, you can name files with dashes (such as \f2X\-Buffer\fP), or other illegal characters, to prevent them from being documented. This is useful for test files and template files The path that precedes the source file name determines where javadoc will look for the file. (The Javadoc tool does \f2not\fP use \f2\-sourcepath\fP to look for these source file names.) Relative paths are relative to the current directory, so passing in \f2Button.java\fP is identical to \f2./Button.java\fP. A source file name with an absolute path and a wildcard, for example, is \f2/home/src/java/awt/Graphics*.java\fP. See Example\ \-\ Documenting One or More Classes. You can also mix packagenames and sourcefilenames, as in Example\ \-\ Documenting Both Packages and Classes -.TP 3 -\-subpackages pkg1:pkg2:... -Generates documentation from source files in the specified packages and recursively in their subpackages. An alternative to supplying packagenames or sourcefilenames. -.TP 3 -@argfiles -One or more files that contain a list of Javadoc options, packagenames and sourcefilenames in any order. Wildcards (*) and \f2\-J\fP options are not allowed in these files. -.RE -.SH "DESCRIPTION" -.LP -The \f3Javadoc\fP tool parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields. You can use it to generate the API (Application Programming Interface) documentation or the implementation documentation for a set of source files. -.LP -You can run the Javadoc tool on entire packages, individual source files, or both. When documenting entire packages, you can either use \f2\-subpackages\fP for traversing recursively down from a top\-level directory, or pass in an explicit list of package names. When documenting individual source files, you pass in a list of source (\f2.java\fP) filenames. Examples are given at the end of this document. How Javadoc processes source files is covered next. -.SS -Processing of source files -.LP -The Javadoc tool processes files that end in "\f2.java\fP" plus other files described under Source Files. If you run the Javadoc tool by explicitly passing in individual source filenames, you can determine exactly which "\f2.java\fP" files are processed. However, that is not how most developers want to work, as it is simpler to pass in package names. The Javadoc tool can be run three ways without explicitly specifying the source filenames. You can (1) pass in package names, (2) use \f2\-subpackages\fP, and (3) use wildcards with source filenames (\f2*.java\fP). In these cases, the Javadoc tool processes a "\f2.java\fP" file only if it fulfills all of the following requirements: -.RS 3 -.TP 2 -o -Its name, after stripping off the "\f2.java\fP" suffix, is actually a legal class name (see the Java Language Specification for legal characters) -.TP 2 -o -Its directory path relative to the root of the source tree is actually a legal package name (after converting its separators to dots) -.TP 2 -o -Its package statement contains the legal package name (specified in the previous bullet) -.RE -.LP -\f3Processing of links\fP \- During a run, the Javadoc tool automatically adds cross\-reference links to package, class and member names that are being documented as part of that run. Links appear in several places: -.RS 3 -.TP 2 -o -Declarations (return types, argument types, field types) -.TP 2 -o -"See Also" sections generated from \f2@see\fP tags -.TP 2 -o -In\-line text generated from \f2{@link}\fP tags -.TP 2 -o -Exception names generated from \f2@throws\fP tags -.TP 2 -o -"Specified by" links to members in interfaces and "Overrides" links to members in classes -.TP 2 -o -Summary tables listing packages, classes and members -.TP 2 -o -Package and class inheritance trees -.TP 2 -o -The index -.RE -.LP -You can add hyperlinks to existing text for classes not included on the command line (but generated separately) by way of the \f2\-link\fP and \f2\-linkoffline\fP options. -.LP -\f3Other processing details\fP \- The Javadoc tool produces one complete document each time it is run; it cannot do incremental builds \-\- that is, it cannot modify or \f2directly\fP incorporate results from previous runs of the Javadoc tool. However, it can link to results from other runs, as just mentioned. -.LP -As implemented, the Javadoc tool requires and relies on the java compiler to do its job. The Javadoc tool calls part of \f2javac\fP to compile the declarations, ignoring the member implementation. It builds a rich internal representation of the classes, including the class hierarchy, and "use" relationships, then generates the HTML from that. The Javadoc tool also picks up user\-supplied documentation from documentation comments in the source code. -.LP -In fact, the Javadoc tool will run on \f2.java\fP source files that are pure stub files with no method bodies. This means you can write documentation comments and run the Javadoc tool in the earliest stages of design while creating the API, before writing the implementation. -.LP -Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code. For example, the Javadoc tool documents default constructors (see Java Language Specification) that are present in the \f2.class\fP files but not in the source code. -.LP -In many cases, the Javadoc tool allows you to generate documentation for source files whose code is incomplete or erroneous. This is a benefit that enables you to generate documentation before all debugging and troubleshooting is done. For example, according to the \f2Java Language Specification\fP, a class that contains an abstract method should itself be declared abstract. The Javadoc tool does not check for this, and would proceed without a warning, whereas the javac compiler stops on this error. The Javadoc tool does do some primitive checking of doc comments. Use the DocCheck doclet to check the doc comments more thoroughly. -.LP -When the Javadoc tool builds its internal structure for the documentation, it loads all referenced classes. Because of this, the Javadoc tool must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes. For more about this, see -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html. Generally speaking, classes you create must either be loaded as an extension or in the Javadoc tool's class path. -.SS -Javadoc Doclets -.LP -You can customize the content and format of the Javadoc tool's output by using doclets. The Javadoc tool has a default "built\-in" doclet, called the standard doclet, that generates HTML\-formatted API documentation. You can modify or subclass the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you'd like. Information about doclets and their use is at the following locations: -.RS 3 -.TP 2 -o -.na -\f2Javadoc Doclets\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html -.TP 2 -o -The \f2\-doclet\fP command\-line option -.RE -.LP -When a custom doclet is not specified with the \f2\-doclet\fP command line option, the Javadoc tool will use the default standard doclet. The javadoc tool has several command line options that are available regardless of which doclet is being used. The standard doclet adds a supplementary set of command line options. Both sets of options are described below in the options section. -.SS -Related Documentation and Doclets -.RS 3 -.TP 2 -o -.na -\f2Javadoc Enhancements\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html for details about improvements added in Javadoc. -.TP 2 -o -.na -\f2Javadoc FAQ\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html for answers to common questions, information about Javadoc\-related tools, and workarounds for bugs. -.TP 2 -o -.na -\f2How to Write Doc Comments for Javadoc\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html for more information about Sun conventions for writing documentation comments. -.TP 2 -o -.na -\f2Requirements for Writing API Specifications\fP @ -.fi -http://java.sun.com/j2se/javadoc/writingapispecs/index.html \- Standard requirements used when writing the Java SE Platform Specification. It can be useful whether you are writing API specifications in source file documentation comments or in other formats. It covers requirements for packages, classes, interfaces, fields and methods to satisfy testable assertions. -.TP 2 -o -.na -\f2Documentation Comment Specification\fP @ -.fi -http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html \- The original specification on documentation comments, Chapter 18, Documentation Comments, in the \f2Java Language Specification\fP, First Edition, by James Gosling, Bill Joy, and Guy Steele. (This chapter was removed from the second edition.) -.TP 2 -o -.na -\f2DocCheck Doclet\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-141437.html \- Checks doc comments in source files and generates a report listing the errors and irregularities it finds. It is part of the Doc Check Utilities. -.TP 2 -o -.na -\f2MIF Doclet\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/ \- Can automate the generation of API documentation in MIF, FrameMaker and PDF formats. MIF is Adobe FrameMaker's interchange format. -.RE -.SS -Terminology -.LP -The terms \f2documentation comment\fP, \f2doc comment\fP, \f2main description\fP, \f2tag\fP, \f2block tag\fP, and \f2in\-line tag\fP are described at Documentation Comments. These other terms have specific meanings within the context of the Javadoc tool: -.RS 3 -.TP 3 -generated document -The document generated by the javadoc tool from the doc comments in Java source code. The default generated document is in HTML and is created by the standard doclet. -.LP -.TP 3 -name -A name of a program element written in the Java Language \-\- that is, the name of a package, class, interface, field, constructor or method. A name can be fully\-qualified, such as \f2java.lang.String.equals(java.lang.Object)\fP, or partially\-qualified, such as \f2equals(Object)\fP. -.LP -.TP 3 -documented classes -The classes and interfaces for which detailed documentation is generated during a javadoc run. To be documented, the source files must be available, their source filenames or package names must be passed into the javadoc command, and they must not be filtered out by their access modifier (public, protected, package\-private or private). We also refer to these as the classes included in the javadoc output, or the \f2included classes\fP. -.LP -.TP 3 -included classes -Classes and interfaces whose details are documented during a run of the Javadoc tool. Same as \f2documented classes\fP. -.LP -.TP 3 -excluded classes -Classes and interfaces whose details are \f2not\fP documented during a run of the Javadoc tool. -.LP -.TP 3 -referenced classes -The classes and interfaces that are explicitly referred to in the definition (implementation) or doc comments of the documented classes and interfaces. Examples of references include return type, parameter type, cast type, extended class, implemented interface, imported classes, classes used in method bodies, @see, {@link}, {@linkplain}, and {@inheritDoc} tags. (Notice this definition has changed since -.na -\f21.3\fP @ -.fi -http://download.oracle.com/javase/1.3/docs/tooldocs/solaris/javadoc.html#referencedclasses.) When the Javadoc tool is run, it should load into memory all of the referenced classes in javadoc's bootclasspath and classpath. (The Javadoc tool prints a "Class not found" warning for referenced classes not found.) The Javadoc tool can derive enough information from the .class files to determine their existence and the fully\-qualified names of their members. -.LP -.TP 3 -external referenced classes -The referenced classes whose documentation is not being generated during a javadoc run. In other words, these classes are not passed into the Javadoc tool on the command line. Links in the generated documentation to those classes are said to be \f2external references\fP or \f2external links\fP. For example, if you run the Javadoc tool on only the \f2java.awt\fP package, then any class in \f2java.lang\fP, such as \f2Object\fP, is an external referenced class. External referenced classes can be linked to using the \f2\-link\fP and \f2\-linkoffline\fP options. An important property of an external referenced class is that its source comments are normally not available to the Javadoc run. In this case, these comments cannot be inherited. -.RE -.SH "SOURCE FILES" -.LP -The Javadoc tool will generate output originating from four different types of "source" files: Java language source files for classes (\f2.java\fP), package comment files, overview comment files, and miscellaneous unprocessed files. This section also covers test files and template files that can also be in the source tree, but which you want to be sure not to document. -.SS -Class Source Code Files -.LP -Each class or interface and its members can have their own documentation comments, contained in a \f2.java\fP file. For more details about these doc comments, see Documentation Comments. -.SS -Package Comment Files -.LP -Each package can have its own documentation comment, contained in its own "source" file, that the Javadoc tool will merge into the package summary page that it generates. You typically include in this comment any documentation that applies to the entire package. -.LP -To create a package comment file, you have a choice of two files to place your comments: -.RS 3 -.TP 2 -o -\f2package\-info.java\fP \- Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is generally preferred over package.html. -.TP 2 -o -\f2package.html\fP \- Can contain only package comments and Javadoc tags, no package annotations. -.RE -.LP -A package may have a single \f2package.html\fP file or a single \f2package\-info.java\fP file but not both. Place either file in the package directory in the source tree along with your \f2.java\fP files. -.LP -\f4package\-info.java\fP \- This file can contain a package comment of the following structure \-\- the comment is placed before the package declaration: -.LP -File: \f2java/applet/package\-info.java\fP -.nf -\f3 -.fl -/** -.fl - * Provides the classes necessary to create an -.fl - * applet and the classes an applet uses -.fl - * to communicate with its applet context. -.fl - * <p> -.fl - * The applet framework involves two entities: -.fl - * the applet and the applet context. -.fl - * An applet is an embeddable window (see the -.fl - * {@link java.awt.Panel} class) with a few extra -.fl - * methods that the applet context can use to -.fl - * initialize, start, and stop the applet. -.fl - * -.fl - * @since 1.0 -.fl - * @see java.awt -.fl - */ -.fl -package java.lang.applet; -.fl -\fP -.fi -.LP -Note that while the comment separators \f2/**\fP and \f2/*\fP must be present, the leading asterisks on the intermediate lines can be omitted. -.LP -\f4package.html\fP \- This file can contain a package comment of the following structure \-\- the comment is placed in the \f2<body>\fP element: -.LP -File: \f2java/applet/package.html\fP -.nf -\f3 -.fl -<HTML> -.fl -<BODY> -.fl -Provides the classes necessary to create an applet and the -.fl -classes an applet uses to communicate with its applet context. -.fl -<p> -.fl -The applet framework involves two entities: the applet -.fl -and the applet context. An applet is an embeddable -.fl -window (see the {@link java.awt.Panel} class) with a -.fl -few extra methods that the applet context can use to -.fl -initialize, start, and stop the applet. -.fl +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 10 May 2011 +.\" SectDesc: Basic Tools +.\" Title: javadoc.1 +.\" +.if n .pl 99999 +.TH javadoc 1 "10 May 2011" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.fl -@since 1.0 -.fl -@see java.awt -.fl -</BODY> -.fl -</HTML> -.fl -\fP -.fi -.LP -Notice this is just a normal HTML file and does not include a package declaration. The content of the package comment file is written in HTML, like all other comments, with one exception: The documentation comment should not include the comment separators \f2/**\fP and \f2*/\fP or leading asterisks. When writing the comment, you should make the first sentence a summary about the package, and not put a title or any other text between \f2<body>\fP and the first sentence. You can include package tags; as with any documentation comment, all block tags must appear after the main description. If you add a \f2@see\fP tag in a package comment file, it must have a fully\-qualified name. For more details, see the -.na -\f2example of \fP\f2package.html\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#packagecomments. -.LP -\f3Processing of package comment file\fP \- When the Javadoc tool runs, it will automatically look for the package comment file; if found, the Javadoc tool does the following: -.RS 3 -.TP 2 -o -Copies the comment for processing. (For \f2package.html\fP, copies all content between \f2<body>\fP and \f2</body>\fP HTML tags. You can include a \f2<head>\fP section to put a \f2<title>\fP, source file copyright statement, or other information, but none of these will appear in the generated documentation.) -.TP 2 -o -Processes any package tags that are present. -.TP 2 -o -Inserts the processed text at the bottom of the package summary page it generates, as shown in -.na -\f2Package Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/applet/package\-summary.html. -.TP 2 -o -Copies the first sentence of the package comment to the top of the package summary page. It also adds the package name and this first sentence to the list of packages on the overview page, as shown in -.na -\f2Overview Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/overview\-summary.html. The end\-of\-sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions. -.RE -.SS -Overview Comment File -.LP -Each application or set of packages that you are documenting can have its own overview documentation comment, kept in its own "source" file, that the Javadoc tool will merge into the overview page that it generates. You typically include in this comment any documentation that applies to the entire application or set of packages. -.LP -To create an overview comment file, you can name the file anything you want, typically \f4overview.html\fP and place it anywhere, typically at the top level of the source tree. For example, if the source files for the \f2java.applet\fP package are contained in \f2/home/user/src/java/applet\fP directory, you could create an overview comment file at \f2/home/user/src/overview.html\fP. -.LP -Notice you can have multiple overview comment files for the same set of source files, in case you want to run javadoc multiple times on different sets of packages. For example, you could run javadoc once with \-private for internal documentation and again without that option for public documentation. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file. -.LP -The content of the overview comment file is one big documentation comment, written in HTML, like the package comment file described previously. See that description for details. To re\-iterate, when writing the comment, you should make the first sentence a summary about the application or set of packages, and not put a title or any other text between \f2<body>\fP and the first sentence. You can include overview tags; as with any documentation comment, all tags except in\-line tags, such as \f2{@link}\fP, must appear after the main description. If you add a \f2@see\fP tag, it must have a fully\-qualified name. -.LP -When you run the Javadoc tool, you specify the overview comment file name with the \-overview option. The file is then processed similar to that of a package comment file. -.RS 3 -.TP 2 -o -Copies all content between \f2<body>\fP and \f2</body>\fP tags for processing. -.TP 2 -o -Processes any overview tags that are present. -.TP 2 -o -Inserts the processed text at the bottom of the overview page it generates, as shown in -.na -\f2Overview Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/overview\-summary.html. -.TP 2 -o -Copies the first sentence of the overview comment to the top of the overview summary page. -.RE -.SS -Miscellaneous Unprocessed Files -.LP -You can also include in your source any miscellaneous files that you want the Javadoc tool to copy to the destination directory. These typically includes graphic files, example Java source (.java) and class (.class) files, and self\-standing HTML files whose content would overwhelm the documentation comment of a normal Java source file. -.LP -To include unprocessed files, put them in a directory called \f4doc\-files\fP which can be a subdirectory of any package directory that contains source files. You can have one such subdirectory for each package. You might include images, example code, source files, .class files, applets and HTML files. For example, if you want to include the image of a button \f2button.gif\fP in the \f2java.awt.Button\fP class documentation, you place that file in the \f2/home/user/src/java/awt/doc\-files/\fP directory. Notice the \f2doc\-files\fP directory should not be located at \f2/home/user/src/java/doc\-files\fP because \f2java\fP is not a package \-\- that is, it does not directly contain any source files. -.LP -All links to these unprocessed files must be hard\-coded, because the Javadoc tool does not look at the files \-\- it simply copies the directory and all its contents to the destination. For example, the link in the \f2Button.java\fP doc comment might look like: -.nf -\f3 -.fl - /** -.fl - * This button looks like this: -.fl - * <img src="doc\-files/Button.gif"> -.fl - */ -.fl -\fP -.fi -.SS -Test Files and Template Files -.LP -Some developers have indicated they want to store test files and templates files in the source tree near their corresponding source files. That is, they would like to put them in the same directory, or a subdirectory, of those source files. -.LP -If you run the Javadoc tool by explicitly passing in individual source filenames, you can deliberately omit test and templates files and prevent them from being processed. However, if you are passing in package names or wildcards, you need to follow certain rules to ensure these test files and templates files are not processed. -.LP -Test files differ from template files in that the former are legal, compilable source files, while the latter are not, but may end with ".java". -.LP -\f3Test files\fP \- Often developers want to put compilable, runnable test files for a given package in the \f2same\fP directory as the source files for that package. But they want the test files to belong to a package other than the source file package, such as the unnamed package (so the test files have no package statement or a different package statement from the source). In this scenario, when the source is being documented by specifying its package name specified on the command line, the test files will cause warnings or errors. You need to put such test files in a subdirectory. For example, if you want to add test files for source files in \f2com.package1\fP, put them in a subdirectory that would be an invalid package name (because it contains a hyphen): -.nf -\f3 -.fl - com/package1/test\-files/ -.fl -\fP -.fi -.LP -The test directory will be skipped by the Javadoc tool with no warnings. -.LP -If your test files contain doc comments, you can set up a separate run of the Javadoc tool to produce documentation of the test files by passing in their test source filenames with wildcards, such as \f2com/package1/test\-files/*.java\fP. -.LP -\f3Templates for source files\fP \- Template files have names that often end in ".java" and are not compilable. If you have a template for a source file that you want to keep in the source directory, you can name it with a dash (such as \f2Buffer\-Template.java\fP), or any other illegal Java character, to prevent it from being processed. This relies on the fact that the Javadoc tool will only process source files whose name, when stripped of the ".java" suffix, is actually a legal class name (see information about Identifiers in the Java Language Specification). -.SH "GENERATED FILES" -.LP -By default, javadoc uses a standard doclet that generates HTML\-formatted documentation. This doclet generates the following kinds of files (where each HTML "page" corresponds to a separate file). Note that javadoc generates files with two types of names: those named after classes/interfaces, and those that are not (such as \f2package\-summary.html\fP). Files in the latter group contain hyphens to prevent filename conflicts with those in the former group. -.LP -\f3Basic Content Pages\fP -.RS 3 -.TP 2 -o -One \f3class or interface page\fP (\f2classname\fP\f2.html\fP) for each class or interface it is documenting. -.TP 2 -o -One \f3package page\fP (\f2package\-summary.html\fP) for each package it is documenting. The Javadoc tool will include any HTML text provided in a file named \f2package.html\fP or \f2package\-info.java\fP in the package directory of the source tree. -.TP 2 -o -One \f3overview page\fP (\f2overview\-summary.html\fP) for the entire set of packages. This is the front page of the generated document. The Javadoc tool will include any HTML text provided in a file specified with the \f2\-overview\fP option. Note that this file is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) -.RE -.LP -\f3Cross\-Reference Pages\fP -.RS 3 -.TP 2 -o -One \f3class hierarchy page for the entire set of packages\fP (\f2overview\-tree.html\fP). To view this, click on "Overview" in the navigation bar, then click on "Tree". -.TP 2 -o -One \f3class hierarchy page for each package\fP (\f2package\-tree.html\fP) To view this, go to a particular package, class or interface page; click "Tree" to display the hierarchy for that package. -.TP 2 -o -One \f3"use" page\fP for each package (\f2package\-use.html\fP) and a separate one for each class and interface (\f2class\-use/\fP\f2classname\fP\f2.html\fP). This page describes what packages, classes, methods, constructors and fields use any part of the given class, interface or package. Given a class or interface A, its "use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar. -.TP 2 -o -A \f3deprecated API page\fP (\f2deprecated\-list.html\fP) listing all deprecated names. (A deprecated name is not recommended for use, generally due to improvements, and a replacement name is usually given. Deprecated APIs may be removed in future implementations.) -.TP 2 -o -A \f3constant field values page\fP (\f2constant\-values.html\fP) for the values of static fields. -.TP 2 -o -A \f3serialized form page\fP (\f2serialized\-form.html\fP) for information about serializable and externalizable classes. Each such class has a description of its serialization fields and methods. This information is of interest to re\-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class comment. The standard doclet automatically generates a serialized form page: any class (public or non\-public) that implements Serializable is included, along with \f2readObject\fP and \f2writeObject\fP methods, the fields that are serialized, and the doc comments from the \f2@serial\fP, \f2@serialField\fP, and \f2@serialData\fP tags. Public serializable classes can be excluded by marking them (or their package) with \f2@serial exclude\fP, and package\-private serializable classes can be included by marking them (or their package) with \f2@serial include\fP. As of 1.4, you can generate the complete serialized form for public and private classes by running javadoc \f2without\fP specifying the \f2\-private\fP option. -.TP 2 -o -An \f3index\fP (\f2index\-*.html\fP) of all class, interface, constructor, field and method names, alphabetically arranged. This is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\-Z for English). -.RE -.LP -\f3Support Files\fP -.RS 3 -.TP 2 -o -A \f3help page\fP (\f2help\-doc.html\fP) that describes the navigation bar and the above pages. You can provide your own custom help file to override the default using \f2\-helpfile\fP. -.TP 2 -o -One \f3index.html file\fP which creates the HTML frames for display. This is the file you load to display the front page with frames. This file itself contains no text content. -.TP 2 -o -Several \f3frame files\fP (\f2*\-frame.html\fP) containing lists of packages, classes and interfaces, used when HTML frames are being displayed. -.TP 2 -o -A \f3package list\fP file (\f2package\-list\fP), used by the \f2\-link\fP and \f2\-linkoffline\fP options. This is a text file, not HTML, and is not reachable through any links. -.TP 2 -o -A \f3style sheet\fP file (\f2stylesheet.css\fP) that controls a limited amount of color, font family, font size, font style and positioning on the generated pages. -.TP 2 -o -A \f3doc\-files\fP directory that holds any image, example, source code or other files that you want copied to the destination directory. These files are not processed by the Javadoc tool in any manner \-\- that is, any javadoc tags in them will be ignored. This directory is not generated unless it exists in the source tree. -.RE -.LP -\f3HTML Frames\fP -.LP -The Javadoc tool will generate either two or three HTML frames, as shown in the figure below. It creates the minimum necessary number of frames by omitting the list of packages if there is only one package (or no packages). That is, when you pass a single package name or source files (*.java) belonging to a single package as arguments into the javadoc command, it will create only one frame (C) in the left\-hand column \-\- the list of classes. When you pass into javadoc two or more package names, it creates a third frame (P) listing all packages, as well as an overview page (Detail). This overview page has the filename \f2overview\-summary.html\fP. Thus, this file is created only if you pass in two or more package names. You can bypass frames by clicking on the "No Frames" link or entering at overview\-summary.html. -.LP -If you are unfamiliar with HTML frames, you should be aware that frames can have \f2focus\fP for printing and scrolling. To give a frame focus, click on it. Then on many browsers the arrow keys and page keys will scroll that frame, and the print menu command will print it. -.LP -Load one of the following two files as the starting page depending on whether you want HTML frames or not: -.RS 3 -.TP 2 -o -\f2index.html\fP (for frames) -.TP 2 -o -\f2overview\-summary.html\fP (for no frames) -.RE -.LP -\f3Generated File Structure\fP -.LP -The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized. This structure is one directory per subpackage. -.LP -For example, the document generated for the class \f2java.applet.Applet\fP class would be located at \f2java/applet/Applet.html\fP. The file structure for the java.applet package follows, given that the destination directory is named \f2apidocs\fP. All files that contain the word "frame" appear in the upper\-left or lower\-left frames, as noted. All other HTML files appear in the right\-hand frame. -.LP -NOTE \- Directories are shown in \f3bold\fP. The asterisks (\f2*\fP) indicate the files and directories that are \f2omitted\fP when the arguments to javadoc are source filenames (*.java) rather than package names. Also when arguments are source filenames, \f2package\-list\fP is created but is empty. The doc\-files directory will not be created in the destination unless it exists in the source tree. -.nf -\f3 -.fl +.SH NAME +javadoc \- Generates HTML pages of API documentation from Java source files\&. +.SH SYNOPSIS +.sp +.nf -.fl -\fP\f3apidocs\fP Top directory -.fl - index.html Initial page that sets up HTML frames -.fl - * overview\-summary.html Lists all packages with first sentence summaries -.fl - overview\-tree.html Lists class hierarchy for all packages -.fl - deprecated\-list.html Lists deprecated API for all packages -.fl - constant\-values.html Lists values of static fields for all packages -.fl - serialized\-form.html Lists serialized form for all packages -.fl - * overview\-frame.html Lists all packages, used in upper\-left frame -.fl - allclasses\-frame.html Lists all classes for all packages, used in lower\-left frame -.fl - help\-doc.html Lists user help for how these pages are organized -.fl - index\-all.html Default index created without \-splitindex option -.fl - \f3index\-files\fP Directory created with \-splitindex option -.fl - index\-<number>.html Index files created with \-splitindex option -.fl - package\-list Lists package names, used only for resolving external refs -.fl - stylesheet.css HTML style sheet for defining fonts, colors and positions -.fl - \f3java\fP Package directory -.fl - \f3applet\fP Subpackage directory -.fl - Applet.html Page for Applet class -.fl - AppletContext.html Page for AppletContext interface -.fl - AppletStub.html Page for AppletStub interface -.fl - AudioClip.html Page for AudioClip interface -.fl - * package\-summary.html Lists classes with first sentence summaries for this package -.fl - * package\-frame.html Lists classes in this package, used in lower left\-hand frame -.fl - * package\-tree.html Lists class hierarchy for this package -.fl - package\-use Lists where this package is used -.fl - \f3doc\-files\fP Directory holding image and example files -.fl - \f3class\-use\fP Directory holding pages API is used -.fl - Applet.html Page for uses of Applet class -.fl - AppletContext.html Page for uses of AppletContext interface -.fl - AppletStub.html Page for uses of AppletStub interface -.fl - AudioClip.html Page for uses of AudioClip interface -.fl - \f3src\-html\fP Source code directory -.fl - \f3java\fP Package directory -.fl - \f3applet\fP Subpackage directory -.fl - Applet.html Page for Applet source code -.fl - AppletContext.html Page for AppletContext source code -.fl - AppletStub.html Page for AppletStub source code -.fl - AudioClip.html Page for AudioClip source code -.fl -.fi -.SS -Generated API Declarations -.LP -The Javadoc tool generates a declaration at the start of each class, interface, field, constructor, and method description for that API item. For example, the declaration for the \f2Boolean\fP class is: -.LP -\f2public final class Boolean\fP -.br -\f2extends Object\fP -.br -\f2implements Serializable\fP -.LP -and the declaration for the \f2Boolean.valueOf\fPmethod is: -.LP -\f2public static Boolean valueOf(String s)\fP -.LP -The Javadoc tool can include the modifiers \f2public\fP, \f2protected\fP, \f2private\fP, \f2abstract\fP, \f2final\fP, \f2static\fP, \f2transient\fP, and \f2volatile\fP, but not \f2synchronized\fP or \f2native\fP. These last two modifiers are considered implementation detail and not part of the API specification. -.LP -Rather than relying on the keyword \f2synchronized\fP, APIs should document their concurrency semantics in the comment's main description, as in "a single \f2Enumeration\fP cannot be used by multiple threads concurrently". The document should not describe how to achieve these semantics. As another example, while \f2Hashtable\fP should be thread\-safe, there's no reason to specify that we achieve this by synchronizing all of its exported methods. We should reserve the right to synchronize internally at the bucket level, thus offering higher concurrency. -.SH "DOCUMENTATION COMMENTS" -.LP -The original "Documentation Comment Specification" can be found under related documentation. -.SS -Commenting the Source Code -.LP -You can include \f2documentation comments\fP ("doc comments") in the source code, ahead of declarations for any class, interface, method, constructor, or field. You can also create doc comments for each package and another one for the overview, though their syntax is slightly different. Doc comments are also known informally as "Javadoc comments" (but this term violates its trademark usage). A doc comment consists of the characters between the characters \f2/**\fP that begin the comment and the characters \f2*/\fP that end it. Leading asterisks are allowed on each line and are described further below. The text in a comment can continue onto multiple lines. -.nf -\f3 -.fl -/** -.fl - * This is the typical format of a simple documentation comment -.fl - * that spans two lines. -.fl - */ -.fl -\fP -.fi -.LP +\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] +.fi +.sp +.TP +\fIpackages\fR +Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. + +By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. +.TP +\fIsource-files\fR +Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. +.TP +\fIoptions\fR +Command-line options, separated by spaces\&. See Options\&. +.TP +\fI@argfiles\fR +Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. +.SH DESCRIPTION +The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. +.PP +You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. +.SS PROCESS\ SOURCE\ FILES +The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: +.TP 0.2i +\(bu +The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. +.TP 0.2i +\(bu +The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. +.TP 0.2i +\(bu +The package statement contains the valid package name\&. +.PP +Processing Links + +During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. +.TP 0.2i +\(bu +Declarations (return types, argument types, and field types)\&. +.TP 0.2i +\(bu +\fISee Also\fR sections that are generated from \f3@see\fR tags\&. +.TP 0.2i +\(bu +Inline text generated from \f3{@link}\fR tags\&. +.TP 0.2i +\(bu +Exception names generated from \f3@throws\fR tags\&. +.TP 0.2i +\(bu +\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. +.TP 0.2i +\(bu +Summary tables listing packages, classes and members\&. +.TP 0.2i +\(bu +Package and class inheritance trees\&. +.TP 0.2i +\(bu +The index\&. +.PP +You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. +.PP +Processing Details + +The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. +.PP +The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. +.PP +The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. +.PP +Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. +.PP +In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. +.PP +When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.PP +Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. +.SS JAVADOC\ DOCLETS +You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. +.PP +When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. +.SH SOURCE\ FILES +The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. +.SS CLASS\ SOURCE\ FILES +Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. +.SS PACKAGE\ COMMENT\ FILES +Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. +.PP +To create a package comment file, you can place your comments in one of the following files: +.TP 0.2i +\(bu +The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. +.TP 0.2i +\(bu +The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. +.PP +A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. +.PP +The package-info\&.java File + +The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. +.PP +\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Provides the classes necessary to create an \fP +.fi +.nf +\f3 * applet and the classes an applet uses \fP +.fi +.nf +\f3 * to communicate with its applet context\&.\fP +.fi +.nf +\f3 * <p>\fP +.fi +.nf +\f3 * The applet framework involves two entities:\fP +.fi +.nf +\f3 * the applet and the applet context\&.\fP +.fi +.nf +\f3 * An applet is an embeddable window (see the\fP +.fi +.nf +\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP +.fi +.nf +\f3 * methods that the applet context can use to \fP +.fi +.nf +\f3 * initialize, start, and stop the applet\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @since 1\&.0\fP +.fi +.nf +\f3 * @see java\&.awt\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3package java\&.lang\&.applet;\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +The package\&.html File + +The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. +.PP +File: \f3java/applet/package\&.html\fR +.sp +.nf +\f3<HTML>\fP +.fi +.nf +\f3<BODY>\fP +.fi +.nf +\f3Provides the classes necessary to create an applet and the \fP +.fi +.nf +\f3classes an applet uses to communicate with its applet context\&.\fP +.fi +.nf +\f3<p>\fP +.fi +.nf +\f3The applet framework involves two entities: the applet\fP +.fi +.nf +\f3and the applet context\&. An applet is an embeddable\fP +.fi +.nf +\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP +.fi +.nf +\f3few extra methods that the applet context can use to\fP +.fi +.nf +\f3initialize, start, and stop the applet\&. \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3@since 1\&.0 \fP +.fi +.nf +\f3@see java\&.awt\fP +.fi +.nf +\f3</BODY>\fP +.fi +.nf +\f3</HTML>\fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. +.PP +Processing the Comment File + +When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. +.TP 0.2i +\(bu +Processes the package tags\&. See Package Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html + +The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. +.SS OVERVIEW\ COMMENT\ FILES +Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. +.PP +You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. +.PP +For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. +.PP +You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. +.PP +The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. +.PP +When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. +.TP 0.2i +\(bu +Processes the overview tags that are present\&. See Overview Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the overview comment to the top of the overview summary page\&. +.SS UNPROCESSED\ FILES +Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. +.PP +To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. +.PP +For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. +.PP +All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This button looks like this: \fP +.fi +.nf +\f3 * <img src="doc\-files/Button\&.gif">\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS TEST\ AND\ TEMPLATE\ FILES +You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. +.PP +Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. +.PP +Test Files + +If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: +.sp +.nf +\f3com/package1/test\-files/\fP +.fi +.nf +\f3\fR +.fi +.sp +If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. +.PP +Template Files + +If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. +.SH GENERATED\ FILES +By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. +.SS BASIC\ CONTENT\ PAGES +.TP 0.2i +\(bu +One class or interface page (classname\&.html) for each class or interface being documented\&. +.TP 0.2i +\(bu +One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. +.TP 0.2i +\(bu +One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. +.SS CROSS-REFERENCE\ PAGES +.TP 0.2i +\(bu +One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. +.TP 0.2i +\(bu +One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. +.TP 0.2i +\(bu +One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. +.TP 0.2i +\(bu +A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. +.TP 0.2i +\(bu +A constant field values page (constant-values\&.html) for the values of static fields\&. +.TP 0.2i +\(bu +A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. +.TP 0.2i +\(bu +An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. +.SS SUPPORT\ PAGES +.TP 0.2i +\(bu +A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. +.TP 0.2i +\(bu +One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. +.TP 0.2i +\(bu +Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. +.TP 0.2i +\(bu +A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. +.TP 0.2i +\(bu +A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. +.TP 0.2i +\(bu +A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. +.PP +See Options\&. +.SS HTML\ FRAMES +The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. +.SS GENERATED\ FILE\ STRUCTURE +The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. +.PP +For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. +.PP +The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. +.PP +Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. +.TP 0.2i +\(bu +\fIapidocs\fR: Top-level directory +.RS +.TP 0.2i +\(bu +index\&.html: Initial Page that sets up HTML frames +.TP 0.2i +\(bu +*overview-summary\&.html: Package list with summaries +.TP 0.2i +\(bu +overview-tree\&.html: Class hierarchy for all packages +.TP 0.2i +\(bu +deprecated-list\&.html: Deprecated APIs for all packages +.TP 0.2i +\(bu +constant-values\&.html: Static field values for all packages +.TP 0.2i +\(bu +serialized-form\&.html: Serialized forms for all packages +.TP 0.2i +\(bu +*overview-frame\&.html: All packages for display in upper-left frame +.TP 0.2i +\(bu +allclasses-frame\&.html: All classes for display in lower-left frame +.TP 0.2i +\(bu +help-doc\&.html: Help about Javadoc page organization +.TP 0.2i +\(bu +index-all\&.html: Default index created without \f3-splitindex\fR option +.TP 0.2i +\(bu +\fIindex-files\fR: Directory created with \f3-splitindex\fR option +.RS +.TP 0.2i +\(bu +index-<number>\&.html: Index files created with \f3-splitindex\fR option +.RE + +.TP 0.2i +\(bu +package-list: Package names for resolving external references +.TP 0.2i +\(bu +stylesheet\&.css: Defines fonts, colors, positions, and so on +.RE + +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory +.RS +.TP 0.2i +\(bu +Applet\&.html: \f3Applet\fR class page +.TP 0.2i +\(bu +AppletContext\&.html: \f3AppletContext\fR interface +.TP 0.2i +\(bu +AppletStub\&.html: \f3AppletStub\fR interface +.TP 0.2i +\(bu +AudioClip\&.html: \f3AudioClip\fR interface +.TP 0.2i +\(bu +package-summary\&.html: Classes with summaries +.TP 0.2i +\(bu +package-frame\&.html: Package classes for display in lower-left frame +.TP 0.2i +\(bu +package-tree\&.html: Class hierarchy for this package +.TP 0.2i +\(bu +package-use\&.html: Where this package is used +.TP 0.2i +\(bu +\fIdoc-files\fR: Image and example files directory +.TP 0.2i +\(bu +\fIclass-use\fR: Image and examples file location + +- Applet\&.html: Uses of the Applet class + +- AppletContext\&.html: Uses of the \f3AppletContext\fR interface + +- AppletStub\&.html: Uses of the \f3AppletStub\fR interface + +- AudioClip\&.html: Uses of the \f3AudioClip\fR interface +.RE + +.RE + +.TP 0.2i +\(bu +\fIsrc-html\fR: Source code directory +.RS +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory + +- Applet\&.html: Applet source code + +- AppletContext\&.html: \f3AppletContext\fR source code + +- AppletStub\&.html: \f3AppletStub\fR source code + +- AudioClip\&.html: \f3AudioClip\fR source code +.RE + +.RE + +.SS GENERATED\ API\ DECLARATIONS +The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: +.sp +.nf +\f3public final class Boolean\fP +.fi +.nf +\f3extends Object\fP +.fi +.nf +\f3implements Serializable\fP +.fi +.nf +\f3\fR +.fi +.sp +The declaration for the \f3Boolean\&.valueOf\fR method is: +.sp +.nf +\f3public static Boolean valueOf(String s)\fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. +.PP +Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. +.SH DOCUMENTATION\ COMMENTS +This section describes source code comments and comment inheritance\&. +.SS SOURCE\ CODE\ COMMENTS +You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the typical format of a simple documentation comment\fP +.fi +.nf +\f3 * that spans two lines\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp To save space you can put a comment on one line: -.nf -\f3 -.fl -/** This comment takes up only one line. */ -.fl -\fP -.fi -.LP -\f3Placement of comments\fP \- Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations \-\- see the class example, method example, and field example. Documentation comments placed in the body of a method are ignored. Only one documentation comment per declaration statement is recognized by the Javadoc tool. -.LP -A common mistake is to put an \f2import\fP statement between the class comment and the class declaration. Avoid this, as the Javadoc tool will ignore the class comment. -.nf -\f3 -.fl - /** -.fl - * This is the class comment for the class Whatever. -.fl - */ -.fl +.sp +.nf +\f3/** This comment takes up only one line\&. */\fP +.fi +.nf +\f3\fR +.fi +.sp -.fl - import com.sun; // MISTAKE \- Important not to put import statement here -.fl +.PP +Placement of Comments -.fl - public class Whatever { -.fl - } -.fl -\fP -.fi -.LP -\f3A doc comment is composed of a \fP\f4main description\fP\f3 followed by a \fP\f4tag section\fP \- The \f2main description\fP begins after the starting delimiter \f2/**\fP and continues until the tag section. The \f2tag section\fP starts with the first block tag, which is defined by the first \f2@\fP character that begins a line (ignoring leading asterisks, white space, and leading separator \f2/**\fP). It is possible to have a comment with only a tag section and no main description. The main description cannot continue after the tag section begins. The argument to a tag can span multiple lines. There can be any number of tags \-\- some types of tags can be repeated while others cannot. For example, this \f2@see\fP starts the tag section: -.nf -\f3 -.fl -/** -.fl - * This sentence would hold the main description for this doc comment. -.fl - * @see java.lang.Object -.fl - */ -.fl -\fP -.fi -.LP -\f3Block tags and in\-line tags\fP \- A \f2tag\fP is a special keyword within a doc comment that the Javadoc tool can process. There are two kinds of tags: block tags, which appear as \f2@tag\fP (also known as "standalone tags"), and in\-line tags, which appear within curly braces, as \f2{@tag}\fP. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and separator (\f2/**\fP). This means you can use the \f2@\fP character elsewhere in the text and it will not be interpreted as the start of a tag. If you want to start a line with the \f2@\fP character and not have it be interpreted, use the HTML entity \f2@\fP. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the doc comment. This associated text can span multiple lines. An in\-line tag is allowed and interpreted anywhere that text is allowed. The following example contains the block tag \f2@deprecated\fP and in\-line tag \f2{@link}\fP. -.nf -\f3 -.fl -/** -.fl - * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} -.fl - */ -.fl -\fP -.fi -.LP -\f3Comments are written in HTML\fP \- The text must be written in HTML, in that they should use HTML entities and can use HTML tags. You can use whichever version of HTML your browser supports; we have written the standard doclet to generate HTML 3.2\-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames. (We preface each generated file with "HTML 4.0" because of the frame sets.) -.LP -For example, entities for the less\-than (\f2<\fP) and greater\-than (\f2>\fP) symbols should be written \f2<\fP and \f2>\fP. Likewise, the ampersand (\f2&\fP) should be written \f2&\fP. The bold HTML tag \f2<b>\fP is shown in the following example. -.LP -Here is a doc comment: -.nf -\f3 -.fl -/** -.fl - * This is a <b>doc</b> comment. -.fl - * @see java.lang.Object -.fl - */ -.fl -\fP -.fi -.LP -\f3Leading asterisks\fP \- When javadoc parses a doc comment, leading asterisk (\f2*\fP) characters on each line are discarded; blanks and tabs preceding the initial asterisk (\f2*\fP) characters are also discarded. Starting with 1.4, if you omit the leading asterisk on a line, the leading white space is no longer removed. This enables you to paste code examples directly into a doc comment inside a \f2<PRE>\fP tag, and its indentation will be honored. Spaces are generally interpreted by browsers more uniformly than tabs. Indentation is relative to the left margin (rather than the separator \f2/**\fP or \f2<PRE>\fP tag). -.LP -\f3First sentence\fP \- The first sentence of each doc comment should be a summary sentence, containing a concise but complete description of the declared entity. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag. The Javadoc tool copies this first sentence to the member summary at the top of the HTML page. -.LP -\f3Declaration with multiple fields\fP \- Java allows declaring multiple fields in a single statement, but this statement can have only one documentation comment, which is copied for all fields. Therefore if you want individual documentation comments for each field, you must declare each field in a separate statement. For example, the following documentation comment doesn't make sense written as a single declaration and would be better handled as two declarations: -.nf -\f3 -.fl -/** -.fl - * The horizontal and vertical distances of point (x,y) -.fl - */ -.fl -public int x, y; // Avoid this -.fl -\fP -.fi -.LP -The Javadoc tool generates the following documentation from the above code: -.nf -\f3 -.fl -public int \fP\f3x\fP -.fl -.fi -.RS 3 -The horizontal and vertical distances of point (x,y) +Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. +.PP +A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the class comment for the class Whatever\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3public class Whatever{ }\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Parts of Comments + +A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This sentence holds the main description for this documentation comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Block and inline Tags + +A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Write Comments in HTML + +The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. +.PP +For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is a <b>doc</b> comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Leading Asterisks + +When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. +.PP +First Sentence + +The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. +.PP +Multiple-Field Declarations + +The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: +.sp +.nf +\f3/** \fP +.fi +.nf +\f3 * The horizontal and vertical distances of point (x,y)\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public int x, y; // Avoid this \fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3javadoc\fR command generates the following documentation from the previous code: +.sp +.nf +\f3public int x\fP +.fi +.nf +\f3\fR +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.sp +.nf +\f3public int y\fP +.fi +.nf +\f3\fR +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.PP +Use of Header Tags + +When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. +.SS METHOD\ COMMENT\ INHERITANCE +The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. +.PP +\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. +.PP +Fill in Missing Text + +When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. +.PP +When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. +.PP +This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. +.PP +See Javadoc Tags and Options\&. +.PP +Explicit Inheritance + +Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. +.SS CLASS\ AND\ INTERFACE\ INHERITANCE +Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: +.TP 0.2i +\(bu +When a method in a class overrides a method in a superclass +.TP 0.2i +\(bu +When a method in an interface overrides a method in a superinterface +.TP 0.2i +\(bu +When a method in a class implements a method in an interface +.PP +In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. +.PP +In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. +.SS METHOD\ COMMENTS\ ALGORITHM +If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: +.TP 0.4i +1\&. +Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. +.TP 0.4i +2\&. +If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. +.TP 0.4i +3\&. +When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: +.RS +.TP 0.4i +1\&. +If the superclass has a documentation comment for this method, then use it\&. +.TP 0.4i +2\&. +If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. +.RE + +.SH JAVADOC\ TAGS +The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. +.PP +Tags have the following types: +.TP 0.2i +\(bu +Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. +.TP 0.2i +\(bu +Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. +.PP +For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. +.SS TAG\ DESCRIPTIONS +.TP +@author \fIname-text\fR +Introduced in JDK 1\&.0 + +Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author +.TP +{@code \fItext\fR} +Introduced in JDK 1\&.5 + +Equivalent to \f3<code>{@literal}</code>\fR\&. + +Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. +.TP +@deprecated \fIdeprecated-text\fR +Introduced in JDK 1\&.0 + +Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. + +The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. + +Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html + +See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated +.TP +{@docRoot} +Introduced in JDK 1\&.3 + +Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. + +This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. +.RS +.TP 0.2i +\(bu +On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. + +When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. +.TP 0.2i +\(bu +In a documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. +.RE + +.TP +@exception \fIclass-name description\fR +Introduced in JDK 1\&.0 + +Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. +.TP +{@inheritDoc} +Introduced in JDK 1\&.4 + +Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. + +This tag is valid only in these places in a documentation comment: +.RS +.TP 0.2i +\(bu +In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. +.TP 0.2i +\(bu +In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. .RE -.nf -\f3 -.fl -public int \fP\f3y\fP -.fl -.fi -.RS 3 -The horizontal and vertical distances of point (x,y) +.RS +See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. + .RE -.LP -\f3Use header tags carefully\fP \- When writing documentation comments for members, it's best not to use HTML heading tags such as <H1> and <H2>, because the Javadoc tool creates an entire structured document and these structural tags might interfere with the formatting of the generated document. However, it is fine to use these headings in class and package comments to provide your own structure. -.SS -Automatic Copying of Method Comments -.LP -The Javadoc tool has the ability to copy or "inherit" method comments in classes and interfaces under the following two circumstances. Constructors, fields and nested classes do not inherit doc comments. -.RS 3 -.TP 2 -o -\f3Automatically inherit comment to fill in missing text\fP \- When a main description, or \f2@return\fP, \f2@param\fP or \f2@throws\fP tag is missing from a method comment, the Javadoc tool copies the corresponding main description or tag comment from the method it overrides or implements (if any), according to the algorithm below. -.LP -More specifically, when a \f2@param\fP tag for a particular parameter is missing, then the comment for that parameter is copied from the method further up the inheritance hierarchy. When a \f2@throws\fP tag for a particular exception is missing, the \f2@throws\fP tag is copied \f2only if that exception is declared\fP. -.LP -This behavior contrasts with version 1.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited. -.TP 2 -o -\f3Explicitly inherit comment with {@inheritDoc} tag\fP \- Insert the inline tag \f2{@inheritDoc}\fP in a method main description or \f2@return\fP, \f2@param\fP or \f2@throws\fP tag comment \-\- the corresponding inherited main description or tag comment is copied into that spot. +.TP +{@link \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.2 + +Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link + +This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. + +There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. + +For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: +.sp +.nf +\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + + +From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): +.sp +.nf +\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The previous line appears on the web page as: +.sp +.nf +\f3Use the getComponentAt method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +{@linkplain \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.4 + +Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. +.TP +{@literal \fItext\fR} +Introduced in JDK 1\&.5 + +Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. +.TP +@param \fIparameter-name description\fR +Introduced in JDK 1\&.0 + +Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param + +The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. + +Example of a type parameter of a class: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param <E> Type of element stored in a list\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public interface List<E> extends Collection<E> {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Example of a type parameter of a method: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param string the string to be converted\fP +.fi +.nf +\f3 * @param type the type to convert the string to\fP +.fi +.nf +\f3 * @param <T> the type of the element\fP +.fi +.nf +\f3 * @param <V> the value of the element\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3<T, V extends T> V convert(String string, Class<T> type) {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +@return \fIdescription\fR +Introduced in JDK 1\&.0 + +Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return +.TP +@see \fIreference\fR +Introduced in JDK 1\&.0 + +Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. + +\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: + +\fISee Also\fR: + +"The Java Programming Language" + +\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: + +\fISee Also\fR: + +Java Spec + +\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. + +In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. +.RS +.TP 0.2i +\(bu +\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. + +\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. +.TP 0.2i +\(bu +\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. +.TP 0.2i +\(bu +A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. +.RE + + +\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @see String#equals(Object) equals\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The standard doclet produces HTML that is similar to: +.sp +.nf +\f3<dl>\fP +.fi +.nf +\f3<dt><b>See Also:</b>\fP +.fi +.nf +\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP +.fi +.nf +\f3</dl>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The previous code looks similar to the following in a browser, where the label is the visible link text: + +\fISee Also\fR: + +equals +.PP +Specify a Name + +\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. +.sp +.nf +\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP +.fi +.nf +\f3\fIReferencing a member of the current class\fR\fP +.fi +.nf +\f3@see #field\fP +.fi +.nf +\f3@see #method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3\fIReferencing another class in the current or imported packages\fR\fP +.fi +.nf +\f3@see Class#field\fP +.fi +.nf +\f3@see Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class\&.NestedClass\fP +.fi +.nf +\f3@see Class \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3\fIReferencing an element in another package (fully qualified)\fR\fP +.fi +.nf +\f3@see package\&.Class#field\fP +.fi +.nf +\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class\&.NestedClass\fP +.fi +.nf +\f3@see package\&.Class\fP +.fi +.nf +\f3@see package\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3\fRNotes about the previous listing: +.TP 0.2i +\(bu +The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. +.TP 0.2i +\(bu +If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. +.TP 0.2i +\(bu +Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. +.TP 0.2i +\(bu +As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. +.PP +Search Order for the @see Tag + +\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. +.PP +The following is the search order for the \f3@see\fR tag\&. +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superonterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. +.PP +The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. +.PP +When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces, searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. +.PP +The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. +.PP +How a Name Appears + +\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package +.br +\fIExample in\fR: \f3@see String#toLowerCase()\fR +.br +\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package +.br +\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR +.br +\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package +.br +\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR +.br +\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names +.br + +.PP +Examples of the @see Tag + +The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see +.sp +.nf +\f3 See also:\fP +.fi +.nf +\f3@see java\&.lang\&.String // String \fP +.fi +.nf +\f3@see java\&.lang\&.String The String class // The String class \fP +.fi +.nf +\f3@see String // String \fP +.fi +.nf +\f3@see String#equals(Object) // String\&.equals(Object) \fP +.fi +.nf +\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP +.fi +.nf +\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP +.fi +.nf +\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP +.fi +.nf +\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP +.fi +.nf +\f3@see "The Java Programming Language" // "The Java Programming Language" \fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. +.TP +@serial \fIfield-description\fR | include | exclude +Introduced in JDK 1\&.2 + +Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 + +See also Oracle\(cqs Criteria for Including Classes in the Serialilzed Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html + +An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. + +If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. + +The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: +.RS +.TP 0.2i +\(bu +A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. +.TP 0.2i +\(bu +A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. .RE -.LP -The source file for the inherited method need only be on the path specified by \-sourcepath for the doc comment to actually be available to copy. Neither the class nor its package needs to be passed in on the command line. This contrasts with 1.3.x and earlier releases, where the class had to be a documented class -.LP -\f3Inherit from classes and interfaces\fP \- Inheriting of comments occurs in all three possible cases of inheritance from classes and interfaces: -.RS 3 -.TP 2 -o -When a method in a class overrides a method in a superclass -.TP 2 -o -When a method in an interface overrides a method in a superinterface -.TP 2 -o -When a method in a class implements a method in an interface +.RS +For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. + +The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. + .RE -.LP -In the first two cases, for method overrides, the Javadoc tool generates a subheading "Overrides" in the documentation for the overriding method, with a link to the method it is overriding, whether or not the comment is inherited. -.LP -In the third case, when a method in a given class implements a method in an interface, the Javadoc tool generates a subheading "Specified by" in the documentation for the overriding method, with a link to the method it is implementing. This happens whether or not the comment is inherited. -.LP -\f3Algorithm for Inheriting Method Comments\fP \- If a method does not have a doc comment, or has an {@inheritDoc} tag, the Javadoc tool searches for an applicable comment using the following algorithm, which is designed to find the most specific applicable doc comment, giving preference to interfaces over superclasses: -.RS 3 -.TP 3 -1. -Look in each directly implemented (or extended) interface in the order they appear following the word implements (or extends) in the method declaration. Use the first doc comment found for this method. -.TP 3 -2. -If step 1 failed to find a doc comment, recursively apply this entire algorithm to each directly implemented (or extended) interface, in the same order they were examined in step 1. -.TP 3 -3. -If step 2 failed to find a doc comment and this is a class other than Object (not an interface): -.RS 3 -.TP 3 -a. -If the superclass has a doc comment for this method, use it. -.TP 3 -b. -If step 3a failed to find a doc comment, recursively apply this entire algorithm to the superclass. -.RE -.RE -.SH "JAVADOC TAGS" -.LP -The Javadoc tool parses special tags when they are embedded within a Java doc comment. These doc tags enable you to autogenerate a complete, well\-formatted API from your source code. The tags start with an "at" sign (\f2@\fP) and are case\-sensitive \-\- they must be typed with the uppercase and lowercase letters as shown. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk) or it is treated as normal text. By convention, tags with the same name are grouped together. For example, put all \f2@see\fP tags together. -.LP -Tags come in two types: -.RS 3 -.TP 2 -o -\f3Block tags\fP \- Can be placed only in the tag section that follows the main description. Block tags are of the form: \f2@tag\fP. -.TP 2 -o -\f3Inline tags\fP \- Can be placed anywhere in the main description or in the comments for block tags. Inline tags are denoted by curly braces: \f2{@tag}\fP. -.RE -.LP -For information about tags we might introduce in future releases, see -.na -\f2Proposed Tags\fP @ -.fi -http://java.sun.com/j2se/javadoc/proposed\-tags.html. -.LP -The current tags are: -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 80 0 -.nr 38 \w\f3Tag\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@author\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@code}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@docRoot}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@deprecated\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@exception\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@inheritDoc}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@link}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@linkplain}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@literal}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@param\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@return\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@see\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serial\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serialData\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serialField\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@since\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@throws\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@value}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@version\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Introduced in JDK/SDK\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.5 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.3 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.5 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.1 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 873 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Tag\fP\h'|\n(41u'\f3Introduced in JDK/SDK\fP -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@author\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@code}\fP\h'|\n(41u'1.5 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@docRoot}\fP\h'|\n(41u'1.3 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@deprecated\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@exception\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@inheritDoc}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@link}\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@linkplain}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@literal}\fP\h'|\n(41u'1.5 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@param\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@return\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@see\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serial\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serialData\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serialField\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@since\fP\h'|\n(41u'1.1 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@throws\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@value}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@version\fP\h'|\n(41u'1.0 -.fc -.nr T. 1 -.T# 1 -.35 -.if \n-(b.=0 .nr c. \n(.c-\n(d.-42 -.LP -For custom tags, see the \-tag option. -.RS 3 -.TP 3 -@author\ name\-text -Adds an "Author" entry with the specified \f2name\-text\fP to the generated docs when the \-author option is used. A doc comment may contain multiple \f2@author\fP tags. You can specify one name per \f2@author\fP tag or multiple names per tag. In the former case, the Javadoc tool inserts a comma (\f2,\fP) and space between names. In the latter case, the entire text is simply copied to the generated document without being parsed. Therefore, you can use multiple names per line if you want a localized name separator other than comma. -.RE -.LP -For more details, see Where Tags Can Be Used and -.na -\f2writing @author tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@author. -.LP -.RS 3 -.TP 3 -@deprecated\ deprecated\-text Note: You can deprecate a program element using the @Deprecated annotation. -.RE -.LP -Adds a comment indicating that this API should no longer be used (even though it may continue to work). The Javadoc tool moves the \f2deprecated\-text\fP ahead of the main description, placing it in italics and preceding it with a bold warning: "Deprecated". This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field. -.LP -The first sentence of \f2deprecated\-text\fP should at least tell the user when the API was deprecated and what to use as a replacement. The Javadoc tool copies just the first sentence to the summary section and index. Subsequent sentences can also explain why it has been deprecated. You should include a \f2{@link}\fP tag (for Javadoc 1.2 or later) that points to the replacement API: -.LP -For more details, see -.na -\f2writing @deprecated tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@deprecated. -.RS 3 -.TP 2 -o -For Javadoc 1.2 and later, use a \f2{@link}\fP tag. This creates the link in\-line, where you want it. For example: -.nf -\f3 -.fl -/** -.fl - * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} -.fl - */ -.fl - -.fl -\fP -.fi -.TP 2 -o -For Javadoc 1.1, the standard format is to create a \f2@see\fP tag (which cannot be in\-line) for each \f2@deprecated\fP tag. -.RE -.LP -For more about deprecation, see -.na -\f2The @deprecated tag\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/deprecation/index.html. -.LP -.RS 3 -.TP 3 -{@code\ text} -Equivalent to \f2<code>{@literal}</code>\fP. -.LP -Displays \f2text\fP in \f2code\fP font without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (\f2<\fP and \f2>\fP) instead of the HTML entities (\f2<\fP and \f2>\fP) in doc comments, such as in parameter types (\f2<Object>\fP), inequalities (\f23 < 4\fP), or arrows (\f2<\-\fP). For example, the doc comment text: -.nf -\f3 -.fl - \fP\f4{@code A<B>C}\fP\f3 -.fl - -.fl -\fP -.fi -.LP -displays in the generated HTML page unchanged, as: -.nf -\f3 -.fl - \fP\f4A<B>C\fP\f3 -.fl - -.fl -\fP -.fi -.LP -The noteworthy point is that the \f2<B>\fP is not interpreted as bold and is in code font. -.LP -If you want the same functionality without the code font, use \f2{@literal}\fP. -.LP -.TP 3 -{@docRoot} -Represents the relative path to the generated document's (destination) root directory from any generated page. It is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages. Linking to the copyright page from the bottom of each page is common. -.LP -This \f2{@docRoot}\fP tag can be used both on the command line and in a doc comment: This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated). -.RS 3 -.TP 3 -1. -On the command line, where the header/footer/bottom are defined: -.nf -\f3 -.fl - javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>' -.fl - -.fl -\fP -.fi -.LP -NOTE \- When using \f2{@docRoot}\fP this way in a make file, some makefile programs require special escaping for the brace {} characters. For example, the Inprise MAKE version 5.2 running on Windows requires double braces: \f2{{@docRoot}}\fP. It also requires double (rather than single) quotes to enclose arguments to options such as \f2\-bottom\fP (with the quotes around the \f2href\fP argument omitted). -.TP 3 -2. -In a doc comment: -.nf -\f3 -.fl - /** -.fl - * See the <a href="{@docRoot}/copyright.html">Copyright</a>. -.fl - */ -.fl - -.fl -\fP -.fi -.RE -.LP -The reason this tag is needed is because the generated docs are in hierarchical directories, as deep as the number of subpackages. This expression: -.nf -\f3 -.fl - <a href="{@docRoot}/copyright.html"> -.fl - -.fl -\fP -.fi -.LP -would resolve to: -.nf -\f3 -.fl - <a href="../../copyright.html"> for java/lang/Object.java -.fl - -.fl -\fP -.fi -.LP -and -.nf -\f3 -.fl - <a href="../../../copyright.html"> for java/lang/ref/Reference.java -.fl - -.fl -\fP -.fi -.LP -.TP 3 -@exception\ class\-name\ description -The \f2@exception\fP tag is a synonym for \f2@throws\fP. -.LP -.TP 3 -{@inheritDoc}\ -Inherits (copies) documentation from the "nearest" inheritable class or implementable interface into the current doc comment at this tag's location. This allows you to write more general comments higher up the inheritance tree, and to write around the copied text. -.LP -This tag is valid only in these places in a doc comment: -.RS 3 -.TP 2 -o -In the main description block of a method. In this case, the main description is copied from a class or interface up the hierarchy. -.TP 2 -o -In the text arguments of the @return, @param and @throws tags of a method. In this case, the tag text is copied from the corresponding tag up the hierarchy. -.RE -.LP -See Automatic Copying of Method Comments for a more precise description of how comments are found in the inheritance hierarchy. Note that if this tag is missing, the comment is or is not automatically inherited according to rules described in that section. -.LP -.TP 3 -{@link\ package.class#member\ label} -Inserts an in\-line link with visible text \f2label\fP that points to the documentation for the specified package, class or member name of a referenced class. This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated). -.LP -This tag is very simliar to \f2@see\fP \-\- both require the same references and accept exactly the same syntax for \f2package.class\fP\f2#\fP\f2member\fP and \f2label\fP. The main difference is that \f2{@link}\fP generates an in\-line link rather than placing the link in the "See Also" section. Also, the \f2{@link}\fP tag begins and ends with curly braces to separate it from the rest of the in\-line text. If you need to use "}" inside the label, use the HTML entity notation } -.LP -There is no limit to the number of \f2{@link}\fP tags allowed in a sentence. You can use this tag in the main description part of any documentation comment or in the text portion of any tag (such as @deprecated, @return or @param). -.LP -For example, here is a comment that refers to the \f2getComponentAt(int, int)\fP method: -.nf -\f3 -.fl -Use the {@link #getComponentAt(int, int) getComponentAt} method. -.fl - -.fl -\fP -.fi -.LP -From this, the standard doclet would generate the following HTML (assuming it refers to another class in the same package): -.nf -\f3 -.fl -Use the <a href="Component.html#getComponentAt(int, int)">getComponentAt</a> method. -.fl - -.fl -\fP -.fi -.LP -Which appears on the web page as: -.nf -\f3 -.fl -Use the getComponentAt method. -.fl - -.fl -\fP -.fi -.LP -You can extend \f2{@link}\fP to link to classes not being documented by using the \f2\-link\fP option. -.LP -For more details, see -.na -\f2writing {@link} tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#{@link}. -.LP -.TP 3 -{@linkplain\ package.class#member\ label} -Identical to \f2{@link}\fP, except the link's label is displayed in plain text than code font. Useful when the label is plain text. Example: -.nf -\f3 -.fl - Refer to {@linkplain add() the overridden method}. -.fl - -.fl -\fP -.fi -.LP -This would display as: -.LP -Refer to the overridden method. -.LP -.TP 3 -{@literal\ text} -Displays \f2text\fP without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (\f2<\fP and \f2>\fP) instead of the HTML entities (\f2<\fP and \f2>\fP) in doc comments, such as in parameter types (\f2<Object>\fP), inequalities (\f23 < 4\fP), or arrows (\f2<\-\fP). For example, the doc comment text: -.nf -\f3 -.fl - \fP\f4{@literal A<B>C}\fP\f3 -.fl - -.fl -\fP -.fi -.LP -displays unchanged in the generated HTML page in your browser, as: -.LP -\f2\ \ \ \ \ \fPA<B>C -.LP -The noteworthy point is that the \f2<B>\fP is not interpreted as bold (and it is not in code font). -.LP -If you want the same functionality but with the text in code font, use \f2{@code}\fP. -.LP -.TP 3 -@param\ parameter\-name description -Adds a parameter with the specified \f2parameter\-name\fP followed by the specified \f2description\fP to the "Parameters" section. When writing the doc comment, you may continue the \f2description\fP onto multiple lines. This tag is valid only in a doc comment for a method, constructor or class. -.LP -The \f2parameter\-name\fP can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method or constructor. Use angle brackets around this parameter name to specify the use of a type parameter. -.LP -Example of a type parameter of a class: -.nf -\f3 -.fl - /** -.fl - * @param <E> Type of element stored in a list -.fl - */ -.fl - public interface List<E> extends Collection<E> { -.fl - } -.fl - -.fl -\fP -.fi -.LP -Example of a type parameter of a method: -.nf -\f3 -.fl - /** -.fl - * @param string the string to be converted -.fl - * @param type the type to convert the string to -.fl - * @param <T> the type of the element -.fl - * @param <V> the value of the element -.fl - */ -.fl - <T, V extends T> V convert(String string, Class<T> type) { -.fl - } -.fl - -.fl -\fP -.fi -.LP -For more details, see -.na -\f2writing @param tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@param. -.LP -.TP 3 -@return\ description -Adds a "Returns" section with the \f2description\fP text. This text should describe the return type and permissible range of values. This tag is valid only in a doc comment for a method. -.LP -For more details, see -.na -\f2writing @return tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@return. -.LP -.TP 3 -@see\ reference -Adds a "See Also" heading with a link or text entry that points to \f2reference\fP. A doc comment may contain any number of \f2@see\fP tags, which are all grouped under the same heading. The \f2@see\fP tag has three variations; the third form below is the most common. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. For inserting an in\-line link within a sentence to a package, class or member, see \f2{@link}\fP. -.RS 3 -.TP 3 -@see "string" -Adds a text entry for \f2string\fP. No link is generated. The \f2string\fP is a book or other reference to information not available by URL. The Javadoc tool distinguishes this from the previous cases by looking for a double\-quote (\f2"\fP) as the first character. For example: -.nf -\f3 -.fl - @see "The Java Programming Language" -.fl - -.fl -\fP -.fi -.LP -This generates text such as: -.RE -.RE -.RS 3 -.RS 3 -.RS 3 -.RS 3 -.TP 3 -See Also: -"The Java Programming Language" -.RE -.RE -.TP 3 -@see <a href="URL#value">label</a> -Adds a link as defined by \f2URL\fP#\f2value\fP. The \f2URL\fP#\f2value\fP is a relative or absolute URL. The Javadoc tool distinguishes this from other cases by looking for a less\-than symbol (\f2<\fP) as the first character. For example: -.nf -\f3 -.fl - @see <a href="spec.html#section">Java Spec</a> -.fl -\fP -.fi -This generates a link such as: -.RS 3 -.TP 3 -See Also: -Java Spec -.RE -.TP 3 -@see\ package.class#member\ label -Adds a link, with visible text \f2label\fP, that points to the documentation for the specified name in the Java Language that is referenced. The \f2label\fP is optional; if omitted, the name appears instead as the visible text, suitably shortened \-\- see How a name is displayed. Use \-noqualifier to globally remove the package name from this visible text. Use the label when you want the visible text to be different from the auto\-generated visible text. -.LP -Only in version 1.2, just the name but not the label would automatically appear in <code> HTML tags, Starting with 1.2.2, the <code> is always included around the visible text, whether or not a label is used. -.LP -.RS 3 -.TP 2 -o -\f4package.class\fP\f4#\fP\f4member\fP is any valid program element name that is referenced \-\- a package, class, interface, constructor, method or field name \-\- except that the character ahead of the member name should be a hash character (\f2#\fP). The \f2class\fP represents any top\-level or nested class or interface. The \f2member\fP represents any constructor, method or field (not a nested class or interface). If this name is in the documented classes, the Javadoc tool will automatically create a link to it. To create links to external referenced classes, use the \f2\-link\fP option. Use either of the other two \f2@see\fP forms for referring to documentation of a name that does not belong to a referenced class. This argument is described at greater length below under Specifying a Name. -.TP 2 -o -\f4label\fP is optional text that is visible as the link's label. The \f2label\fP can contain whitespace. If \f2label\fP is omitted, then \f2package.class.member\fP will appear, suitably shortened relative to the current class and package \-\- see How a name is displayed. -.TP 2 -o -A space is the delimiter between \f2package.class\fP\f2#\fP\f2member\fP and \f2label\fP. A space inside parentheses does not indicate the start of a label, so spaces may be used between parameters in a method. -.RE -.LP -\f3Example\fP \- In this example, an \f2@see\fP tag (in the \f2Character\fP class) refers to the \f2equals\fP method in the \f2String\fP class. The tag includes both arguments: the name "\f2String#equals(Object)\fP" and the label "\f2equals\fP". -.nf -\f3 -.fl - /** -.fl - * @see String#equals(Object) equals -.fl - */ -.fl -\fP -.fi -The standard doclet produces HTML something like this: -.nf -\f3 -.fl -<dl> -.fl -<dt><b>See Also:</b> -.fl -<dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals<code></a> -.fl -</dl> -.fl -\fP -.fi -Which looks something like this in a browser, where the label is the visible link text: -.RS 3 -.TP 3 -See Also: -equals -.RE -.LP -\f3Specifying a name\fP \- This \f2package.class\fP\f2#\fP\f2member\fP name can be either fully\-qualified, such as \f2java.lang.String#toUpperCase()\fP or not, such as \f2String#toUpperCase()\fP or \f2#toUpperCase()\fP. If less than fully\-qualified, the Javadoc tool uses the normal Java compiler search order to find it, further described below in Search order for @see. The name can contain whitespace within parentheses, such as between method arguments. -.LP -Of course the advantage of providing shorter, "partially\-qualified" names is that they are shorter to type and there is less clutter in the source code. The following table shows the different forms of the name, where \f2Class\fP can be a class or interface, \f2Type\fP can be a class, interface, array, or primitive, and \f2method\fP can be a method or constructor. -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 -.nr 34 \n(.lu -.eo -.am 80 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Typical\ forms\ for\ \fP\f4@see\fP\f3\ \fP\f4package.class#member\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ a\ member\ of\ the\ current\ class\fP -.br -\f2@see\fP\ \f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ another\ class\ in\ the\ current\ or\ imported\ packages\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2Class.NestedClass\fP -.br -\f2@see\fP\ \f2Class\fP -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ an\ element\ in\ another\ package\fP\ (fully qualified) -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2package.Class.NestedClass\fP -.br -\f2@see\fP\ \f2package.Class\fP -.br -\f2@see\fP\ \f2package\fP -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.80 -.rm 80 -.nr 38 \n(a- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(b- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(c- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr TW \n(80 -.if t .if \n(TW>\n(.li .tm Table at line 1364 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-58 -.LP -The following notes apply to the above table: -.RS 3 -.TP 2 -o -The first set of forms (with no class or package) will cause the Javadoc tool to search only through the current class's hierarchy. It will find a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search steps 1\-3). It will not search the rest of the current package or other packages (search steps 4\-5). -.TP 2 -o -If any method or constructor is entered as a name with no parentheses, such as \f2getValue\fP, and if there is no field with the same name, the Javadoc tool will correctly create a link to it, but will print a warning message reminding you to add the parentheses and arguments. If this method is overloaded, the Javadoc tool will link to the first method its search encounters, which is unspecified. -.TP 2 -o -Nested classes must be specified as \f2outer\fP\f2.\fP\f2inner\fP, not simply \f2inner\fP, for all forms. -.TP 2 -o -As stated, the hash character (\f2#\fP), rather than a dot (\f2.\fP) separates a member from its class. This enables the Javadoc tool to resolve ambiguities, since the dot also separates classes, nested classes, packages, and subpackages. However, the Javadoc tool is generally lenient and will properly parse a dot if you know there is no ambiguity, though it will print a warning. -.RE -.LP -\f3Search order for @see\fP \- the Javadoc tool will process a \f2@see\fP tag that appears in a source file (.java), package file (package.html or package\-info.java) or overview file (overview.html). In the latter two files, you must fully\-qualify the name you supply with \f2@see\fP. In a source file, you can specify a name that is fully\-qualified or partially\-qualified. -.LP -When the Javadoc tool encounters a \f2@see\fP tag in a \f2.java\fP file that is \f2not\fP fully qualified, it searches for the specified name in the same order as the Java compiler would (except the Javadoc tool will not detect certain namespace ambiguities, since it assumes the source code is free of these errors). This search order is formally defined in the \f2Java Language Specification\fP. The Javadoc tool searches for that name through all related and imported classes and packages. In particular, it searches in this order: -.RS 3 -.TP 3 -1. -the current class or interface -.TP 3 -2. -any enclosing classes and interfaces, searching closest first -.TP 3 -3. -any superclasses and superinterfaces, searching closest first -.TP 3 -4. -the current package -.TP 3 -5. -any imported packages, classes and interfaces, searching in the order of the import statement -.RE -.LP -The Javadoc tool continues to search recursively through steps 1\-3 for each class it encounters until it finds a match. That is, after it searches through the current class and its enclosing class E, it will search through E's superclasses before E's enclosing classes. In steps 4 and 5, the Javadoc tool does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler). In step 5, the Javadoc tool looks in java.lang, since that is automatically imported by all programs. -.LP -The Javadoc tool does not necessarily look in subclasses, nor will it look in other packages even if their documentation is being generated in the same run. For example, if the \f2@see\fP tag is in the \f2java.awt.event.KeyEvent\fP class and refers to a name in the \f2java.awt\fP package, javadoc does not look in that package unless that class imports it. -.LP -\f3How a name is displayed\fP \- If \f2label\fP is omitted, then \f2package.class.member\fP appears. In general, it is suitably shortened relative to the current class and package. By "shortened", we mean the Javadoc tool displays only the minimum name necessary. For example, if the \f2String.toUpperCase()\fP method contains references to a member of the same class and to a member of a different class, the class name is displayed only in the latter case, as shown in the following table. -.LP -Use \-noqualifier to globally remove the package names. -.br -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f3Example in \fP\f4String.toUpperCase()\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of the same class, same package -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2toLowerCase()\fP (omits the package and class names) -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of a different class, same package -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@see Character#toLowerCase(char)\fP -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2Character.toLowerCase(char)\fP (omits the package name, includes the class name) -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of a different class, different package -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@see java.io.File#exists()\fP -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2java.io.File.exists()\fP (includes the package and class names) -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Type of Reference\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(b- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(g- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f2@see String#toLowerCase()\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 82 0 -.nr 38 \w\f3Displays As\fP -.if \n(82<\n(38 .nr 82 \n(38 -.82 -.rm 82 -.nr 38 \n(c- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \n(f- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \n(i- -.if \n(82<\n(38 .nr 82 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr TW \n(82 -.if t .if \n(TW>\n(.li .tm Table at line 1440 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Type of Reference\fP\h'|\n(41u'\h'|\n(42u'\f3Displays As\fP -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.ne \n(c|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\f2@see String#toLowerCase()\fP\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.ne \n(f|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.ne \n(h|u+\n(.Vu -.ne \n(i|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-28 -.LP -\f3Examples of @see\fP -.br -The comment to the right shows how the name would be displayed if the \f2@see\fP tag is in a class in another package, such as \f2java.applet.Applet\fP. -.nf -\f3 -.fl - See also: -.fl -@see java.lang.String // String \fP\f3 -.fl -@see java.lang.String The String class // The String class \fP\f3 -.fl -@see String // String \fP\f3 -.fl -@see String#equals(Object) // String.equals(Object) \fP\f3 -.fl -@see String#equals // String.equals(java.lang.Object) \fP\f3 -.fl -@see java.lang.Object#wait(long) // java.lang.Object.wait(long) \fP\f3 -.fl -@see Character#MAX_RADIX // Character.MAX_RADIX \fP\f3 -.fl -@see <a href="spec.html">Java Spec</a> // Java Spec \fP\f3 -.fl -@see "The Java Programming Language" // "The Java Programming Language" \fP\f3 -.fl -\fP -.fi -You can extend \f2@see\fP to link to classes not being documented by using the \f2\-link\fP option. -.LP -For more details, see -.na -\f2writing @see tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@see. -.RE -.RE -.LP -.RS 3 -.TP 3 -@serial\ field\-description | include | exclude -Used in the doc comment for a default serializable field. -.LP -An optional \f2field\-description\fP should explain the meaning of the field and list the acceptable values. If needed, the description can span multiple lines. The standard doclet adds this information to the serialized form page. -.LP -If a serializable field was added to a class some time after the class was made serializable, a statement should be added to its main description to identify at which version it was added. -.LP -The \f2include\fP and \f2exclude\fP arguments identify whether a class or package should be included or excluded from the serialized form page. They work as follows: -.RS 3 -.TP 2 -o -A public or protected class that implements \f2Serializable\fP is \f2included\fP unless that class (or its package) is marked \f2@serial exclude\fP. -.TP 2 -o -A private or package\-private class that implements \f2Serializable\fP is \f2excluded\fP unless that class (or its package) is marked \f2@serial include\fP. -.RE -.LP -Examples: The \f2javax.swing\fP package is marked \f2@serial exclude\fP (in \f2package.html\fP or \f2package\-info.java\fP). The public class \f2java.security.BasicPermission\fP is marked \f2@serial exclude\fP. The package\-private class \f2java.util.PropertyPermissionCollection\fP is marked \f2@serial include\fP. -.LP -The tag @serial at a class level overrides @serial at a package level. -.LP -For more information about how to use these tags, along with an example, see " -.na -\f2Documenting Serializable Fields and Data for a Class\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/serialization/spec/serial\-arch.html," Section 1.6 of the \f2Java Object Serialization Specification\fP. Also see the -.na -\f2Serialization FAQ\fP @ -.fi -http://java.sun.com/javase/technologies/core/basic/serializationFAQ.jsp#javadoc_warn_missing, which covers common questions, such as "Why do I see javadoc warnings stating that I am missing @serial tags for private fields if I am not running javadoc with the \-private switch?". Also see -.na -\f2Sun's criteria\fP @ -.fi -http://java.sun.com/j2se/javadoc/writingapispecs/serialized\-criteria.html for including classes in the serialized form specification. -.LP -.TP 3 -@serialField\ field\-name\ field\-type\ field\-description -Documents an \f2ObjectStreamField\fP component of a \f2Serializable\fP class's \f2serialPersistentFields\fP member. One \f2@serialField\fP tag should be used for each \f2ObjectStreamField\fP component. -.LP -.TP 3 -@serialData\ data\-description -The \f2data\-description\fP documents the types and order of data in the serialized form. Specifically, this data includes the optional data written by the \f2writeObject\fP method and all data (including base classes) written by the \f2Externalizable.writeExternal\fP method. -.LP -The \f2@serialData\fP tag can be used in the doc comment for the \f2writeObject\fP, \f2readObject\fP, \f2writeExternal\fP, \f2readExternal\fP, \f2writeReplace\fP, and \f2readResolve\fP methods. -.LP -.TP 3 -@since\ since\-text -Adds a "Since" heading with the specified \f2since\-text\fP to the generated documentation. The text has no special internal structure. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. This tag means that this change or feature has existed since the software release specified by the \f2since\-text\fP. For example: -.nf -\f3 -.fl - @since 1.5 -.fl - -.fl -\fP -.fi -.LP -For source code in the Java platform, this tag indicates the version of the Java platform API specification (not necessarily when it was added to the reference implementation). Multiple @since tags are allowed and are treated like multiple @author tags. You could use multiple tags if the prgram element is used by more than one API. -.LP -.TP 3 -@throws\ class\-name\ description -The \f2@throws\fP and \f2@exception\fP tags are synonyms. Adds a "Throws" subheading to the generated documentation, with the \f2class\-name\fP and \f2description\fP text. The \f2class\-name\fP is the name of the exception that may be thrown by the method. This tag is valid only in the doc comment for a method or constructor. If this class is not fully\-specified, the Javadoc tool uses the search order to look up this class. Multiple \f2@throws\fP tags can be used in a given doc comment for the same or different exceptions. -.LP -To ensure that all checked exceptions are documented, if a \f2@throws\fP tag does not exist for an exception in the throws clause, the Javadoc tool automatically adds that exception to the HTML output (with no description) as if it were documented with @throws tag. -.LP -The \f2@throws\fP documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method. The same is true for copying from an interface method to an implementing method. You can use {@inheritDoc} to force @throws to inherit documentation. -.LP -For more details, see -.na -\f2writing @throws tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@exception. -.LP -.TP 3 -{@value\ package.class#field} -When \f2{@value}\fP is used (without any argument) in the doc comment of a static field, it displays the value of that constant: -.nf -\f3 -.fl - /** -.fl - * The value of this constant is {@value}. -.fl - */ -.fl - public static final String SCRIPT_START = "<script>" -.fl - -.fl -\fP -.fi -.LP -When used with argument \f2package.class#field\fP in any doc comment, it displays the value of the specified constant: -.nf -\f3 -.fl - /** -.fl - * Evaluates the script starting with {@value #SCRIPT_START}. -.fl - */ -.fl - public String evalScript(String script) { -.fl - } -.fl - -.fl -\fP -.fi -.LP -The argument \f2package.class#field\fP takes a form identical to that of the @see argument, except that the member must be a static field. -.LP -These values of these constants are also displayed on the -.na -\f2Constant Field Values\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/constant\-values.html page. -.LP -.TP 3 -@version\ version\-text -Adds a "Version" subheading with the specified \f2version\-text\fP to the generated docs when the \-version option is used. This tag is intended to hold the current version number of the software that this code is part of (as opposed to @since, which holds the version number where this code was introduced). The \f2version\-text\fP has no special internal structure. To see where the version tag can be used, see Where Tags Can Be Used. -.LP -A doc comment may contain multiple \f2@version\fP tags. If it makes sense, you can specify one version number per \f2@version\fP tag or multiple version numbers per tag. In the former case, the Javadoc tool inserts a comma (\f2,\fP) and space between names. In the latter case, the entire text is simply copied to the generated document without being parsed. Therefore, you can use multiple names per line if you want a localized name separator other than comma. -.LP -For more details, see -.na -\f2writing @version tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@version. -.RE -.SS -Where Tags Can Be Used -.LP -The following sections describe where the tags can be used. Note that these tags can be used in all doc comments: \f2@see\fP, \f2@since\fP, \f2@deprecated\fP, \f2{@link}\fP, \f2{@linkplain}\fP, and \f2{@docroot}\fP. -.SS -Overview Documentation Tags -.LP -Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named \f2overview.html\fP). Like in any other documentation comments, these tags must appear after the main description. -.LP -\f3NOTE\fP \- The \f2{@link}\fP tag has a bug in overview documents in version 1.2 \-\- the text appears properly but has no link. The \f2{@docRoot}\fP tag does not currently work in overview documents. -.LP -\f3Overview Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -.SS -Package Documentation Tags -.LP -Package tags are tags that can appear in the documentation comment for a package (which resides in the source file named \f2package.html\fP or \f2package\-info.java\fP). The \f2@serial\fP tag can only be used here with the \f2include\fP or \f2exclude\fP argument. -.LP -\f3Package Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -.SS -Class and Interface Documentation Tags -.LP -The following are tags that can appear in the documentation comment for a class or interface. The \f2@serial\fP tag can only be used here with the \f2include\fP or \f2exclude\fP argument. -.LP -\f3Class/Interface Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -\f3An example of a class comment:\fP -.nf -\f3 -.fl -/** -.fl - * A class representing a window on the screen. -.fl - * For example: -.fl - * <pre> -.fl - * Window win = new Window(parent); -.fl - * win.show(); -.fl - * </pre> -.fl - * -.fl - * @author Sami Shaio -.fl - * @version 1.13, 06/08/06 -.fl - * @see java.awt.BaseWindow -.fl - * @see java.awt.Button -.fl - */ -.fl -class Window extends BaseWindow { -.fl - ... -.fl -} -.fl -\fP -.fi -.SS -Field Documentation Tags -.LP -The following are the tags that can appear in -.LP -\f3Field Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@serialField\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.TP 2 -o -\f2{@value}\fP -.RE -\f3An example of a field comment:\fP -.nf -\f3 -.fl - /** -.fl - * The X\-coordinate of the component. -.fl - * -.fl - * @see #getLocation() -.fl - */ -.fl - int x = 1263732; -.fl -\fP -.fi -.SS -Constructor and Method Documentation Tags -.LP -The following are the tags that can appear in the documentation comment for a constructor or method, except for \f2@return\fP, which cannot appear in a constructor, and \f2{@inheritDoc}\fP, which has certain restrictions. The \f2@serialData\fP tag can only be used in the doc comment for certain serialization methods. -.LP -\f3Method/Constructor Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@param\fP -.TP 2 -o -\f2@return\fP -.TP 2 -o -\f2@throws\fP and \f2@exception\fP -.TP 2 -o -\f2@serialData\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@inheritDoc}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -\f3An example of a method doc comment:\fP -.nf -\f3 -.fl - /** -.fl - * Returns the character at the specified index. An index -.fl - * ranges from <code>0</code> to <code>length() \- 1</code>. -.fl - * -.fl - * @param index the index of the desired character. -.fl - * @return the desired character. -.fl - * @exception StringIndexOutOfRangeException -.fl - * if the index is not in the range <code>0</code> -.fl - * to <code>length()\-1</code>. -.fl - * @see java.lang.Character#charValue() -.fl - */ -.fl - public char charAt(int index) { -.fl - ... -.fl - } -.fl -\fP -.fi -.SH "OPTIONS" -.LP -The javadoc tool uses doclets to determine its output. The Javadoc tool uses the default standard doclet unless a custom doclet is specified with the \-doclet option. The Javadoc tool provides a set of command\-line options that can be used with any doclet \-\- these options are described below under the sub\-heading Javadoc Options. The standard doclet provides an additional set of command\-line options that are described below under the sub\-heading Options Provided by the Standard Doclet. All option names are case\-insensitive, though their arguments can be case\-sensitive. -.LP +.TP +@serialData \fIdata-description\fR +Introduced in JDK 1\&.2 + +Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. + +The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.TP +@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR +Introduced in JDK 1\&.2 + +Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. +.TP +@since \fIsince-text\fR +Introduced in JDK 1\&.1 + +Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. + +For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. +.TP +@throws \fIclass-name\fR\fIdescription\fR +Introduced in JDK 1\&.2 + +Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception + +The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. + +To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. + +The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. +.TP +{@value \fIpackage\&.class#field\fR} +Introduced in JDK 1\&.4 + +Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * The value of this constant is {@value}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static final String SCRIPT_START = "<script>"\fP +.fi +.nf +\f3\fR +.fi +.sp + + +When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public String evalScript(String script) {}\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. + +The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html +.TP +@version \fIversion-text\fR +Introduced in JDK 1\&.0 + +Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version + +A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. +.SH WHERE\ TAGS\ CAN\ BE\ USED +The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. +.SS OVERVIEW\ TAGS +Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description +.PP +\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. +.PP +The overview tags are the following: +.PP +@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS PACKAGE\ TAGS +Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. +.PP +The package tags are the following: +.PP +@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS CLASS\ AND\ INTERFACE\ TAGS +The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.PP +Class comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * A class representing a window on the screen\&.\fP +.fi +.nf +\f3 * For example:\fP +.fi +.nf +\f3 * <pre>\fP +.fi +.nf +\f3 * Window win = new Window(parent);\fP +.fi +.nf +\f3 * win\&.show();\fP +.fi +.nf +\f3 * </pre>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @author Sami Shaio\fP +.fi +.nf +\f3 * @version 1\&.13, 06/08/06\fP +.fi +.nf +\f3 * @see java\&.awt\&.BaseWindow\fP +.fi +.nf +\f3 * @see java\&.awt\&.Button\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3class Window extends BaseWindow {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS FIELD\ TAGS +These tags can appear in fields: +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} +.PP +Field comment example: +.sp +.nf +\f3 /**\fP +.fi +.nf +\f3 * The X\-coordinate of the component\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @see #getLocation()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 int x = 1263732;\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS CONSTRUCTOR\ AND\ METHOD\ TAGS +The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} +.PP +\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.PP +Method comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Returns the character at the specified index\&. An index \fP +.fi +.nf +\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @param index the index of the desired character\&.\fP +.fi +.nf +\f3 * @return the desired character\&.\fP +.fi +.nf +\f3 * @exception StringIndexOutOfRangeException \fP +.fi +.nf +\f3 * if the index is not in the range <code>0</code> \fP +.fi +.nf +\f3 * to <code>length()\-1</code>\fP +.fi +.nf +\f3 * @see java\&.lang\&.Character#charValue()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 public char charAt(int index) {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fR +.fi +.sp +.SH OPTIONS +The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. +.TP 0.2i +\(bu +See also Javadoc Options +.TP 0.2i +\(bu +See also Standard Doclet Options +.PP The options are: -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 -.nr 34 \n(.lu -.eo -.am 80 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\-\f21.1\fP -.br -\-author -.br -\-\f2bootclasspath\fP -.br -\-bottom -.br -\-\f2breakiterator\fP -.br -\-charset -.br -\-\f2classpath\fP -.br -\-d -.br -\-docencoding -.br -\-docfilessubdirs -.br -\-\f2doclet\fP -.br -\-\f2docletpath\fP -.br -\-doctitle -.br -\-\f2encoding\fP -.br -\-\f2exclude\fP -.br -\-excludedocfilessubdir -.br -\-\f2extdirs\fP -.br -\-footer -.br -\-group -.br -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\-header -.br -\-\f2help\fP -.br -\-helpfile -.br -\-\f2J\fP -.br -\-keywords -.br -\-link -.br -\-linkoffline -.br -\-linksource -.br -\-\f2locale\fP -.br -\-nocomment -.br -\-nodeprecated -.br -\-nodeprecatedlist -.br -\-nohelp -.br -\-noindex -.br -\-nonavbar -.br -\-noqualifier -.br -\-nosince -.br -\-notimestamp -.br -\-notree -.br -\-\f2overview\fP -.br -\-\f2package\fP -.br -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\-\f2private\fP -.br -\-\f2protected\fP -.br -\-\f2public\fP -.br -\-\f2quiet\fP -.br -\-serialwarn -.br -\-\f2source\fP -.br -\-\f2sourcepath\fP -.br -\-sourcetab -.br -\-splitindex -.br -\-stylesheetfile -.br -\-\f2subpackages\fP -.br -\-tag -.br -\-taglet -.br -\-tagletpath -.br -\-top -.br -\-title -.br -\-use -.br -\-\f2verbose\fP -.br -\-version -.br -\-windowtitle -.br -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.80 -.rm 80 -.nr 38 \n(a- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.81 -.rm 81 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 82 0 -.82 -.rm 82 -.nr 38 \n(c- -.if \n(82<\n(38 .nr 82 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr TW \n(82 -.if t .if \n(TW>\n(.li .tm Table at line 2015 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.ne \n(b|u+\n(.Vu -.ne \n(c|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-127 -.LP -Options shown in \f2italic\fP are the Javadoc core options, which are provided by the front end of the Javadoc tool and are available to all doclets. The standard doclet itself provides the non\-italic options. -.SS -Javadoc Options -.RS 3 -.TP 3 -\-overview \ path/filename -Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by \f2path/filename\fP and place it on the Overview page (\f2overview\-summary.html\fP). The \f2path/filename\fP is relative to the current directory. -.br -.br -While you can use any name you want for \f2filename\fP and place it anywhere you want for \f2path\fP, a typical thing to do is to name it \f2overview.html\fP and place it in the source tree at the directory that contains the topmost package directories. In this location, no \f2path\fP is needed when documenting packages, since \f2\-sourcepath\fP will point to this file. For example, if the source tree for the \f2java.lang\fP package is \f2/src/classes/java/lang/\fP, then you could place the overview file at \f2/src/classes/overview.html\fP. See Real World Example. -.br -.br -For information about the file specified by \f2path/filename\fP, see overview comment file. -.br -.br -Note that the overview page is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) -.br -.br -The title on the overview page is set by \f2\-doctitle\fP. -.TP 3 -\-public -Shows only public classes and members. -.TP 3 -\-protected -Shows only protected and public classes and members. This is the default. -.TP 3 -\-package -Shows only package, protected, and public classes and members. -.TP 3 -\-private -Shows all classes and members. -.TP 3 -\-help -Displays the online help, which lists these javadoc and doclet command line options. -.TP 3 -\-doclet\ class -Specifies the class file that starts the doclet used in generating the documentation. Use the fully\-qualified name. This doclet defines the content and formats the output. If the \f4\-doclet\fP option is not used, javadoc uses the standard doclet for generating the default HTML format. This class must contain the \f2start(Root)\fP method. The path to this starting class is defined by the \f2\-docletpath\fP option. -.br -.br -For example, to call the MIF doclet, use: -.nf -\f3 -.fl - \-doclet com.sun.tools.doclets.mif.MIFDoclet -.fl -\fP -.fi -For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.TP 3 -\-docletpath\ classpathlist -Specifies the path to the doclet starting class file (specified with the \f2\-doclet\fP option) and any jar files it depends on. If the starting class file is in a jar file, then this specifies the path to that jar file, as shown in the example below. You can specify an absolute path or a path relative to the current directory. If \f2classpathlist\fP contains multiple paths or jar files, they should be separated with a colon (:) on Solaris and a semi\-colon (;) on Windows. This option is not necessary if the doclet starting class is already in the search path. -.br -.br -Example of path to jar file that contains the starting doclet class file. Notice the jar filename is included. -.nf -\f3 -.fl - \-docletpath /home/user/mifdoclet/lib/mifdoclet.jar -.fl -\fP -.fi -Example of path to starting doclet class file. Notice the class filename is omitted. -.nf -\f3 -.fl - \-docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/ -.fl -\fP -.fi -For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.TP 3 -\-1.1 -\f2This feature has been removed from Javadoc 1.4. There is no replacement for it. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1.1 (it never supported nested classes). If you need this option, use Javadoc 1.2 or 1.3 instead.\fP -.TP 3 -\-source release -Specifies the version of source code accepted. The following values for \f2release\fP are allowed: -.RS 3 -.TP 2 -o -\f31.5\fP \- javadoc accepts code containing generics and other language features introduced in JDK 1.5. The compiler defaults to the 1.5 behavior if the \f3\-source\fP flag is not used. -.TP 2 -o -\f31.4\fP \- javadoc accepts code containing assertions, which were introduced in JDK 1.4. -.TP 2 -o -\f31.3\fP \- javadoc does \f2not\fP support assertions, generics, or other language features introduced after JDK 1.3. +.PP +-1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title +.PP +The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. +.SS JAVADOC\ OPTIONS +.TP +-overview \fIpath/filename\fR +.br +Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. + +While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. + +For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html + +See Real-World Examples\&. + +For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. + +The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. +.TP +-Xdoclint:(all|none|[-]\fI<group>\fR) +.br +Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. + +This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. + +When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. + +By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. + +Change what the \f3-Xdoclint\fR option reports with the following options: +.RS +.TP 0.2i +\(bu +\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option +.TP 0.2i +\(bu +\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks +.TP 0.2i +\(bu +\f3-Xdoclint all\fR : enable all groups of checks +.TP 0.2i +\(bu +\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks .RE -Use the value of \f2release\fP corresponding to that used when compiling the code with javac. -.TP 3 -\-sourcepath\ sourcepathlist -Specifies the search paths for finding source files (\f2.java\fP) when passing package names or \f2\-subpackages\fP into the \f2javadoc\fP command. The \f2sourcepathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented but whose comments are inherited by the source files being documented. -.br -.br -Note that you can use the \f2\-sourcepath\fP option only when passing package names into the javadoc command \-\- it will not locate \f2.java\fP files passed into the \f2javadoc\fP command. (To locate \f2.java\fP files, cd to that directory or include the path ahead of each file, as shown at Documenting One or More Classes.) If \f2\-sourcepath\fP is omitted, javadoc uses the class path to find the source files (see \-classpath). Therefore, the default \-sourcepath is the value of class path. If \-classpath is omitted and you are passing package names into javadoc, it looks in the current directory (and subdirectories) for the source files. -.br -.br -Set \f2sourcepathlist\fP to the root directory of the source tree for the package you are documenting. For example, suppose you want to document a package called \f2com.mypackage\fP whose source files are located at: -.nf -\f3 -.fl - /home/user/src/com/mypackage/*.java -.fl -\fP -.fi -In this case you would specify the \f2sourcepath\fP to \f2/home/user/src\fP, the directory that contains \f2com/mypackage\fP, and then supply the package name \f2com.mypackage\fP: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user/src/ com.mypackage\fP -.fl -.fi -This is easy to remember by noticing that if you concatenate the value of sourcepath and the package name together and change the dot to a slash "/", you end up with the full path to the package: \f2/home/user/src/com/mypackage\fP. -.br -.br -To point to two source paths: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com.mypackage\fP -.fl -.fi -.TP 3 -\-classpath\ classpathlist -Specifies the paths where javadoc will look for referenced classes (\f2.class\fP files) \-\- these are the documented classes plus any classes referenced by those classes. The \f2classpathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. Follow the instructions in -.na -\f2class path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general documentation for specifying \f2classpathlist\fP. -.br -.br -If \f2\-sourcepath\fP is omitted, the Javadoc tool uses \f2\-classpath\fP to find the source files as well as class files (for backward compatibility). Therefore, if you want to search for source and class files in separate paths, use both \f2\-sourcepath\fP and \f2\-classpath\fP. -.br -.br -For example, if you want to document \f2com.mypackage\fP, whose source files reside in the directory \f2/home/user/src/com/mypackage\fP, and if this package relies on a library in \f2/home/user/lib\fP, you would specify: -.nf -\f3 -.fl - % \fP\f3javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage\fP -.fl -.fi -As with other tools, if you do not specify \f2\-classpath\fP, the Javadoc tool uses the CLASSPATH environment variable, if it is set. If both are not set, the Javadoc tool searches for classes from the current directory. -.br -.br -For an in\-depth description of how the Javadoc tool uses \f2\-classpath\fP to find user classes as it relates to extension classes and bootstrap classes, see -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html. -.br -.br -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a Java program cannot tell the difference between the two invocations). -.br -.br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.TP 3 -\-subpackages\ \ package1:package2:... -Generates documentation from source files in the specified packages and recursively in their subpackages. This option is useful when adding new subpackages to the source code, as they are automatically included. Each \f2package\fP argument is any top\-level subpackage (such as \f2java\fP) or fully qualified package (such as \f2javax.swing\fP) that does not need to contain source files. Arguments are separated by colons (on all operating systmes). Wildcards are not needed or allowed. Use \f2\-sourcepath\fP to specify where to find the packages. This option is smart about not processing source files that are in the source tree but do not belong to the packages, as described at processing of source files. -.br -.br -For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP -.fl -.fi -This command generates documentation for packages named "java" and "javax.swing" and all their subpackages. -.br -.br -You can use \f2\-subpackages\fP in conjunction with \f2\-exclude\fP to exclude specific packages. -.TP 3 -\-exclude\ \ packagename1:packagename2:... -Unconditionally excludes the specified packages and their subpackages from the list formed by \f2\-subpackages\fP. It excludes those packages even if they would otherwise be included by some previous or later \f2\-subpackages\fP option. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude java.net:java.lang\fP -.fl -.fi -would include \f2java.io\fP, \f2java.util\fP, and \f2java.math\fP (among others), but would exclude packages rooted at \f2java.net\fP and \f2java.lang\fP. Notice this excludes \f2java.lang.ref\fP, a subpackage of \f2java.lang\fP). -.TP 3 -\-bootclasspath\ classpathlist -Specifies the paths where the boot classes reside. These are nominally the Java platform classes. The bootclasspath is part of the search path the Javadoc tool will use to look up source and class files. See -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfiles. for more details. Separate directories in \f2classpathlist\fP with colons (:). -.TP 3 -\-extdirs\ dirlist -Specifies the directories where extension classes reside. These are any classes that use the Java Extension mechanism. The extdirs is part of the search path the Javadoc tool will use to look up source and class files. See \f2\-classpath\fP (above) for more details. Separate directories in \f2dirlist\fP with colons (:). -.TP 3 -\-verbose -Provides more detailed messages while javadoc is running. Without the verbose option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting. The verbose option causes the printing of additional messages specifying the number of milliseconds to parse each java source file. -.TP 3 -\-quiet -Shuts off non\-error and non\-warning messages, leaving only the warnings and errors appear, making them easier to view. Also suppresses the version string. -.TP 3 -\-breakiterator\ -Uses the internationalized sentence boundary of -.na -\f2java.text.BreakIterator\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/text/BreakIterator.html to determine the end of the first sentence for English (all other locales already use \f2BreakIterator\fP), rather than an English language, locale\-specific algorithm. By \f2first sentence\fP, we mean the first sentence in the main description of a package, class or member. This sentence is copied to the package, class or member summary, and to the alphabetic index. -.br -.br -From JDK 1.2 forward, the BreakIterator class is already used to determine the end of sentence for all languages but English. Therefore, the \f2\-breakiterator\fP option has no effect except for English from 1.2 forward. English has its own default algorithm: -.RS 3 -.TP 2 -o -English default sentence\-break algorithm \- Stops at a period followed by a space or a HTML block tag, such as \f2<P>\fP. -.TP 2 -o -Breakiterator sentence\-break algorithm \- In general, stops at a period, question mark or exclamation mark followed by a space if the next word starts with a capital letter. This is meant to handle most abbreviations (such as "The serial no. is valid", but won't handle "Mr. Smith"). Doesn't stop at HTML tags or sentences that begin with numbers or symbols. Stops at the last period in "../filename", even if embedded in an HTML tag. +.RS +The variable \fIgroup\fR has one of the following values: +.RS + .RE -NOTE: We have removed from 1.5.0 the breakiterator warning messages that were in 1.4.x and have left the default sentence\-break algorithm unchanged. That is, the \-breakiterator option is not the default in 1.5.0, nor do we expect it to become the default. This is a reversal from our former intention that the default would change in the "next major release" (1.5.0). This means if you have not modified your source code to eliminate the breakiterator warnings in 1.4.x, then you don't have to do anything, and the warnings go away starting with 1.5.0. The reason for this reversal is because any benefit to having breakiterator become the default would be outweighed by the incompatible source change it would require. We regret any extra work and confusion this has caused. -.TP 3 -\-locale\ language_country_variant -\f3Important\fP \- The \f2\-locale\fP option must be placed \f2ahead\fP (to the left) of any options provided by the standard doclet or any other doclet. Otherwise, the navigation bars will appear in English. This is the only command\-line option that is order\-dependent. -.br -.br -Specifies the locale that javadoc uses when generating documentation. The argument is the name of the locale, as described in java.util.Locale documentation, such as \f2en_US\fP (English, United States) or \f2en_US_WIN\fP (Windows variant). -.br -.br -Specifying a locale causes javadoc to choose the resource files of that locale for messages (strings in the navigation bar, headings for lists and tables, help file contents, comments in stylesheet.css, and so forth). It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence. It does not determine the locale of the doc comment text specified in the source files of the documented classes. -.TP 3 -\-encoding\ name -Specifies the encoding name of the source files, such as \f2EUCJIS/SJIS\fP. If this option is not specified, the platform default converter is used. -.br -.br -Also see \-docencoding and \-charset. -.TP 3 -\-Jflag -Passes \f2flag\fP directly to the runtime system java that runs javadoc. Notice there must be no space between the \f2J\fP and the \f2flag\fP. For example, if you need to ensure that the system sets aside 32 megabytes of memory in which to process the generated documentation, then you would call the \f2\-Xmx\fP option of java as follows (\f2\-Xms\fP is optional, as it only sets the size of initial memory, which is useful if you know the minimum amount of memory required): -.nf -\f3 -.fl - % \fP\f3javadoc \-J\-Xmx32m \-J\-Xms32m\fP \f3com.mypackage\fP -.fl -.fi -To tell what version of javadoc you are using, call the "\f2\-version\fP" option of java: -.nf -\f3 -.fl - % \fP\f3javadoc \-J\-version\fP -.fl - java version "1.2" -.fl - Classic VM (build JDK\-1.2\-V, green threads, sunwjit) -.fl -.fi -(The version number of the standard doclet appears in its output stream.) +.TP 0.2i +\(bu +\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. +.TP 0.2i +\(bu +\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. +.TP 0.2i +\(bu +\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. +.TP 0.2i +\(bu +\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. +.TP 0.2i +\(bu +\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. .RE -.SS -Options Provided by the Standard Doclet -.RS 3 -.TP 3 -\-d\ directory -Specifies the destination directory where javadoc saves the generated HTML files. (The "d" means "destination.") Omitting this option causes the files to be saved to the current directory. The value \f2directory\fP can be absolute, or relative to the current working directory. As of 1.4, the destination directory is automatically created when javadoc is run. -.br -.br -For example, the following generates the documentation for the package \f2com.mypackage\fP and saves the results in the \f2/home/user/doc/\fP directory: -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/user/doc com.mypackage\fP -.fl -.fi -.TP 3 -\-use -Includes one "Use" page for each documented class and package. The page describes what packages, classes, methods, constructors and fields use any API of the given class or package. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C. -.br -.br -For example, let us look at what might appear on the "Use" page for String. The \f2getName()\fP method in the \f2java.awt.Font\fP class returns type \f2String\fP. Therefore, \f2getName()\fP uses \f2String\fP, and you will find that method on the "Use" page for \f2String\fP. -.br -.br -Note that this documents only uses of the API, not the implementation. If a method uses \f2String\fP in its implementation but does not take a string as an argument or return a string, that is not considered a "use" of \f2String\fP. -.br -.br -You can access the generated "Use" page by first going to the class or package, then clicking on the "Use" link in the navigation bar. -.TP 3 -\-version -Includes the @version text in the generated docs. This text is omitted by default. To tell what version of the Javadoc tool you are using, use the \f2\-J\-version\fP option. -.TP 3 -\-author -Includes the @author text in the generated docs. -.TP 3 -\-splitindex -Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non\-alphabetical characters. -.TP 3 -\-windowtitle\ title -Specifies the title to be placed in the HTML <title> tag. This appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page. This title should not contain any HTML tags, as the browser will not properly interpret them. Any internal quotation marks within \f2title\fP may have to be escaped. If \-windowtitle is omitted, the Javadoc tool uses the value of \-doctitle for this option. -.nf -\f3 -.fl - % \fP\f3javadoc \-windowtitle "Java SE Platform" com.mypackage\fP -.fl -.fi -.TP 3 -\-doctitle\ title -Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level\-one heading directly beneath the upper navigation bar. The \f2title\fP may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2title\fP may have to be escaped. -.nf -\f3 -.fl - % \fP\f3javadoc \-doctitle "Java(TM)" com.mypackage\fP -.fl -.fi -.TP 3 -\-title\ title -\f3This option no longer exists.\fP It existed only in Beta versions of Javadoc 1.2. It has been renamed to \f2\-doctitle\fP. This option is being renamed to make it clear that it defines the document title rather than the window title. -.TP 3 -\-header\ header -Specifies the header text to be placed at the top of each output file. The header will be placed to the right of the upper navigation bar. \f2header\fP may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2header\fP may have to be escaped. -.nf -\f3 -.fl - % \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP -.fl -.fi -.TP 3 -\-footer\ footer -Specifies the footer text to be placed at the bottom of each output file. The footer will be placed to the right of the lower navigation bar. \f2footer\fP may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2footer\fP may have to be escaped. -.TP 3 -\-top -Specifies the text to be placed at the top of each output file. -.TP 3 -\-bottom\ text -Specifies the text to be placed at the bottom of each output file. The text will be placed at the bottom of the page, below the lower navigation bar. The \f2text\fP may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2text\fP may have to be escaped. -.TP 3 -\-link\ extdocURL -Creates links to existing javadoc\-generated documentation of external referenced classes. It takes one argument: -.RS 3 -.TP 2 -o -\f4extdocURL\fP is the absolute or relative URL of the directory containing the external javadoc\-generated documentation you want to link to. Examples are shown below. The package\-list file must be found in this directory (otherwise, use \f2\-linkoffline\fP). The Javadoc tool reads the package names from the \f2package\-list\fP file and then links to those packages at that URL. When the Javadoc tool is run, the \f2extdocURL\fP value is copied literally into the \f2<A HREF>\fP links that are created. Therefore, \f2extdocURL\fP must be the URL to the \f2directory\fP, not to a file. -.br -.br -You can use an absolute link for \f2extdocURL\fP to enable your docs to link to a document on any website, or can use a relative link to link only to a relative location. If relative, the value you pass in should be the relative path from the destination directory (specified with \f2\-d\fP) to the directory containing the packages being linked to. -.br -.br -When specifying an absolute link you normally use an \f2http:\fP link. However, if you want to link to a file system that has no web server, you can use a \f2file:\fP link \-\- however, do this only if everyone wanting to access the generated documentation shares the same file system. -.br -.br -In all cases, and on all operating systems, you should use a forward slash as the separator, whether the URL is absolute or relative, and "http:" or "file:" based (as specified in the -.na -\f2URL Memo\fP @ -.fi -http://www.ietf.org/rfc/rfc1738.txt). -.RS 3 -.TP 3 -Absolute http: based link: -\f2\-link http://<host>/<directory>/<directory>/.../<name>\fP -.TP 3 -Absolute file: based link: -\f2\-link file://<host>/<directory>/<directory>/.../<name>\fP -.TP 3 -Relative link: -\f2\-link <directory>/<directory>/.../<name>\fP +.RS +You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. +.sp +.nf +\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP +.fi +.nf +\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. + +The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. + .RE +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. This is the default\&. +.TP +-package +.br +Shows only package, protected, and public classes and members\&. +.TP +-private +.br +Shows all classes and members\&. +.TP +-help +.br +Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. +.TP +-doclet \fIclass\fR +.br +Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-docletpath \fIclasspathlist\fR +.br +Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-1\&.1 +.br +Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. +.TP +-source \fIrelease\fR +.br +Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. +.RS +.TP 0.2i +\(bu +\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. +.RE + +.TP +-sourcepath \fIsourcepathlist\fR +.br +Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. + +You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. + +Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. + +For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: +.sp +.nf +\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: + +/home/user/src/com/mypackage + +To point to two source paths: +.sp +.nf +\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-classpath \fIclasspathlist\fR +.br +Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. + +If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. + +For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/libthen you would use the following command: +.sp +.nf +\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. + +For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. +.TP +-subpackages \fIpackage1:package2:\&.\&.\&.\fR +.br +Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. + +For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. +.sp +.nf +\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-exclude \fIpackagename1:packagename2:\&.\&.\&.\fR +.br +Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. + +The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. +.sp +.nf +\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP +.fi +.nf +\f3 java\&.net:java\&.lang\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-bootclasspath \fIclasspathlist\fR +.br +Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-extdirs \fIdirist\fR +.br +Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-verbose +.br +Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. +.TP +-quiet +.br +Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. +.TP +-breakiterator +.br +Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: +.RS +.TP 0.2i +\(bu +English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. +.TP 0.2i +\(bu +Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. .RE -You can specify multiple \f2\-link\fP options in a given javadoc run to link to multiple documents. -.br -.br -\f3Choosing between \-linkoffline and \-link\fP: -.br -.br -Use \f2\-link\fP: -.RS 3 -.TP 2 -o -when using a relative path to the external API document, or -.TP 2 -o -when using an absolute URL to the external API document, if your shell allows a program to open a connection to that URL for reading. +.RS +In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. + .RE -Use \f2\-linkoffline\fP: -.RS 3 -.TP 2 -o -when using an absolute URL to the external API document, if your shell \f2does not allow\fP a program to open a connection to that URL for reading. This can occur if you are behind a firewall and the document you want to link to is on the other side. +.TP +-locale \fIlanguage_country_variant\fR +.br +Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. + +\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. + +Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. +.TP +-encoding +.br +Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. + +There is no space between the \f3J\fR and the \f3flag\fR\&. + +Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. +.sp +.nf +\f3javadoc \-J\-version\fP +.fi +.nf +\f3java version "1\&.7\&.0_09"\fP +.fi +.nf +\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP +.fi +.nf +\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP +.fi +.nf +\f3\fR +.fi +.sp + +.SS STANDARD\ DOCLET\ OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. + +For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. +.TP +-use +.br +Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. +.TP +-version +.br +Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. +.TP +-author +.br +Includes the \f3@author\fR text in the generated docs\&. +.TP +-splitindex +.br +Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. +.TP +-windowtitle \fItitle\fR +.br +Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. +.TP +-doctitle \fItitle\fR +.br +Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-title \fItitle\fR +.br +No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. +.TP +-header \fIheader\fR +.br +Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-footer \fIfooter\fR +.br +Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. +.TP +-top +.br +Specifies the text to be placed at the top of each output file\&. +.TP +-bottom \fItext\fR +.br +Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. +.TP +-link \fIextdocURL\fR +.br +Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. + +The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.sp +.nf +\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Differences between the -linkoffline and -link options + +Use the \f3-link\fR option in the following cases: +.TP 0.2i +\(bu +When you use a relative path to the external API document\&. +.TP 0.2i +\(bu +When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. +.PP +Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. +.PP +\f3Example 1 Absolute Link to External Documents\fR +.PP +Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.sp +.nf +\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp +The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. +.PP +\f3Example 2 Relative Link to External Documents\fR +.PP +In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. +.PP +Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. +.PP +Notes + +The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. +.PP +How to Reference a Class + +For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: +.PP +\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. +.PP +In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. +.PP +\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR +.PP +The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. +.PP +An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. +.PP +Package List + +The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. +.PP +For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.PP +The package list starts as follows: +.sp +.nf +\f3java\&.applet\fP +.fi +.nf +\f3java\&.awt\fP +.fi +.nf +\f3java\&.awt\&.color\fP +.fi +.nf +\f3java\&.awt\&.datatransfer\fP +.fi +.nf +\f3java\&.awt\&.dnd\fP +.fi +.nf +\f3java\&.awt\&.event\fP +.fi +.nf +\f3java\&.awt\&.font\fP +.fi +.nf +\f3and so on \&.\&.\&.\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. +.PP +For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. +.PP +Multiple Links + +You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. +.PP +Cross Links + +Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. +.PP +In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. +.TP +-linkoffline \fIextdocURL packagelistLoc\fR +.br +This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: +.RS +.TP 0.2i +\(bu +The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. +.TP 0.2i +\(bu +The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. + +You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. +.RE + +.PP +Absolute Links to External Documents + +You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.PP +However, your shell does not have web access\&. In this case, do the following: +.TP 0.4i +1\&. +Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.TP 0.4i +2\&. +Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. +.PP +The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. +.sp +.nf +\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Relative Links to External Documents + +It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. +.PP +Create a package-list File Manually + +If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. +.PP +Link to Multiple Documents + +You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: +.sp +.nf +\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP +.fi +.nf +\f3packagelistLoc2 \&.\&.\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Update Documents + +You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. +.PP +First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: +.sp +.nf +\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp +When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. +.TP +-linksource +.br +Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. + +This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. + +Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: +.sp +.nf +\f3public class Button extends Component implements Accessible\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: +.sp +.nf +\f3public String getLabel()\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-group groupheading \fIpackagepattern:packagepattern\fR +.br +Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. +.RS +.TP 0.2i +\(bu +The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. +.TP 0.2i +\(bu +The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. .RE -.br -.br -\f3Example using absolute links to the external docs\fP \- Let us say you want to link to the \f2java.lang\fP, \f2java.io\fP and other Java Platform packages at -.na -\f2http://download.oracle.com/javase/7/docs/api/\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/. The following command generates documentation for the package \f2com.mypackage\fP with links to the Java SE Platform packages. The generated documentation will contain links to the \f2Object\fP class, for example, in the class trees. (Other options, such as \f2\-sourcepath\fP and \f2\-d\fP, are not shown.) -.nf -\f3 -.fl - % \fP\f3javadoc \-link http://download.oracle.com/javase/7/docs/api/ com.mypackage\fP -.fl -.fi -\f3Example using relative links to the external docs\fP \- Let us say you have two packages whose docs are generated in different runs of the Javadoc tool, and those docs are separated by a relative path. In this example, the packages are \f2com.apipackage\fP, an API, and \f2com.spipackage\fP, an SPI (Service Provide Interface). You want the documentation to reside in \f2docs/api/com/apipackage\fP and \f2docs/spi/com/spipackage\fP. Assuming the API package documentation is already generated, and that \f2docs\fP is the current directory, you would document the SPI package with links to the API documentation by running: -.nf -\f3 -.fl - % \fP\f3javadoc \-d ./spi \-link ../api com.spipackage\fP -.fl -.fi -Notice the \f2\-link\fP argument is relative to the destination directory (\f2docs/spi\fP). -.br -.br -\f3Details\fP \- The \f2\-link\fP option enables you to link to classes referenced to by your code but \f2not\fP documented in the current javadoc run. For these links to go to valid pages, you must know where those HTML pages are located, and specify that location with \f2extdocURL\fP. This allows, for instance, third party documentation to link to \f2java.*\fP documentation on \f2http://java.sun.com\fP. -.br -.br -Omit the \f2\-link\fP option for javadoc to create links only to API within the documentation it is generating in the current run. (Without the \f2\-link\fP option, the Javadoc tool does not create links to documentation for external references, because it does not know if or where that documentation exists.) -.br -.br -This option can create links in several places in the generated documentation. -.br -.br -Another use is for cross\-links between sets of packages: Execute javadoc on one set of packages, then run javadoc again on another set of packages, creating links both ways between both sets. -.br -.br -\f3How a Class Must be Referenced\fP \- For a link to an external referenced class to actually appear (and not just its text label), the class must be referenced in the following way. It is not sufficient for it to be referenced in the body of a method. It must be referenced in either an \f2import\fP statement or in a declaration. Here are examples of how the class \f2java.io.File\fP can be referenced: -.RS 3 -.TP 2 -o -In any kind of \f2import\fP statement: by wildcard import, import explicitly by name, or automatically import for \f2java.lang.*\fP. For example, this would suffice: -.br -\f2import java.io.*;\fP -.br -In 1.3.x and 1.2.x, only an explicit import by name works \-\- a wildcard import statement does not work, nor does the automatic import \f2java.lang.*\fP. -.TP 2 -o -In a declaration: -.br -\f2void foo(File f) {}\fP -.br -The reference and be in the return type or parameter type of a method, constructor, field, class or interface, or in an \f2implements\fP, \f2extends\fP or \f2throws\fP statement. +.RS +When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. + +For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. +.sp +.nf +\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP +.fi +.nf +\f3 \-group "Extension Packages" "javax\&.*"\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fICore Packages\fR + +\f3java\&.lang\fR + +\f3java\&.lang\&.reflect\fR + +\f3java\&.util\fR + +\fIExtension Packages\fR + +\f3javax\&.servlet\fR + +\fIOther Packages\fR + +\f3java\&.new\fR + .RE -An important corollary is that when you use the \f2\-link\fP option, there may be many links that unintentionally do not appear due to this constraint. (The text would appear without a hypertext link.) You can detect these by the warnings they emit. The most innocuous way to properly reference a class and thereby add the link would be to import that class, as shown above. -.br -.br -\f3Package List\fP \- The \f2\-link\fP option requires that a file named \f2package\-list\fP, which is generated by the Javadoc tool, exist at the URL you specify with \f2\-link\fP. The \f2package\-list\fP file is a simple text file that lists the names of packages documented at that location. In the earlier example, the Javadoc tool looks for a file named \f2package\-list\fP at the given URL, reads in the package names and then links to those packages at that URL. -.br -.br -For example, the package list for the Java SE 6 API is located at -.na -\f2http://download.oracle.com/javase/7/docs/api/package\-list\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/package\-list. and starts as follows: -.nf -\f3 -.fl - java.applet -.fl - java.awt -.fl - java.awt.color -.fl - java.awt.datatransfer -.fl - java.awt.dnd -.fl - java.awt.event -.fl - java.awt.font -.fl - etc. -.fl -\fP -.fi -When javadoc is run without the \f2\-link\fP option, when it encounters a name that belongs to an external referenced class, it prints the name with no link. However, when the \f2\-link\fP option is used, the Javadoc tool searches the \f2package\-list\fP file at the specified \f2extdocURL\fP location for that package name. If it finds the package name, it prefixes the name with \f2extdocURL\fP. -.br -.br -In order for there to be no broken links, all of the documentation for the external references must exist at the specified URLs. The Javadoc tool will not check that these pages exist \-\- only that the package\-list exists. -.br -.br -\f3Multiple Links\fP \- You can supply multiple \f2\-link\fP options to link to any number of external generated documents. \ Javadoc 1.2 has a known bug which prevents you from supplying more than one \f2\-link\fP command. This was fixed in 1.2.2. -.br -.br -Specify a different link option for each external document to link to: -.br -.br -\ \ \f2% \fP\f4javadoc \-link\fP \f2extdocURL1\fP \f4\-link\fP \f2extdocURL2\fP \f2... \fP\f4\-link\fP \f2extdocURLn\fP \f4com.mypackage\fP -.br -.br -where \f2extdocURL1\fP,\ \f2extdocURL2\fP,\ ... \f2extdocURLn\fP point respectively to the roots of external documents, each of which contains a file named \f2package\-list\fP. -.br -.br -\f3Cross\-links\fP \- Note that "bootstrapping" may be required when cross\-linking two or more documents that have not previously been generated. In other words, if \f2package\-list\fP does not exist for either document, when you run the Javadoc tool on the first document, the \f2package\-list\fP will not yet exist for the second document. Therefore, to create the external links, you must re\-generate the first document after generating the second document. -.br -.br -In this case, the purpose of first generating a document is to create its \f2package\-list\fP (or you can create it by hand it if you're certain of the package names). Then generate the second document with its external links. The Javadoc tool prints a warning if a needed external \f2package\-list\fP file does not exist. -.TP 3 -\-linkoffline\ extdocURL\ packagelistLoc -This option is a variation of \f2\-link\fP; they both create links to javadoc\-generated documentation for external referenced classes. Use the \f2\-linkoffline\fP option when linking to a document on the web when the Javadoc tool itself is "offline" \-\- that is, it cannot access the document through a web connection. -.br -.br -More specifically, use \f2\-linkoffline\fP if the external document's \f2package\-list\fP file is not accessible or does not exist at the \f2extdocURL\fP location but does exist at a different location, which can be specified by \f2packageListLoc\fP (typically local). Thus, if \f2extdocURL\fP is accessible only on the World Wide Web, \f2\-linkoffline\fP removes the constraint that the Javadoc tool have a web connection when generating the documentation. -.br -.br -Another use is as a "hack" to update docs: After you have run javadoc on a full set of packages, then you can run javadoc again on onlya smaller set of changed packages, so that the updated files can be inserted back into the original set. Examples are given below. -.br -.br -The \f2\-linkoffline\fP option takes two arguments \-\- the first for the string to be embedded in the \f2<a href>\fP links, the second telling it where to find \f2package\-list\fP: -.RS 3 -.TP 2 -o -\f4extdocURL\fP is the absolute or relative URL of the directory containing the external javadoc\-generated documentation you want to link to. If relative, the value should be the relative path from the destination directory (specified with \f2\-d\fP) to the root of the packages being linked to. For more details, see \f2extdocURL\fP in the \f2\-link\fP option. -.TP 2 -o -\f4packagelistLoc\fP is the path or URL to the directory containing the \f2package\-list\fP file for the external documentation. This can be a URL (http: or file:) or file path, and can be absolute or relative. If relative, make it relative to the \f2current\fP directory from where javadoc was run. Do not include the \f2package\-list\fP filename. -.RE -You can specify multiple \f2\-linkoffline\fP options in a given javadoc run. (Prior to 1.2.2, it could be specified only once.) -.br -.br -\f3Example using absolute links to the external docs\fP \- Let us say you want to link to the \f2java.lang\fP, \f2java.io\fP and other Java SE Platform packages at \f2http://download.oracle.com/javase/7/docs/api/\fP, but your shell does not have web access. You could open the \f2package\-list\fP file in a browser at -.na -\f2http://download.oracle.com/javase/7/docs/api/package\-list\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/package\-list, save it to a local directory, and point to this local copy with the second argument, \f2packagelistLoc\fP. In this example, the package list file has been saved to the current directory "\f2.\fP" . The following command generates documentation for the package \f2com.mypackage\fP with links to the Java SE Platform packages. The generated documentation will contain links to the \f2Object\fP class, for example, in the class trees. (Other necessary options, such as \f2\-sourcepath\fP, are not shown.) -.nf -\f3 -.fl -% \fP\f3javadoc \-linkoffline http://download.oracle.com/javase/7/docs/api/ . com.mypackage\fP -.fl -.fi -\f3Example using relative links to the external docs\fP \- It's not very common to use \f2\-linkoffline\fP with relative paths, for the simple reason that \f2\-link\fP usually suffices. When using \f2\-linkoffline\fP, the \f2package\-list\fP file is generally local, and when using relative links, the file you are linking to is also generally local. So it is usually unnecessary to give a different path for the two arguments to \f2\-linkoffline\fP. When the two arguments are identical, you can use \f2\-link\fP. See the \f2\-link\fP relative example. -.br -.br -\f3Manually Creating a \fP\f4package\-list\fP\f3 File\fP \- If a \f2package\-list\fP file does not yet exist, but you know what package names your document will link to, you can create your own copy of this file by hand and specify its path with \f2packagelistLoc\fP. An example would be the previous case where the package list for \f2com.spipackage\fP did not exist when \f2com.apipackage\fP was first generated. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published. This is also a way of creating \f2package\-list\fP files for packages generated with Javadoc 1.0 or 1.1, where \f2package\-list\fP files were not generated. Likewise, two companies can share their unpublished \f2package\-list\fP files, enabling them to release their cross\-linked documentation simultaneously. -.br -.br -\f3Linking to Multiple Documents\fP \- You can include \f2\-linkoffline\fP once for each generated document you want to refer to (each option is shown on a separate line for clarity): -.br -.br -\f2% \fP\f4javadoc \-linkoffline\fP \f2extdocURL1\fP \f2packagelistLoc1\fP \f2\\\fP -.br -\f2\ \ \ \ \ \ \ \ \ \ \fP\f4\-linkoffline\fP \f2extdocURL2\fP \f2packagelistLoc2\fP \f2\\\fP -.br -\f2\ \ \ \ \ \ \ \ \ \ ...\fP -.br -.br -\f3Updating docs\fP \- Another use for \f2\-linkoffline\fP option is useful if your project has dozens or hundreds of packages, if you have already run javadoc on the entire tree, and now, in a separate run, you want to quickly make some small changes and re\-run javadoc on just a small portion of the source tree. This is somewhat of a hack in that it works properly only if your changes are only to doc comments and not to declarations. If you were to add, remove or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, use page, and other places. -.br -.br -First, you create a new destination directory (call it \f2update\fP) for this new small run. Let us say the original destination directory was named \f2html\fP. In the simplest example, cd to the parent of \f2html\fP. Set the first argument of \f2\-linkoffline\fP to the current directory "." and set the second argument to the relative path to \f2html\fP, where it can find \f2package\-list\fP, and pass in only the package names of the packages you want to update: -.nf -\f3 -.fl - % \fP\f3javadoc \-d update \-linkoffline . html com.mypackage\fP -.fl -.fi -When the Javadoc tool is done, copy these generated class pages in \f2update/com/package\fP (not the overview or index), over the original files in \f2html/com/package\fP. -.TP 3 -\-linksource\ -Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation. Links are created for classes, interfaces, constructors, methods and fields whose declarations are in a source file. Otherwise, links are not created, such as for default constructors and generated classes. -.br -.br -\f3This option exposes \fP\f4all\fP\f3 private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, \fP\f4regardless of the \fP\f4\-public\fP\f3, \fP\f4\-package\fP\f3, \fP\f4\-protected\fP\f3 and \fP\f4\-private\fP\f3 options.\fP Unless you also use the \f2\-private\fP option, not all private classes or interfaces will necessarily be accessible via links. -.br -.br -Each link appears on the name of the identifier in its declaration. For example, the link to the source code of the \f2Button\fP class would be on the word "Button": -.nf -\f3 -.fl - public class Button -.fl - extends Component -.fl - implements Accessible -.fl -\fP -.fi -and the link to the source code of the \f2getLabel()\fP method in the Button class would be on the word "getLabel": -.nf -\f3 -.fl - public String getLabel() -.fl -\fP -.fi -.TP 3 -\-group\ groupheading\ packagepattern:packagepattern:... -Separates packages on the overview page into whatever groups you specify, one group per table. You specify each group with a different \f2\-group\fP option. The groups appear on the page in the order specified on the command line; packages are alphabetized within a group. For a given \f2\-group\fP option, the packages matching the list of \f2packagepattern\fP expressions appear in a table with the heading \f2groupheading\fP. -.RS 3 -.TP 2 -o -\f4groupheading\fP can be any text, and can include white space. This text is placed in the table heading for the group. -.TP 2 -o -\f4packagepattern\fP can be any package name, or can be the start of any package name followed by an asterisk (\f2*\fP). The asterisk is a wildcard meaning "match any characters". This is the only wildcard allowed. Multiple patterns can be included in a group by separating them with colons (\f2:\fP). -.RE -\f3NOTE: If using an asterisk in a pattern or pattern list, the pattern list must be inside quotes, such as \fP\f4"java.lang*:java.util"\fP -.br -.br -If you do not supply any \f2\-group\fP option, all packages are placed in one group with the heading "Packages". If the all groups do not include all documented packages, any leftover packages appear in a separate group with the heading "Other Packages". -.br -.br -For example, the following option separates the four documented packages into core, extension and other packages. Notice the trailing "dot" does not appear in "java.lang*" \-\- including the dot, such as "java.lang.*" would omit the java.lang package. -.nf -\f3 -.fl - % \fP\f3javadoc \-group "Core Packages" "java.lang*:java.util" -.fl - \-group "Extension Packages" "javax.*" -.fl - java.lang java.lang.reflect java.util javax.servlet java.new\fP -.fl -.fi -This results in the groupings: -.RS 3 -.TP 3 -Core Packages -\f2java.lang\fP -\f2java.lang.reflect\fP -\f2java.util\fP -.TP 3 -Extension Packages -\f2javax.servlet\fP -.TP 3 -Other Packages -\f2java.new\fP -.RE -.TP 3 -\-nodeprecated -Prevents the generation of any deprecated API at all in the documentation. This does what \-nodeprecatedlist does, plus it does not generate any deprecated API throughout the rest of the documentation. This is useful when writing code and you don't want to be distracted by the deprecated code. -.TP 3 -\-nodeprecatedlist -Prevents the generation of the file containing the list of deprecated APIs (deprecated\-list.html) and the link in the navigation bar to that page. (However, javadoc continues to generate the deprecated API throughout the rest of the document.) This is useful if your source code contains no deprecated API, and you want to make the navigation bar cleaner. -.TP 3 -\-nosince -Omits from the generated docs the "Since" sections associated with the @since tags. -.TP 3 -\-notree -Omits the class/interface hierarchy pages from the generated docs. These are the pages you reach using the "Tree" button in the navigation bar. The hierarchy is produced by default. -.TP 3 -\-noindex -Omits the index from the generated docs. The index is produced by default. -.TP 3 -\-nohelp -Omits the HELP link in the navigation bars at the top and bottom of each page of output. -.TP 3 -\-nonavbar -Prevents the generation of the navigation bar, header and footer, otherwise found at the top and bottom of the generated pages. Has no affect on the "bottom" option. The \f2\-nonavbar\fP option is useful when you are interested only in the content and have no need for navigation, such as converting the files to PostScript or PDF for print only. -.TP 3 -\-helpfile\ path/filename -Specifies the path of an alternate help file \f2path/filename\fP that the HELP link in the top and bottom navigation bars link to. Without this option, the Javadoc tool automatically creates a help file \f2help\-doc.html\fP that is hard\-coded in the Javadoc tool. This option enables you to override this default. The \f2filename\fP can be any name and is not restricted to \f2help\-doc.html\fP \-\- the Javadoc tool will adjust the links in the navigation bar accordingly. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-helpfile /home/user/myhelp.html java.awt\fP -.fl -.fi -.TP 3 -\-stylesheetfile\ path/filename -Specifies the path of an alternate HTML stylesheet file. Without this option, the Javadoc tool automatically creates a stylesheet file \f2stylesheet.css\fP that is hard\-coded in the Javadoc tool. This option enables you to override this default. The \f2filename\fP can be any name and is not restricted to \f2stylesheet.css\fP. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-stylesheetfile /home/user/mystylesheet.css com.mypackage\fP -.fl -.fi -.TP 3 -\-serialwarn -Generates compile\-time warnings for missing @serial tags. By default, Javadoc 1.2.2 (and later versions) generates no serial warnings. (This is a reversal from earlier versions.) Use this option to display the serial warnings, which helps to properly document default serializable fields and \f2writeExternal\fP methods. -.TP 3 -\-charset\ name -Specifies the HTML character set for this document. The name should be a preferred MIME name as given in the -.na -\f2IANA Registry\fP @ -.fi -http://www.iana.org/assignments/character\-sets. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-charset "iso\-8859\-1" mypackage\fP -.fl -.fi -would insert the following line in the head of every generated page: -.nf -\f3 -.fl - <META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1"> -.fl -\fP -.fi -This META tag is described in the -.na -\f2HTML standard\fP @ -.fi -http://www.w3.org/TR/REC\-html40/charset.html#h\-5.2.2. (4197265 and 4137321) -.br -.br -Also see \-encoding and \-docencoding. -.TP 3 -\-docencoding\ name -Specifies the encoding of the generated HTML files. The name should be a preferred MIME name as given in the -.na -\f2IANA Registry\fP @ -.fi -http://www.iana.org/assignments/character\-sets. If you omit this option but use \-encoding, then the encoding of the generated HTML files is determined by \-encoding. Example: -.nf -\f3 -.fl - % \fP\f3javadoc \-docencoding "ISO\-8859\-1" mypackage\fP -.fl -.fi -Also see \-encoding and \-charset. -.TP 3 -\-keywords -Adds HTML meta keyword tags to the generated file for each class. These tags can help the page be found by search engines that look for meta tags. (Most search engines that search the entire Internet do not look at meta tags, because pages can misuse them; but search engines offered by companies that confine their search to their own website can benefit by looking at meta tags.) -.br -.br -The meta tags include the fully qualified name of the class and the unqualified names of the fields and methods. Constructors are not included because they are identical to the class name. For example, the class String starts with these keywords: -.nf -\f3 -.fl - <META NAME="keywords" CONTENT="java.lang.String class"> -.fl - <META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER"> -.fl - <META NAME="keywords" CONTENT="length()"> -.fl - <META NAME="keywords" CONTENT="charAt()"> -.fl -\fP -.fi -.TP 3 -\-tag\ \ tagname:Xaoptcmf:"taghead" -Enables the Javadoc tool to interpret a simple, one\-argument custom block tag \f2@\fP\f2tagname\fP in doc comments. So the Javadoc tool can "spell\-check" tag names, it is important to include a \f2\-tag\fP option for every custom tag that is present in the source code, disabling (with \f2X\fP) those that are not being output in the current run. -.br -.br -The colon (\f4:\fP) is always the separator. To use a colon in \f2tagname\fP, see Use of Colon in Tag Name. -.br -.br -The \f2\-tag\fP option outputs the tag's heading \f2taghead\fP in bold, followed on the next line by the text from its single argument, as shown in the example below. Like any block tag, this argument's text can contain inline tags, which are also interpreted. The output is similar to standard one\-argument tags, such as \f2@return\fP and \f2@author\fP. Omitting \f2taghead\fP causes \f2tagname\fP to appear as the heading. -.br -.br -\f3Placement of tags\fP \- The \f4Xaoptcmf\fP part of the argument determines where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f2X\fP). You can supply either \f4a\fP, to allow the tag in all places, or any combination of the other letters: -.br -.br -\f4X\fP (disable tag) -.br -\f4a\fP (all) -.br -\f4o\fP (overview) -.br -\f4p\fP (packages) -.br -\f4t\fP (types, that is classes and interfaces) -.br -\f4c\fP (constructors) -.br -\f4m\fP (methods) -.br -\f4f\fP (fields) -.br -.br -\f3Examples of single tags\fP \- An example of a tag option for a tag that can be used anywhere in the source code is: -.nf -\f3 -.fl - \-tag todo:a:"To Do:" -.fl -\fP -.fi -If you wanted @todo to be used only with constructors, methods and fields, you would use: -.nf -\f3 -.fl - \-tag todo:cmf:"To Do:" -.fl -\fP -.fi -Notice the last colon (\f2:\fP) above is not a parameter separator, but is part of the heading text (as shown below). You would use either tag option for source code that contains the tag \f2@todo\fP, such as: -.nf -\f3 -.fl - @todo The documentation for this method needs work. -.fl -\fP -.fi -\f3Use of Colon in Tag Name\fP \- A colon can be used in a tag name if it is escaped with a backslash. For this doc comment: -.nf -\f3 -.fl - /** -.fl - * @ejb:bean -.fl - */ -.fl -\fP -.fi -use this tag option: -.nf -\f3 -.fl - \-tag ejb\\\\:bean:a:"EJB Bean:" -.fl -\fP -.fi -\f3Spell\-checking tag names (Disabling tags)\fP \- Some developers put custom tags in the source code that they don't always want to output. In these cases, it is important to list all tags that are present in the source code, enabling the ones you want to output and disabling the ones you don't want to output. The presence of \f2X\fP disables the tag, while its absence enables the tag. This gives the Javadoc tool enough information to know if a tag it encounters is unknown, probably the results of a typo or a misspelling. It prints a warning in these cases. -.br -.br -You can add \f2X\fP to the placement values already present, so that when you want to enable the tag, you can simply delete the \f2X\fP. For example, if @todo is a tag that you want to suppress on output, you would use: -.nf -\f3 -.fl - \-tag todo:Xcmf:"To Do:" -.fl -\fP -.fi -or, if you'd rather keep it simple: -.nf -\f3 -.fl - \-tag todo:X -.fl -\fP -.fi -The syntax \f2\-tag todo:X\fP works even if \f2@todo\fP is defined by a taglet. -.br -.br -\f3Order of tags\fP \- The order of the \f2\-tag\fP (and \f2\-taglet\fP) options determine the order the tags are output. You can mix the custom tags with the standard tags to intersperse them. The tag options for standard tags are placeholders only for determining the order \-\- they take only the standard tag's name. (Subheadings for standard tags cannot be altered.) This is illustrated in the following example. -.br -.br -If \f2\-tag\fP is missing, then the position of \f2\-taglet\fP determines its order. If they are both present, then whichever appears last on the command line determines its order. (This happens because the tags and taglets are processed in the order that they appear on the command line. For example, if \f2\-taglet\fP and \f2\-tag\fP both have the name "todo", the one that appears last on the command line will determine its order. -.br -.br -\f3Example of a complete set of tags\fP \- This example inserts "To Do" after "Parameters" and before "Throws" in the output. By using "X", it also specifies that @example is a tag that might be encountered in the source code that should not be output during this run. Notice that if you use @argfile, you can put the tags on separate lines in an argument file like this (no line continuation characters needed): -.nf -\f3 -.fl - \-tag param -.fl - \-tag return -.fl - \-tag todo:a:"To Do:" -.fl - \-tag throws -.fl - \-tag see -.fl - \-tag example:X -.fl -\fP -.fi -When javadoc parses the doc comments, any tag encountered that is neither a standard tag nor passed in with \f2\-tag\fP or \f2\-taglet\fP is considered unknown, and a warning is thrown. -.br -.br -The standard tags are initially stored internally in a list in their default order. Whenever \f2\-tag\fP options are used, those tags get appended to this list \-\- standard tags are moved from their default position. Therefore, if a \f2\-tag\fP option is omitted for a standard tag, it remains in its default position. -.br -.br -\f3Avoiding Conflicts\fP \- If you want to slice out your own namespace, you can use a dot\-separated naming convention similar to that used for packages: \f2com.mycompany.todo\fP. Oracle will continue to create standard tags whose names do not contain dots. Any tag you create will override the behavior of a tag by the same name defined by Oracle. In other words, if you create a tag or taglet \f2@todo\fP, it will always have the same behavior you define, even if Oracle later creates a standard tag of the same name. -.br -.br -\f3Annotations vs. Javadoc Tags\fP \- In general, if the markup you want to add is intended to affect or produce documentation, it should probably be a javadoc tag; otherwise, it should be an annotation. See -.na -\f2Comparing Annotations and Javadoc Tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#annotations< -.br -.br -You can also create more complex block tags, or custom inline tags with the \-taglet option. -.TP 3 -\-taglet\ \ class -Specifies the class file that starts the taglet used in generating the documentation for that tag. Use the fully\-qualified name for \f2class\fP. This taglet also defines the number of text arguments that the custom tag has. The taglet accepts those arguments, processes them, and generates the output. For extensive documentation with example taglets, see: -.RS 3 -.TP 2 -o -.na -\f2Taglet Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html -.RE -Taglets are useful for block or inline tags. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes. -.br -.br -Taglets can only determine where a tag should appear and in what form. All other decisions are made by the doclet. So a taglet cannot do things such as remove a class name from the list of included classes. However, it can execute side effects, such as printing the tag's text to a file or triggering another process. -.br -.br -Use the \f2\-tagletpath\fP option to specify the path to the taglet. Here is an example that inserts the "To Do" taglet after "Parameters" and ahead of "Throws" in the generated pages: -.nf -\f3 -.fl - \-taglet com.sun.tools.doclets.ToDoTaglet -.fl - \-tagletpath /home/taglets -.fl - \-tag return -.fl - \-tag param -.fl - \-tag todo -.fl - \-tag throws -.fl - \-tag see -.fl -\fP -.fi -Alternatively, you can use the \f2\-taglet\fP option in place of its \f2\-tag\fP option, but that may be harder to read. -.TP 3 -\-tagletpath\ \ tagletpathlist -Specifies the search paths for finding taglet class files (.class). The \f2tagletpathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. -.TP 3 -\-docfilessubdirs\ -Enables deep copying of "\f2doc\-files\fP" directories. In other words, subdirectories and all contents are recursively copied to the destination. For example, the directory \f2doc\-files/example/images\fP and all its contents would now be copied. There is also an option to exclude subdirectories. -.TP 3 -\-excludedocfilessubdir\ \ name1:name2... -Excludes any "\f2doc\-files\fP" subdirectories with the given names. This prevents the copying of SCCS and other source\-code\-control subdirectories. -.TP 3 -\-noqualifier\ \ all\ | \ packagename1:packagename2:... -Omits qualifying package name from ahead of class names in output. The argument to \f2\-noqualifier\fP is either "\f2all\fP" (all package qualifiers are omitted) or a colon\-separate list of packages, with wildcards, to be removed as qualifiers. The package name is removed from places where class or interface names appear. -.br -.br -The following example omits all package qualifiers: -.nf -\f3 -.fl - \-noqualifier all -.fl -\fP -.fi -The following example omits "java.lang" and "java.io" package qualifiers: -.nf -\f3 -.fl - \-noqualifier java.lang:java.io -.fl -\fP -.fi -The following example omits package qualifiers starting with "java", and "com.sun" subpackages (but not "javax"): -.nf -\f3 -.fl - \-noqualifier java.*:com.sun.* -.fl -\fP -.fi -Where a package qualifier would appear due to the above behavior, the name can be suitably shortened \-\- see How a name is displayed. This rule is in effect whether or not \f2\-noqualifier\fP is used. -.TP 3 -\-notimestamp\ -Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page. Useful when you want to run javadoc on two source bases and diff them, as it prevents timestamps from causing a diff (which would otherwise be a diff on every page). The timestamp includes the javadoc version number, and currently looks like this: -.nf -\f3 -.fl - <!\-\- Generated by javadoc (build 1.5.0_01) on Thu Apr 02 14:04:52 IST 2009 \-\-> -.fl -\fP -.fi -.TP 3 -\-nocomment\ -Suppress the entire comment body, including the main description and all tags, generating only declarations. This option enables re\-using source files originally intended for a different purpose, to produce skeleton HTML documentation at the early stages of a new project. -.TP 3 -\-sourcetab tabLength -Specify the number of spaces each tab takes up in the source. -.RE -.SH "COMMAND LINE ARGUMENT FILES" -.LP -To shorten or simplify the javadoc command line, you can specify one or more files that themselves contain arguments to the \f2javadoc\fP command (except \f2\-J\fP options). This enables you to create javadoc commands of any length on any operating system. -.LP -An argument file can include javac options and source filenames in any combination. The arguments within a file can be space\-separated or newline\-separated. If a filename contains embedded spaces, put the whole filename in double quotes. -.LP -Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying \f2*.java\fP). Use of the '\f2@\fP' character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -When executing javadoc, pass in the path and name of each argument file with the '\f2@\fP' leading character. When javadoc encounters an argument beginning with the character `\f2@\fP', it expands the contents of that file into the argument list. -.SS -Example \- Single Arg File -.LP -You could use a single argument file named "\f2argfile\fP" to hold all Javadoc arguments: -.nf -\f3 -.fl - % \fP\f3javadoc @argfile\fP -.fl -.fi -.LP -This argument file could contain the contents of both files shown in the next example. -.SS -Example \- Two Arg Files -.LP -You can create two argument files \-\- one for the Javadoc options and the other for the package names or source filenames: (Notice the following lists have no line\-continuation characters.) -.LP -Create a file named "\f2options\fP" containing: -.nf -\f3 -.fl - \-d docs\-filelist -.fl - \-use -.fl - \-splitindex -.fl - \-windowtitle 'Java SE 7 API Specification' -.fl - \-doctitle 'Java SE 7 API Specification' -.fl - \-header '<b>Java(TM) SE 7</b>' -.fl - \-bottom 'Copyright © 1993\-2011 Oracle and/or its affiliates. All rights reserved.' -.fl - \-group "Core Packages" "java.*" -.fl - \-overview /java/pubs/ws/1.7.0/src/share/classes/overview\-core.html -.fl - \-sourcepath /java/pubs/ws/1.7.0/src/share/classes -.fl -\fP -.fi -.LP -Create a file named "\f2packages\fP" containing: -.nf -\f3 -.fl - com.mypackage1 -.fl - com.mypackage2 -.fl - com.mypackage3 -.fl -\fP -.fi -.LP -You would then run javadoc with: -.nf -\f3 -.fl - % \fP\f3javadoc @options @packages\fP -.fl -.fi -.SS -Example \- Arg Files with Paths -.LP -The argument files can have paths, but any filenames inside the files are relative to the current working directory (not \f2path1\fP or \f2path2\fP): -.nf -\f3 -.fl - % \fP\f3javadoc @path1/options @path2/packages\fP -.fl -.fi -.SS -Example \- Option Arguments -.LP -Here's an example of saving just an argument to a javadoc option in an argument file. We'll use the \f2\-bottom\fP option, since it can have a lengthy argument. You could create a file named "\f2bottom\fP" containing its text argument: -.nf -\f3 -.fl -<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font> -.fl -\fP -.fi -.LP -Then run the Javadoc tool with: -.nf -\f3 -.fl - % \fP\f3javadoc \-bottom @bottom @packages\fP -.fl -.fi -.LP -Or you could include the \f2\-bottom\fP option at the start of the argument file, and then just run it as: -.nf -\f3 -.fl - % \fP\f3javadoc @bottom @packages\fP -.fl -.fi -.SH "Name" -Running -.SH "RUNNING JAVADOC" -.LP -\f3Version Numbers\fP \- The version number of javadoc can be determined using \f3javadoc \-J\-version\fP. The version number of the standard doclet appears in its output stream. It can be turned off with \f2\-quiet\fP. -.LP -\f3Public programmatic interface\fP \- To invoke the Javadoc tool from within programs written in the Java language. This interface is in \f2com.sun.tools.javadoc.Main\fP (and javadoc is re\-entrant). For more details, see -.na -\f2Standard Doclet\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/standard\-doclet.html#runningprogrammatically. -.LP -\f3Running Doclets\fP \- The instructions given below are for invoking the standard HTML doclet. To invoke a custom doclet, use the \-doclet and \-docletpath options. For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.SH "SIMPLE EXAMPLES" -.LP -You can run javadoc on entire packages or individual source files. Each package name has a corresponding directory name. In the following examples, the source files are located at \f2/home/src/java/awt/*.java\fP. The destination directory is \f2/home/html\fP. -.SS -Documenting One or More Packages -.LP -To document a package, the source files (\f2*.java\fP) for that package must be located in a directory having the same name as the package. If a package name is made up of several identifiers (separated by dots, such as \f2java.awt.color\fP), each subsequent identifier must correspond to a deeper subdirectory (such as \f2java/awt/color\fP). You may split the source files for a single package among two such directory trees located at different places, as long as \f2\-sourcepath\fP points to them both \-\- for example \f2src1/java/awt/color\fP and \f2src2/java/awt/color\fP. -.LP -You can run javadoc either by changing directories (with \f2cd\fP) or by using \f2\-sourcepath\fP option. The examples below illustrate both alternatives. -.RS 3 -.TP 2 -o -\f3Case 1 \- Run recursively starting from one or more packages\fP \- This example uses \-sourcepath so javadoc can be run from any directory and \-subpackages (a new 1.4 option) for recursion. It traverses the subpackages of the \f2java\fP directory excluding packages rooted at \f2java.net\fP and \f2java.lang\fP. Notice this excludes \f2java.lang.ref\fP, a subpackage of \f2java.lang\fP). -.nf -\f3 -.fl - % \fP\f3javadoc \fP\f3\-d\fP\f3 /home/html \fP\f3\-sourcepath\fP\f3 /home/src \fP\f3\-subpackages\fP\f3 java \fP\f3\-exclude\fP\f3 java.net:java.lang\fP -.fl -.fi -.LP -To also traverse down other package trees, append their names to the \f2\-subpackages\fP argument, such as \f2java:javax:org.xml.sax\fP. -.TP 2 -o -\f3Case 2 \- Run on explicit packages after changing to the "root" source directory\fP \- Change to the parent directory of the fully\-qualified package. Then run javadoc, supplying names of one or more packages you want to document: -.nf -\f3 -.fl - % \fP\f3cd /home/src/\fP -.fl - % \f3javadoc \-d /home/html java.awt java.awt.event\fP -.fl -.fi -.TP 2 -o -\f3Case 3 \- Run from any directory on explicit packages in a single directory tree\fP \- In this case, it doesn't matter what the current directory is. Run javadoc supplying \f2\-sourcepath\fP with the parent directory of the top\-level package, and supplying names of one or more packages you want to document: -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt java.awt.event\fP -.fl -.fi -.TP 2 -o -\f3Case 4 \- Run from any directory on explicit packages in multiple directory trees\fP \- This is the same as case 3, but for packages in separate directory trees. Run javadoc supplying \f2\-sourcepath\fP with the path to each tree's root (colon\-separated) and supply names of one or more packages you want to document. All source files for a given package do not need to be located under a single root directory \-\- they just need to be found somewhere along the sourcepath. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event\fP -.fl -.fi -.RE -.LP -Result: All cases generate HTML\-formatted documentation for the public and protected classes and interfaces in packages \f2java.awt\fP and \f2java.awt.event\fP and save the HTML files in the specified destination directory (\f2/home/html\fP). Because two or more packages are being generated, the document has three HTML frames \-\- for the list of packages, the list of classes, and the main class pages. -.SS -Documenting One or More Classes -.LP -The second way to run the Javadoc tool is by passing in one or more source files (\f2.java\fP). You can run javadoc either of the following two ways \-\- by changing directories (with \f2cd\fP) or by fully\-specifying the path to the \f2.java\fP files. Relative paths are relative to the current directory. The \f2\-sourcepath\fP option is ignored when passing in source files. You can use command line wildcards, such as asterisk (*), to specify groups of classes. -.RS 3 -.TP 2 -o -\f3Case 1 \- Changing to the source directory\fP \- Change to the directory holding the \f2.java\fP files. Then run javadoc, supplying names of one or more source files you want to document. -.nf -\f3 -.fl - % \fP\f3cd /home/src/java/awt\fP -.fl - % \f3javadoc \-d /home/html Button.java Canvas.java Graphics*.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the classes \f2Button\fP, \f2Canvas\fP and classes beginning with \f2Graphics\fP. Because source files rather than package names were passed in as arguments to javadoc, the document has two frames \-\- for the list of classes and the main page. -.TP 2 -o -\f3Case 2 \- Changing to the package root directory\fP \- This is useful for documenting individual source files from different subpackages off the same root. Change to the package root directory, and supply the source files with paths from the root. -.nf -\f3 -.fl - % \fP\f3cd /home/src/\fP -.fl - % \f3javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the classes \f2Button\fP and \f2Applet\fP. -.TP 2 -o -\f3Case 3 \- From any directory\fP \- In this case, it doesn't matter what the current directory is. Run javadoc supplying the absolute path (or path relative to the current directory) to the \f2.java\fP files you want to document. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the class \f2Button\fP and classes beginning with \f2Graphics\fP. -.RE -.SS -Documenting Both Packages and Classes -.LP -You can document entire packages and individual classes at the same time. Here's an example that mixes two of the previous examples. You can use \f2\-sourcepath\fP for the path to the packages but not for the path to the individual classes. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java\fP -.fl -.fi -.LP -This example generates HTML\-formatted documentation for the package \f2java.awt\fP and class \f2Applet\fP. (The Javadoc tool determines the package name for \f2Applet\fP from the package declaration, if any, in the \f2Applet.java\fP source file.) -.SH "REAL WORLD EXAMPLE" -.LP -The Javadoc tool has many useful options, some of which are more commonly used than others. Here is effectively the command we use to run the Javadoc tool on the Java platform API. We use 180MB of memory to generate the documentation for the 1500 (approx.) public and protected classes in the Java SE Platform, Standard Edition, v1.2. -.LP -The same example is shown twice \-\- first as executed on the command line, then as executed from a makefile. It uses absolute paths in the option arguments, which enables the same \f2javadoc\fP command to be run from any directory. -.SS -Command Line Example -.LP -The following example may be too long for some shells such as DOS. You can use a command line argument file (or write a shell script) to workaround this limitation. -.nf -\f3 -.fl -% javadoc \-sourcepath /java/jdk/src/share/classes \\ -.fl - \-overview /java/jdk/src/share/classes/overview.html \\ -.fl - \-d /java/jdk/build/api \\ -.fl - \-use \\ -.fl - \-splitIndex \\ -.fl - \-windowtitle 'Java Platform, Standard Edition 7 API Specification' \\ -.fl - \-doctitle 'Java Platform, Standard Edition 7 API Specification' \\ -.fl - \-header '<b>Java(TM) SE 7</b>' \\ -.fl - \-bottom '<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font>' \\ -.fl - \-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \\ -.fl - \-group "Extension Packages" "javax.*" \\ -.fl - \-J\-Xmx180m \\ -.fl - @packages -.fl -\fP -.fi -.LP -where \f2packages\fP is the name of a file containing the packages to process, such as \f2java.applet java.lang\fP. None of the options should contain any newline characters between the single quotes. (For example, if you copy and paste this example, delete the newline characters from the \f2\-bottom\fP option.) See the other notes listed below. -.SS -Makefile Example -.LP -This is an example of a GNU makefile. For an example of a Windows makefile, see -.na -\f2creating a makefile for Windows\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html#makefiles. -.nf -\f3 -.fl -javadoc \-\fP\f3sourcepath\fP\f3 $(SRCDIR) \\ /* Sets path for source files */ -.fl - \-\fP\f3overview\fP\f3 $(SRCDIR)/overview.html \\ /* Sets file for overview text */ -.fl - \-\fP\f3d\fP\f3 /java/jdk/build/api \\ /* Sets destination directory */ -.fl - \-\fP\f3use\fP\f3 \\ /* Adds "Use" files */ -.fl - \-\fP\f3splitIndex\fP\f3 \\ /* Splits index A\-Z */ -.fl - \-\fP\f3windowtitle\fP\f3 $(WINDOWTITLE) \\ /* Adds a window title */ -.fl - \-\fP\f3doctitle\fP\f3 $(DOCTITLE) \\ /* Adds a doc title */ -.fl - \-\fP\f3header\fP\f3 $(HEADER) \\ /* Adds running header text */ -.fl - \-\fP\f3bottom\fP\f3 $(BOTTOM) \\ /* Adds text at bottom */ -.fl - \-\fP\f3group\fP\f3 $(GROUPCORE) \\ /* 1st subhead on overview page */ -.fl - \-\fP\f3group\fP\f3 $(GROUPEXT) \\ /* 2nd subhead on overview page */ -.fl - \-\fP\f3J\fP\f3\-Xmx180m \\ /* Sets memory to 180MB */ -.fl - java.lang java.lang.reflect \\ /* Sets packages to document */ -.fl - java.util java.io java.net \\ -.fl - java.applet -.fl - -.fl -WINDOWTITLE = 'Java(TM) SE 7 API Specification' -.fl -DOCTITLE = 'Java(TM) Platform Standard Edition 7 API Specification' -.fl -HEADER = '<b>Java(TM) SE 7</font>' -.fl -BOTTOM = '<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font>' -.fl -GROUPCORE = '"Core Packages" "java.*:com.sun.java.*:org.omg.*"' -.fl -GROUPEXT = '"Extension Packages" "javax.*"' -.fl -SRCDIR = '/java/jdk/1.7.0/src/share/classes' -.fl -\fP -.fi -.LP -Single quotes are used to surround makefile arguments. -.LP -\f3NOTES\fP -.RS 3 -.TP 2 -o -If you omit the \f2\-windowtitle\fP option, the Javadoc tool copies the doc title to the window title. The \f2\-windowtitle\fP text is basically the same as the \f2\-doctitle\fP but without HTML tags, to prevent those tags from appearing as raw text in the window title. -.TP 2 -o -If you omit the \f2\-footer\fP option, as done here, the Javadoc tool copies the header text to the footer. -.TP 2 -o -Other important options you might want to use but not needed in this example are \-\f2classpath\fP and \-\f2link\fP. -.RE -.SH "TROUBLESHOOTING" -.SS -General Troubleshooting -.RS 3 -.TP 2 -o -\f3Javadoc FAQ\fP \- Commonly\-encountered bugs and troubleshooting tips can be found on the -.na -\f2Javadoc FAQ\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html#B -.TP 2 -o -\f3Bugs and Limitations\fP \- You can also see some bugs listed at Important Bug Fixes and Changes. -.TP 2 -o -\f3Version number\fP \- See version numbers. -.TP 2 -o -\f3Documents only legal classes\fP \- When documenting a package, javadoc only reads files whose names are composed of legal class names. You can prevent javadoc from parsing a file by including, for example, a hyphen "\-" in its filename. -.RE -.SS -Errors and Warnings -.LP -Error and warning messages contain the filename and line number to the declaration line rather than to the particular line in the doc comment. -.RS 3 -.TP 2 -o -\f2"error: cannot read: Class1.java"\fP the Javadoc tool is trying to load the class Class1.java in the current directory. The class name is shown with its path (absolute or relative), which in this case is the same as \f2./Class1.java\fP. -.RE -.SH "ENVIRONMENT" -.RS 3 -.TP 3 -CLASSPATH -Environment variable that provides the path which javadoc uses to find user class files. This environment variable is overridden by the \f2\-classpath\fP option. Separate directories with a colon, for example: -.:/home/classes:/usr/local/java/classes -.RE -.SH "SEE ALSO" -.RS 3 -.TP 2 -o -javac(1) -.TP 2 -o -java(1) -.TP 2 -o -jdb(1) -.TP 2 -o -javah(1) -.TP 2 -o -javap(1) -.TP 2 -o -.na -\f2Javadoc Home Page\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-jsp\-135444.html -.TP 2 -o -.na -\f2How to Write Doc Comments for Javadoc\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html -.TP 2 -o -.na -\f2Setting the Class Path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general -.TP 2 -o -.na -\f2How Javac and Javadoc Find Classes\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfiles (tools.jar) -.RE - +.TP +-nodeprecated +.br +Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. +.TP +-nodeprecatedlist +.br +Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. +.TP +-nosince +.br +Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. +.TP +-notree +.br +Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. +.TP +-noindex +.br +Omits the index from the generated documents\&. The index is produced by default\&. +.TP +-nohelp +.br +Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. +.TP +-nonavbar +.br +Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. +.TP +-helpfile \fIpath\efilename\fR +.br +Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: +.sp +.nf +\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-stylesheet \fIpath/filename\fR +.br +Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: +.sp +.nf +\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-serialwarn +.br +Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. +.TP +-charset \fIname\fR +.br +Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: +.sp +.nf +\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 + +See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-docencoding \fIname\fR +.br +Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding"iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-keywords +.br +Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: +.sp +.nf +\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="length()">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="charAt()">\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" +.br +Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. + +\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: + +\f3X\fR (disable tag) + +\f3a\fR (all) + +\f3o\fR (overview) + +\f3p\fR (packages) + +\f3t\fR (types, that is classes and interfaces) + +\f3c\fR (constructors) + +\f3m\fR (methods) + +\f3f\fR (fields) + +\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. + +If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. + +Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. + +\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @ejb:bean\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. + +\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. + +\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): +.sp +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag todo:a:"To Do:"\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\-tag example:X\fP +.fi +.nf +\f3\fR +.fi +.sp + + +When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. + +The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. + +\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. + +\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations + +You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. +.TP +-taglet \fIclass\fR +.br +Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html + +Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. +.sp +.nf +\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP +.fi +.nf +\f3\-tagletpath /home/taglets \fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag todo\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-tagletpath \fItagletpathlist\fR +.br +Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. +.TP +-docfilesubdirs +.br +Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. +.TP +-excludedocfilessubdir \fIname1:name2\fR +.br +Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. +.TP +-noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR +.br +Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. + +The following example omits all package qualifiers: \f3-noqualifier all\fR\&. + +The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. + +The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. + +Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. +.TP +-notimestamp +.br +Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. +.TP +-nocomment +.br +Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. +.TP +-sourcetab \fItablength\fR +.br +Specifies the number of spaces each tab uses in the source\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains: +.sp +.nf +\f3\-d docs\-filelist \fP +.fi +.nf +\f3\-use \fP +.fi +.nf +\f3\-splitindex\fP +.fi +.nf +\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-doctitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP +.fi +.nf +\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*"\fP +.fi +.nf +\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP +.fi +.nf +\f3\fR +.fi +.sp +Create a file named packages that contains: +.sp +.nf +\f3com\&.mypackage1\fP +.fi +.nf +\f3com\&.mypackage2\fP +.fi +.nf +\f3com\&.mypackage3\fP +.fi +.nf +\f3\fR +.fi +.sp +Run the \f3javadoc\fR command as follows: +.sp +.nf +\f3javadoc @options @packages\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javadoc @path1/options @path2/packages\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 4 Option Arguments\fR +.PP +The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: +.sp +.nf +\f3<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\fP +.fi +.nf +\f3\fR +.fi +.sp +Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. +.PP +You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. +.SH RUNNING\ THE\ JAVADOC\ COMMAND +The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. +.PP +Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically +.PP +The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.SS SIMPLE\ EXAMPLES +You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. +.PP +In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. +.PP +Document One or More Packages + +To document a package, the source files for that package must be located in a directory that has the same name as the package\&. +.PP +If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. +.PP +You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. +.PP +You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. +.PP +\f3Example 1 Recursive Run from One or More Packages\fR +.PP +This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Change to Root and Run Explicit Packages\fR +.PP +Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. +.PP +\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR +.PP +Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. +.PP +Document One or More Classes + +The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. +.PP +\f3Example 1 Change to the Source Directory\fR +.PP +Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. +.PP +This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. +.sp +.nf +\f3cd /home/src/java/awt\fP +.fi +.nf +\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Change to the Root Directory of the Package\fR +.PP +This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Document Files from Any Directory\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. +.sp +.nf +\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP +.fi +.nf +\f3/home/src/java/awt/Graphics*\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Document Packages and Classes + +You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP +.fi +.nf +\f3/home/src/java/applet/Applet\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS REAL-WORLD\ EXAMPLES +The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. +.PP +Command-Line Example + +The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. +.PP +In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. +.sp +.nf +\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP +.fi +.nf +\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP +.fi +.nf +\f3\-d /java/jdk/build/api \e\fP +.fi +.nf +\f3\-use \e\fP +.fi +.nf +\f3\-splitIndex \e\fP +.fi +.nf +\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP +.fi +.nf +\f3\-bottom \&'<font size="\-1">\fP +.fi +.nf +\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP +.fi +.nf +\f3\-group "Extension Packages" "javax\&.*" \e\fP +.fi +.nf +\f3\-J\-Xmx180m \e \fP +.fi +.nf +\f3@packages\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Programmatic Interface + +The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. +.PP +For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: +.sp +.nf +\f3import javax\&.tools\&.DocumentationTool;\fP +.fi +.nf +\f3import javax\&.tools\&.ToolProvider;\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3public class JavaAccessSample{\fP +.fi +.nf +\f3 public static void main(String[] args){\fP +.fi +.nf +\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP +.fi +.nf +\f3 int rc = javadoc\&.run( null, null, null,\fP +.fi +.nf +\f3 "\-d", "/home/html",\fP +.fi +.nf +\f3 "\-sourcepath", "home/src",\fP +.fi +.nf +\f3 "\-subpackages", "java",\fP +.fi +.nf +\f3 "\-exclude", "java\&.net:java\&.lang",\fP +.fi +.nf +\f3 "com\&.example");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fR +.fi +.sp +The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. +.SS THE\ MAKEFILE\ EXAMPLE +This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles +.sp +.nf +\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP +.fi +.nf +\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP +.fi +.nf +\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP +.fi +.nf +\f3 \-use \e /* Adds "Use" files */\fP +.fi +.nf +\f3 \-splitIndex \e /* Splits index A\-Z */\fP +.fi +.nf +\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP +.fi +.nf +\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP +.fi +.nf +\f3 \-header $(HEADER) \e /* Adds running header text */\fP +.fi +.nf +\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP +.fi +.nf +\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP +.fi +.nf +\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP +.fi +.nf +\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP +.fi +.nf +\f3 java\&.util java\&.io java\&.net \e\fP +.fi +.nf +\f3 java\&.applet\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP +.fi +.nf +\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP +.fi +.nf +\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP +.fi +.nf +\f3BOTTOM = \&'<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP +.fi +.nf +\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP +.fi +.nf +\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP +.fi +.nf +\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS NOTES +.TP 0.2i +\(bu +If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. +.TP 0.2i +\(bu +If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. +.TP 0.2i +\(bu +Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. +.SH GENERAL\ TROUBLESHOOTING +.TP 0.2i +\(bu +The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. +.TP 0.2i +\(bu +See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html +.SH ERRORS\ AND\ WARNINGS +Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. +.PP +For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. +.SH ENVIRONMENT +.TP +CLASSPATH +\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. + +\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR + +\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.SH RELATED\ DOCUMENTS +.TP 0.2i +\(bu +Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html +.TP 0.2i +\(bu +How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.TP 0.2i +\(bu +How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html +.TP 0.2i +\(bu +URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.TP 0.2i +\(bu +HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/javah.1 b/jdk/src/linux/doc/man/javah.1 index 16dfa9bcc93..5b8979e55c3 100644 --- a/jdk/src/linux/doc/man/javah.1 +++ b/jdk/src/linux/doc/man/javah.1 @@ -1,138 +1,159 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javah 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javah.1 +.\" +.if n .pl 99999 +.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javah \- C Header and Stub File Generator -.LP -.LP -\f3javah\fP produces C header files and C source files from a Java class. These files provide the connective glue that allow your Java and C code to interact. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -javah [ \fP\f3options\fP\f3 ] fully\-qualified\-classname. . . -.fl -\fP -.fi +.SH NAME +javah \- Generates C header and source files from a Java class\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3javah\fP generates C header and source files that are needed to implement native methods. The generated header and source files are used by C programs to reference an object's instance variables from native source code. The .h file contains a struct definition whose layout parallels the layout of the corresponding class. The fields in the struct correspond to instance variables in the class. -.LP -.LP -The name of the header file and the structure declared within it are derived from the name of the class. If the class passed to \f3javah\fP is inside a package, the package name is prepended to both the header file name and the structure name. Underscores (_) are used as name delimiters. -.LP -.LP -By default \f3javah\fP creates a header file for each class listed on the command line and puts the files in the current directory. Use the \f2\-stubs\fP option to create source files. Use the \f2\-o\fP option to concatenate the results for all listed classes into a single file. -.LP -.LP -The new native method interface, Java Native Interface (JNI), does not require header information or stub files. \f3javah\fP can still be used to generate native method function proptotypes needed for JNI\-style native methods. \f3javah\fP produces JNI\-style output by default, and places the result in the .h file. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-o outputfile -Concatenates the resulting header or source files for all the classes listed on the command line into \f2outputfile\fP. Only one of \f3\-o\fP or \f3\-d\fP may be used. -.TP 3 -\-d directory -Sets the directory where \f3javah\fP saves the header files or the stub files. Only one of \f3\-d\fP or \f3\-o\fP may be used. -.TP 3 -\-stubs -Causes \f3javah\fP to generate C declarations from the Java object file. -.TP 3 -\-verbose -Indicates verbose output and causes \f3javah\fP to print a message to stdout concerning the status of the generated files. -.TP 3 -\-help -Print help message for \f3javah\fP usage. -.TP 3 -\-version -Print out \f3javah\fP version information. -.TP 3 -\-jni -Causes \f3javah\fP to create an output file containing JNI\-style native method function prototypes. This is the default output, so use of \f3\-jni\fP is optional. -.TP 3 -\-classpath path -Specifies the path \f3javah\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is: -.nf -\f3 -.fl - .:<your_path> -.fl -\fP -.fi -For example: -.nf -\f3 -.fl - .:/home/avh/classes:/usr/local/java/classes -.fl -\fP -.fi -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations). +\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIfully-qualified-class-name\fR +The fully qualified location of the classes to be converted to C header and source files\&. +.SH DESCRIPTION +The \f3javah\fR command generates C header and source files that are needed to implement native methods\&. The generated header and source files are used by C programs to reference an object\&'s instance variables from native source code\&. The \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. +.PP +The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. +.PP +By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. +.PP +The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. +.SH OPTIONS +.TP +-o \fIoutputfile\fR .br +Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. +.TP +-d \fIdirectory\fR .br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.TP 3 -\-bootclasspath path -Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java 2 platform located in \f2jre/lib/rt.jar\fP and several other jar files. -.TP 3 -\-old -Specifies that old JDK1.0\-style header files should be generated. -.TP 3 -\-force -Specifies that output files should always be written. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE +Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. +.TP +-stubs +.br +Causes the \f3javah\fR command to generate C declarations from the Java object file\&. +.TP +-verbose +.br +Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. +.TP +-help +.br +Prints a help message for \f3javah\fR usage\&. +.TP +-version +.br +Prints \f3javah\fR command release information\&. +.TP +-jni +.br +Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 -CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons, for example, -.nf -\f3 -.fl -.:/home/avh/classes:/usr/local/java/classes -.fl -\fP -.fi -.RE +\fIOracle Solaris\fR: -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), jdb(1), javap(1), javadoc(1) -.LP - +\&.:\fIyour-path\fR + +Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR + +\fIWindows\fR: + +\&.;\fIyour-path\fR + +Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR + +As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. +.TP +-old +.br +Specifies that old JDK 1\&.0-style header files should be generated\&. +.TP +-force +.br +Specifies that output files should always be written\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javap(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/javap.1 b/jdk/src/linux/doc/man/javap.1 index aa6e8d0114c..353a13fb0fd 100644 --- a/jdk/src/linux/doc/man/javap.1 +++ b/jdk/src/linux/doc/man/javap.1 @@ -1,317 +1,443 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javap 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javap.1 +.\" +.if n .pl 99999 +.TH javap 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javap \- The Java Class File Disassembler -.LP -.LP -Disassembles class files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -javap [ \fP\f3options\fP\f3 ] classes -.fl -\fP -.fi +.SH NAME +javap \- Disassembles one or more class files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3javap\fP command disassembles one or more class files. Its output depends on the options used. If no options are used, \f3javap\fP prints out the package, protected, and public fields and methods of the classes passed to it. \f3javap\fP prints its output to stdout. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -classes -List of one or more classes (separated by spaces) to be processed for annotations (such as \f2DocFooter.class\fP). You may specify a class that can be found in the class path, by its file name (for example, \f2/home/user/myproject/src/DocFooter.class\fP), or with a URL (for example, \f2file:///home/user/myproject/src/DocFooter.class\fP). -.RE +\fBjavap\fR [\fIoptions\fR] \fIclassfile\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassfile\fR +One or more classes separated by spaces to be processed for annotations such as DocFooter\&.class\&. You can specify a class that can be found in the class path, by its file name or with a URL such as \f3file:///home/user/myproject/src/DocFooter\&.class\fR\&. +.SH DESCRIPTION +The \f3javap\fR command disassembles one or more class files\&. The output depends on the options used\&. When no options are used, then the \f3javap\fR command prints the package, protected and public fields, and methods of the classes passed to it\&. The \f3javap\fR command prints its output to \f3stdout\fR\&. +.SH OPTIONS +.TP +-help, --help, -? +.br +Prints a help message for the \f3javap\fR command\&. +.TP +-version +.br +Prints release information\&. +.TP +-l +.br +Prints line and local variable tables\&. +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. +.TP +-private, -p +.br +Shows all classes and members\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the JVM\&. For example: +.sp +.nf +\f3javap \-J\-version\fP +.fi +.nf +\f3javap \-J\-Djava\&.security\&.manager \-J\-Djava\&.security\&.policy=MyPolicy MyClassName\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -For example, compile the following class declaration: -.LP -.nf -\f3 -.fl -import java.awt.*; -.fl -import java.applet.*; -.fl -.fl -public class DocFooter extends Applet { -.fl - String date; -.fl - String email; -.fl - -.fl - public void init() { -.fl - resize(500,100); -.fl - date = getParameter("LAST_UPDATED"); -.fl - email = getParameter("EMAIL"); -.fl - } -.fl - -.fl - public void paint(Graphics g) { -.fl - g.drawString(date + " by ",100, 15); -.fl - g.drawString(email,290,15); -.fl - } -.fl -} -.fl -\fP -.fi - -.LP -.LP -The output from \f3javap DocFooter.class\fP yields: -.LP -.nf -\f3 -.fl -Compiled from "DocFooter.java" -.fl -public class DocFooter extends java.applet.Applet { -.fl - java.lang.String date; -.fl - java.lang.String email; -.fl - public DocFooter(); -.fl - public void init(); -.fl - public void paint(java.awt.Graphics); -.fl -} -.fl -\fP -.fi - -.LP -.LP -The output from \f3javap \-c DocFooter.class\fP yields: -.LP -.nf -\f3 -.fl -Compiled from "DocFooter.java" -.fl -public class DocFooter extends java.applet.Applet { -.fl - java.lang.String date; -.fl - -.fl - java.lang.String email; -.fl - -.fl - public DocFooter(); -.fl - Code: -.fl - 0: aload_0 -.fl - 1: invokespecial #1 // Method java/applet/Applet."<init>":()V -.fl - 4: return -.fl - -.fl - public void init(); -.fl - Code: -.fl - 0: aload_0 -.fl - 1: sipush 500 -.fl - 4: bipush 100 -.fl - 6: invokevirtual #2 // Method resize:(II)V -.fl - 9: aload_0 -.fl - 10: aload_0 -.fl - 11: ldc #3 // String LAST_UPDATED -.fl - 13: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String; -.fl - 16: putfield #5 // Field date:Ljava/lang/String; -.fl - 19: aload_0 -.fl - 20: aload_0 -.fl - 21: ldc #6 // String EMAIL -.fl - 23: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String; -.fl - 26: putfield #7 // Field email:Ljava/lang/String; -.fl - 29: return -.fl - -.fl - public void paint(java.awt.Graphics); -.fl - Code: -.fl - 0: aload_1 -.fl - 1: new #8 // class java/lang/StringBuilder -.fl - 4: dup -.fl - 5: invokespecial #9 // Method java/lang/StringBuilder."<init>":()V -.fl - 8: aload_0 -.fl - 9: getfield #5 // Field date:Ljava/lang/String; -.fl - 12: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder; -.fl - 15: ldc #11 // String by -.fl - 17: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder; -.fl - 20: invokevirtual #12 // Method java/lang/StringBuilder.toString:()Ljava/lang/String; -.fl - 23: bipush 100 -.fl - 25: bipush 15 -.fl - 27: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V -.fl - 30: aload_1 -.fl - 31: aload_0 -.fl - 32: getfield #7 // Field email:Ljava/lang/String; -.fl - 35: sipush 290 -.fl - 38: bipush 15 -.fl - 40: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V -.fl - 43: return -.fl -} -.fl -\fP -.fi - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-help \-\-help \-? -Prints out help message for \f3javap\fP. -.TP 3 -\-version -Prints out version information. -.TP 3 -\-l -Prints out line and local variable tables. -.TP 3 -\-public -Shows only public classes and members. -.TP 3 -\-protected -Shows only protected and public classes and members. -.TP 3 -\-package -Shows only package, protected, and public classes and members. This is the default. -.TP 3 -\-private \-p -Shows all classes and members. -.TP 3 -\-Jflag -Pass \f2flag\fP directly to the runtime system. Some examples: -.nf -\f3 -.fl -javap \-J\-version -.fl -javap \-J\-Djava.security.manager \-J\-Djava.security.policy=MyPolicy MyClassName -.fl -\fP -.fi -.TP 3 -\-s -Prints internal type signatures. -.TP 3 -\-sysinfo -Shows system information (path, size, date, MD5 hash) of the class being processed. -.TP 3 -\-constants -Shows static final constants. -.TP 3 -\-c -Prints out disassembled code, i.e., the instructions that comprise the Java bytecodes, for each of the methods in the class. These are documented in the -.na -\f2Java Virtual Machine Specification\fP @ -.fi -http://java.sun.com/docs/books/vmspec/. -.TP 3 -\-verbose -Prints stack size, number of \f2locals\fP and \f2args\fP for methods. -.TP 3 -\-classpath path -Specifies the path \f3javap\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. -.TP 3 -\-bootclasspath path -Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java platform located in \f2jre/lib/rt.jar\fP and several other jar files. -.TP 3 -\-extdirs dirs -Overrides location at which installed extensions are searched for. The default location for extensions is the value of \f2java.ext.dirs\fP. -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), jdb(1), javah(1), javadoc(1) -.LP - +For more information about JVM options, see the \f3java(1)\fR command documentation\&. +.TP +-s +.br +Prints internal type signatures\&. +.TP +-sysinfo +.br +Shows system information (path, size, date, MD5 hash) of the class being processed\&. +.TP +-constants +.br +Shows \f3static final\fR constants\&. +.TP +-c +.br +Prints disassembled code, for example, the instructions that comprise the Java bytecodes, for each of the methods in the class\&. +.TP +-verbose +.br +Prints stack size, number of locals and arguments for methods\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javap\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre/lib/rt\&.jar\fR and several other JAR files\&. +.TP +-extdir \fIdirs\fR +.br +Overrides the location at which installed extensions are searched for\&. The default location for extensions is the value of \f3java\&.ext\&.dirs\fR\&. +.SH EXAMPLE +Compile the following \f3DocFooter\fR class: +.sp +.nf +\f3import java\&.awt\&.*;\fP +.fi +.nf +\f3import java\&.applet\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class DocFooter extends Applet {\fP +.fi +.nf +\f3 String date;\fP +.fi +.nf +\f3 String email;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void init() {\fP +.fi +.nf +\f3 resize(500,100);\fP +.fi +.nf +\f3 date = getParameter("LAST_UPDATED");\fP +.fi +.nf +\f3 email = getParameter("EMAIL");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void paint(Graphics g) {\fP +.fi +.nf +\f3 g\&.drawString(date + " by ",100, 15);\fP +.fi +.nf +\f3 g\&.drawString(email,290,15);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +The output from the \f3javap DocFooter\&.class\fR command yields the following: +.sp +.nf +\f3Compiled from "DocFooter\&.java"\fP +.fi +.nf +\f3public class DocFooter extends java\&.applet\&.Applet {\fP +.fi +.nf +\f3 java\&.lang\&.String date;\fP +.fi +.nf +\f3 java\&.lang\&.String email;\fP +.fi +.nf +\f3 public DocFooter();\fP +.fi +.nf +\f3 public void init();\fP +.fi +.nf +\f3 public void paint(java\&.awt\&.Graphics);\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +The output from \f3javap -c DocFooter\&.class\fR command yields the following: +.sp +.nf +\f3Compiled from "DocFooter\&.java"\fP +.fi +.nf +\f3public class DocFooter extends java\&.applet\&.Applet {\fP +.fi +.nf +\f3 java\&.lang\&.String date;\fP +.fi +.nf +\f3 java\&.lang\&.String email;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public DocFooter();\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_0 \fP +.fi +.nf +\f3 1: invokespecial #1 // Method\fP +.fi +.nf +\f3java/applet/Applet\&."<init>":()V\fP +.fi +.nf +\f3 4: return \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void init();\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_0 \fP +.fi +.nf +\f3 1: sipush 500\fP +.fi +.nf +\f3 4: bipush 100\fP +.fi +.nf +\f3 6: invokevirtual #2 // Method resize:(II)V\fP +.fi +.nf +\f3 9: aload_0 \fP +.fi +.nf +\f3 10: aload_0 \fP +.fi +.nf +\f3 11: ldc #3 // String LAST_UPDATED\fP +.fi +.nf +\f3 13: invokevirtual #4 // Method\fP +.fi +.nf +\f3 getParameter:(Ljava/lang/String;)Ljava/lang/String;\fP +.fi +.nf +\f3 16: putfield #5 // Field date:Ljava/lang/String;\fP +.fi +.nf +\f3 19: aload_0 \fP +.fi +.nf +\f3 20: aload_0 \fP +.fi +.nf +\f3 21: ldc #6 // String EMAIL\fP +.fi +.nf +\f3 23: invokevirtual #4 // Method\fP +.fi +.nf +\f3 getParameter:(Ljava/lang/String;)Ljava/lang/String;\fP +.fi +.nf +\f3 26: putfield #7 // Field email:Ljava/lang/String;\fP +.fi +.nf +\f3 29: return \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void paint(java\&.awt\&.Graphics);\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_1 \fP +.fi +.nf +\f3 1: new #8 // class java/lang/StringBuilder\fP +.fi +.nf +\f3 4: dup \fP +.fi +.nf +\f3 5: invokespecial #9 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&."<init>":()V\fP +.fi +.nf +\f3 8: aload_0 \fP +.fi +.nf +\f3 9: getfield #5 // Field date:Ljava/lang/String;\fP +.fi +.nf +\f3 12: invokevirtual #10 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;\fP +.fi +.nf +\f3 15: ldc #11 // String by \fP +.fi +.nf +\f3 17: invokevirtual #10 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;\fP +.fi +.nf +\f3 20: invokevirtual #12 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.toString:()Ljava/lang/String;\fP +.fi +.nf +\f3 23: bipush 100\fP +.fi +.nf +\f3 25: bipush 15\fP +.fi +.nf +\f3 27: invokevirtual #13 // Method\fP +.fi +.nf +\f3 java/awt/Graphics\&.drawString:(Ljava/lang/String;II)V\fP +.fi +.nf +\f3 30: aload_1 \fP +.fi +.nf +\f3 31: aload_0 \fP +.fi +.nf +\f3 32: getfield #7 // Field email:Ljava/lang/String;\fP +.fi +.nf +\f3 35: sipush 290\fP +.fi +.nf +\f3 38: bipush 15\fP +.fi +.nf +\f3 40: invokevirtual #13 // Method\fP +.fi +.nf +\f3java/awt/Graphics\&.drawString:(Ljava/lang/String;II)V\fP +.fi +.nf +\f3 43: return \fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jcmd.1 b/jdk/src/linux/doc/man/jcmd.1 index 3e0cd2a19fa..f789bdc5286 100644 --- a/jdk/src/linux/doc/man/jcmd.1 +++ b/jdk/src/linux/doc/man/jcmd.1 @@ -1,124 +1,114 @@ -." Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jcmd 1 "22 Novembre 2011" +'\" t +.\" Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jcmd.1 +.\" +.if n .pl 99999 +.TH jcmd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jcmd \- Diagnostic Command +.SH NAME +jcmd \- Sends diagnostic command requests to a running Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf + +\fBjcmd\fR [\fB\-l\fR|\fB\-h\fR|\fB\-help\fR] +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fBPerfCounter\&.print\fR +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fB\-f\fR \fIfilename\fR +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fIcommand\fR[ \fIarguments\fR] +.fi +.sp +.SH DESCRIPTION +The \f3jcmd\fR utility is used to send diagnostic command requests to the JVM\&. It must be used on the same machine on which the JVM is running, and have the same effective user and group identifiers that were used to launch the JVM\&. +.PP +\fINote:\fR To invoke diagnostic commands from a remote machine or with different identiers, you can use the \f3com\&.sun\&.management\&.DiagnosticCommandMBean\fR interface\&. For more information about the \f3DiagnosticCommandMBean\fR interface, see the API documentation at http://download\&.java\&.net/jdk8/docs/jre/api/management/extension/com/sun/management/DiagnosticCommandMBean\&.html +.PP +If you run \f3jcmd\fR without arguments or with the \f3-l\fR option, it prints the list of running Java process identifiers with the main class and command-line arguments that were used to launch the process\&. Running \f3jcmd\fR with the \f3-h\fR or \f3-help\fR option prints the tool\(cqs help message\&. +.PP +If you specify the processes identifier (\fIpid\fR) or the main class (\fImain-class\fR) as the first argument, \f3jcmd\fR sends the diagnostic command request to the Java process with the specified identifier or to all Java processes with the specified name of the main class\&. You can also send the diagnostic command request to all available Java processes by specifying \f30\fR as the process identifier\&. Use one of the following as the diagnostic command request: +.TP +Perfcounter\&.print +Prints the performance counters available for the specified Java process\&. The list of performance counters might vary with the Java process\&. +.TP +-f \fIfilename\fR .br - -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jcmd\fP [ option ] -.fl -\f3jcmd\fP <\fIpid\fR | \fImain class\fR> PerfCounter.print -.fl -\f3jcmd\fP <\fIpid\fR | \fImain class\fR> \fIcommand\fR [\fIarguments\fR] -.fl -\f3jcmd\fP <\fIpid\fR | \fImain class\fR> -f \fIfile\fR -.fl -.fl -.fi - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jcmd\fP is a utility to send diagnostic command requests to a Java -Virtual Machine supporting this feature. Used without arguments or with the \-l option, jcmd prints the list of running Java processes with their process id, their main class and their command line arguments. When a process id is specified on the command line, jcmd sends the diagnostic command request to the process with this id. When a main class is specified on the command line, jcmd sends the diagnostic command request to all Java processes with this main class. With the PerfCounter.print argument, jcmd prints the performance counters available on the targeted Java process(es). With the \-f option, jcmd sends to the targeted Java process(es) the diagnostic commands stored in the file \fIfile\fR. -.LP -\fP -.fi - -.SH "OPTIONS" -.LP -.LP -Options are mutually exclusive. Options, if used, should follow immediately after the command name. -.LP -.RS 3 -.TP 3 -\-l -prints the list of running Java processes with their process id, their -main class and their command line arguments. -.TP 3 -\-h -prints a help message. -.br -.br -.TP 3 -\-help -prints a help message -.br -.RE - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -\fIpid\fR -Identifies the process which will receive the diagnostic command requests. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) or jcmd(1) may be used. -.RE -.LP -.RS 3 -.TP 3 -\fImain class\fR -Main class of the process which will receive the diagnostic command requests. If several running Java processes share this main class, the diagnostic command request will be sent to all these processes. To get a list of Java processes running on a machine, jps(1) or jcmd(1) may be used. -.RE -.RS 3 -.TP 3 +The name of the file from which to read diagnostic commands and send them to the specified Java process\&. Used only with the \f3-f\fR option\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. +.TP \fIcommand\fR [\fIarguments\fR] -Invoke the diagnostic command called \fIcommand\fR on the targeted Java -process(es). The list of available diagnostic commands for a given -process can be obtained by invoking the 'help' command on this process. -Each diagnostic command has its own set of \fIarguments\fR which can be -obtained by invoking the 'help' command followed by the command name. -.RE -.RS 3 -.TP 3 -\fIPerfCounter.print\fR -Print the performance counters available on the targeted Java -process(es). The list of performance counters may vary with the Java -process. -.RE -.RS 3 -.TP 3 -\fI-f file\fR -Read commands from \fIfile\fR and invoke them on the targeted Java -process(es). In \fIfile\fR, each command must be written on a single line. -Lines starting with # are ignored. Processing of \fIfile\fR ends when -all lines have been invoked or when a line containing the 'stop' keyword -is read. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jps(1) -.RE +The command to be sent to the specified Java process\&. The list of available diagnostic commands for a given process can be obtained by sending the \f3help\fR command to this process\&. Each diagnostic command has its own set of arguments\&. To see the description, syntax, and a list of available arguments for a command, use the name of the command as the argument for the \f3help\fR command\&. - +\fINote:\fR If any arguments contain spaces, you must surround them with single or double quotation marks (\f3\&'\fR or \f3"\fR)\&. In addition, you must escape single or double quotation marks with a backslash (\f3\e\fR) to prevent the operating system shell from processing quotation marks\&. Alternatively, you can surround these arguments with single quotation marks and then with double quotation marks (or with double quotation marks and then with single quotation marks)\&. +.SH OPTIONS +Options are mutually exclusive\&. +.TP +-f \fIfilename\fR +.br +Reads commands from the specified file\&. This option can be used only if you specify the process identifier or the main class as the first argument\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. +.TP +-h, -help +.br +Prints a help message\&. +.TP +-l +.br +Prints the list of running Java processes identifiers with the main class and command-line arguments\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jconsole.1 b/jdk/src/linux/doc/man/jconsole.1 index 14d87bb83c5..8afd342a36b 100644 --- a/jdk/src/linux/doc/man/jconsole.1 +++ b/jdk/src/linux/doc/man/jconsole.1 @@ -1,137 +1,113 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jconsole 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools +.\" Title: jconsole.1 +.\" +.if n .pl 99999 +.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jconsole \- Java Monitoring and Management Console -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ] -.fl +.SH NAME +jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi +\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR +The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -connection = pid | host:port | jmxUrl -.RS 3 -.TP 2 -o -\f2pid\fP Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See -.na -\f2JMX Monitoring and Management\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. -.TP 2 -o -\f2host\fP:\f2port\fP Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See -.na -\f2JMX Monitoring and Management\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. -.TP 2 -o -\f2jmxUrl\fP Address of the JMX agent to be connected to as described in -.na -\f2JMXServiceURL\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html. -.RE -.RE +For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jconsole\fP command launches a graphical console tool that enables you to monitor and manage Java applications and virtual machines on a local or remote machine. -.LP -.LP -On Windows, \f3jconsole\fP does not associate with a console window. It will, however, display a dialog box with error information if the \f3jconsole\fP command fails for some reason. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-interval=n -Set the update interval to \f2n\fP seconds (default is 4 seconds). -.TP 3 -\-notile -Do not tile windows initially (for two or more connections). -.TP 3 -\-pluginpath plugins -Specify a list of directories or JAR files which are searched for JConsole plugins. The \f2plugins\fP path should contain a provider\-configuration file named: +See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.SH DESCRIPTION +The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. +.PP +On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. +.SH OPTIONS +.TP +-interval\fI=n\fR .br -.nf -\f3 -.fl - META\-INF/services/com.sun.tools.jconsole.JConsolePlugin -.fl -\fP -.fi -containing one line for each plugin specifying the fully qualified class name of the class implementing the -.na -\f2com.sun.tools.jconsole.JConsolePlugin\fP @ -.fi -http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. -.TP 3 -\-version -Output version information and exit. -.TP 3 -\-help -Output help message and exit. -.TP 3 -\-J<flag> -Pass <flag> to the Java virtual machine on which jconsole is run. -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -.na -\f2Using JConsole\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html -.TP 2 -o -.na -\f2Monitoring and Management for Java Platform\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html -.RE - -.LP - +Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. +.TP +-notile +.br +Does not tile windows initially (for two or more connections)\&. +.TP +-pluginpath \fIplugins\fR +.br +Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. +.TP +-version +.br +Displays release information and exits\&. +.TP +-help +.br +Displays a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html +.TP 0.2i +\(bu +Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html +.TP 0.2i +\(bu +The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jdb.1 b/jdk/src/linux/doc/man/jdb.1 index e89a60b9748..4304f15e8a9 100644 --- a/jdk/src/linux/doc/man/jdb.1 +++ b/jdk/src/linux/doc/man/jdb.1 @@ -1,330 +1,271 @@ -." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jdb 1 "10 May 2011" +'\" t +.\" Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdb.1 +.\" +.if n .pl 99999 +.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jdb \- The Java Debugger -.LP -.LP -\f3jdb\fP helps you find and fix bugs in Java language programs. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jdb\fP [ options ] [ class ] [ arguments ] -.fl -.fi +.SH NAME +jdb \- Finds and fixes bugs in Java platform programs\&. +.SH SYNOPSIS +.sp +.nf -.LP -.RS 3 -.TP 3 -options -Command\-line options, as specified below. -.TP 3 -class -Name of the class to begin debugging. -.TP 3 -arguments -Arguments passed to the \f2main()\fP method of \f2class\fP. -.RE +\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fRname +Name of the main class to debug\&. +.TP +\fIarguments\fR +Arguments passed to the \f3main()\fR method of the class\&. +.SH DESCRIPTION +The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.SS START\ A\ JDB\ SESSION +There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: +.sp +.nf +\f3jdb MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. +.PP +Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. +.sp +.nf +\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +You can then attach the \f3jdb\fR command to the JVM with the following command: +.sp +.nf +\f3jdb \-attach 8000\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. +.PP +There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. +.SS BASIC\ JDB\ COMMANDS +The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. +.TP +help or ? +The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. +.TP +run +After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. +.TP +cont +Continues execution of the debugged application after a breakpoint, exception, or step\&. +.TP +print +Displays Java objects and primitive values\&. For variables or fields of primitive types, the actual value is printed\&. For objects, a short description is printed\&. See the dump command to find out how to get more information about an object\&. -.LP -.SH "DESCRIPTION" -.LP -.LP -The Java Debugger, \f3jdb\fP, is a simple command\-line debugger for Java classes. It is a demonstration of the -.na -\f2Java Platform Debugger Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/index.html that provides inspection and debugging of a local or remote Java Virtual Machine. -.LP -.SS -Starting a jdb Session -.LP -.LP -There are many ways to start a jdb session. The most frequently used way is to have \f3jdb\fP launch a new Java Virtual Machine (VM) with the main class of the application to be debugged. This is done by substituting the command \f3jdb\fP for \f3java\fP in the command line. For example, if your application's main class is MyClass, you use the following command to debug it under JDB: -.LP -.nf -\f3 -.fl - % jdb MyClass -.fl -\fP -.fi +\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. -.LP -.LP -When started this way, \f3jdb\fP invokes a second Java VM with any specified parameters, loads the specified class, and stops the VM before executing that class's first instruction. -.LP -.LP -Another way to use \f3jdb\fP is by attaching it to a Java VM that is already running. Syntax for Starting a VM to which jdb will attach when the VM is running is as follows. This loads in\-process debugging libraries and specifies the kind of connection to be made. -.LP -.nf -\f3 -.fl -\-agentlib:jdwp=transport=dt_socket,server=y,suspend=n -.fl -\fP -.fi +The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: +.sp +.nf +\f3print MyClass\&.myStaticField\fP +.fi +.nf +\f3print myObj\&.myInstanceField\fP +.fi +.nf +\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP +.fi +.nf +\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP +.fi +.nf +\f3print new java\&.lang\&.String("Hello")\&.length()\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -For example, the following command will run the MyClass application, and allow \f3jdb\fP to connect to it at a later time. -.LP -.nf -\f3 -.fl - % java \-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n MyClass -.fl -\fP -.fi +.TP +dump +For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. +.TP +threads +List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. +.sp +.nf +\f34\&. (java\&.lang\&.Thread)0x1 main running\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -You can then attach \f3jdb\fP to the VM with the following commmand: -.LP -.nf -\f3 -.fl - % jdb \-attach 8000 -.fl -\fP -.fi +.TP +thread +Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. +.TP +where +The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. -.LP -.LP -Note that "MyClass" is not specified in the \f3jdb\fP command line in this case because \f3jdb\fP is connecting to an existing VM instead of launching a new one. -.LP -.LP -There are many other ways to connect the debugger to a VM, and all of them are supported by \f3jdb\fP. The Java Platform Debugger Architecture has additional -.na -\f2documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection options. For information on starting a J2SE 1.4.2 or early VM for use with \f3jdb\fP see the -.na -\f21.4.2 documentation\fP @ -.fi -http://java.sun.com/j2se/1.4.2/docs/guide/jpda/conninv.html -.LP -.SS -Basic jdb Commands -.LP -.LP -The following is a list of the basic \f3jdb\fP commands. The Java debugger supports other commands which you can list using \f3jdb\fP's \f2help\fP command. -.LP -.RS 3 -.TP 3 -help, or ? -The most important \f3jdb\fP command, \f2help\fP displays the list of recognized commands with a brief description. -.TP 3 -run -After starting \f3jdb\fP, and setting any necessary breakpoints, you can use this command to start the execution the debugged application. This command is available only when \f3jdb\fP launches the debugged application (as opposed to attaching to an existing VM). -.TP 3 -cont -Continues execution of the debugged application after a breakpoint, exception, or step. -.TP 3 -print -Displays Java objects and primitive values. For variables or fields of primitive types, the actual value is printed. For objects, a short description is printed. See the \f2dump\fP command below for getting more information about an object. +If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. +.SS BREAKPOINTS +Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: +.TP 0.2i +\(bu +The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. +.TP 0.2i +\(bu +The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. +.TP 0.2i +\(bu +The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. +.PP +When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. +.PP +The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. +.SS STEPPING +The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. +.SS EXCEPTIONS +When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. +.PP +Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. +.PP +The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. +.SH OPTIONS +When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. +.PP +Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.TP +-help .br +Displays a help message\&. +.TP +-sourcepath \fIdir1:dir2: \&. \&. \&.\fR .br -\f2NOTE: To display local variables, the containing class must have been compiled with the \fP\f2javac(1)\fP\f2 \fP\f2\-g\fP option. +Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. +.TP +-attach \fIaddress\fR .br +Attaches the debugger to a running JVM with the default connection mechanism\&. +.TP +-listen \fIaddress\fR .br -\f2print\fP supports many simple Java expressions including those with method invocations, for example: -.RS 3 -.TP 2 -o -\f2print MyClass.myStaticField\fP -.TP 2 -o -\f2print myObj.myInstanceField\fP -.TP 2 -o -\f2print i + j + k\fP \f2(i, j, k are primities and either fields or local variables)\fP -.TP 2 -o -\f2print myObj.myMethod()\fP \f2(if myMethod returns a non\-null)\fP -.TP 2 -o -\f2print new java.lang.String("Hello").length()\fP -.RE -.TP 3 -dump -For primitive values, this command is identical to \f2print\fP. For objects, it prints the current value of each field defined in the object. Static and instance fields are included. +Waits for a running JVM to connect to the specified address with a standard connector\&. +.TP +-launch .br +Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. +.TP +-listconnectors .br -The \f2dump\fP command supports the same set of expressions as the \f2print\fP command. -.TP 3 -threads -List the threads that are currently running. For each thread, its name and current status are printed, as well as an index that can be used for other commands, for example: -.nf -\f3 -.fl -4. (java.lang.Thread)0x1 main running -.fl -\fP -.fi -In this example, the thread index is 4, the thread is an instance of java.lang.Thread, the thread name is "main", and it is currently running, -.TP 3 -thread -Select a thread to be the current thread. Many \f3jdb\fP commands are based on the setting of the current thread. The thread is specified with the thread index described in the \f2threads\fP command above. -.TP 3 -where -\f2where\fP with no arguments dumps the stack of the current thread. \f2where all\fP dumps the stack of all threads in the current thread group. \f2where\fP \f2threadindex\fP dumps the stack of the specified thread. +List the connectors available in this JVM\&. +.TP +-connect connector-name:\fIname1=value1\fR .br +Connects to the target JVM with the named connector and listed argument values\&. +.TP +-dbgtrace [\fIflags\fR] .br -If the current thread is suspended (either through an event such as a breakpoint or through the \f2suspend\fP command), local variables and fields can be displayed with the \f2print\fP and \f2dump\fP commands. The \f2up\fP and \f2down\fP commands select which stack frame is current. -.RE - -.LP -.SS -Breakpoints -.LP -.LP -Breakpoints can be set in \f3jdb\fP at line numbers or at the first instruction of a method, for example: -.LP -.RS 3 -.TP 2 -o -\f2stop at MyClass:22\fP \f2(sets a breakpoint at the first instruction for line 22 of the source file containing MyClass)\fP -.TP 2 -o -\f2stop in java.lang.String.length\fP \f2(sets a breakpoint at the beginnig of the method \fP\f2java.lang.String.length\fP) -.TP 2 -o -\f2stop in MyClass.<init>\fP \f2(<init> identifies the MyClass constructor)\fP -.TP 2 -o -\f2stop in MyClass.<clinit>\fP \f2(<clinit> identifies the static initialization code for MyClass)\fP -.RE - -.LP -.LP -If a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint. For example, "\f2MyClass.myMethod(int,java.lang.String)\fP", or "\f2MyClass.myMethod()\fP". -.LP -.LP -The \f2clear\fP command removes breakpoints using a syntax as in "\f2clear\ MyClass:45\fP". Using the \f2clear\fP or command with no argument displays a list of all breakpoints currently set. The \f2cont\fP command continues execution. -.LP -.SS -Stepping -.LP -.LP -The \f2step\fP commands advances execution to the next line whether it is in the current stack frame or a called method. The \f2next\fP command advances execution to the next line in the current stack frame. -.LP -.SS -Exceptions -.LP -.LP -When an exception occurs for which there isn't a catch statement anywhere in the throwing thread's call stack, the VM normally prints an exception trace and exits. When running under \f3jdb\fP, however, control returns to \f3jdb\fP at the offending throw. You can then use \f3jdb\fP to diagnose the cause of the exception. -.LP -.LP -Use the \f2catch\fP command to cause the debugged application to stop at other thrown exceptions, for example: "\f2catch java.io.FileNotFoundException\fP" or "\f2catch mypackage.BigTroubleException\fP. Any exception which is an instance of the specifield class (or of a subclass) will stop the application at the point where it is thrown. -.LP -.LP -The \f2ignore\fP command negates the effect of a previous \f2catch\fP command. -.LP -.LP -\f2NOTE: The \fP\f2ignore\fP command does not cause the debugged VM to ignore specific exceptions, only the debugger. -.LP -.SH "Command Line Options" -.LP -.LP -When you use \f3jdb\fP in place of the Java application launcher on the command line, \f3jdb\fP accepts many of the same options as the java command, including \f2\-D\fP, \f2\-classpath\fP, and \f2\-X<option>\fP. -.LP -.LP -The following additional options are accepted by \f3jdb\fP: -.LP -.RS 3 -.TP 3 -\-help -Displays a help message. -.TP 3 -\-sourcepath <dir1:dir2:...> -Uses the given path in searching for source files in the specified path. If this option is not specified, the default path of "." is used. -.TP 3 -\-attach <address> -Attaches the debugger to previously running VM using the default connection mechanism. -.TP 3 -\-listen <address> -Waits for a running VM to connect at the specified address using standard connector. -.TP 3 -\-listenany -Waits for a running VM to connect at any available address using standard connector. -.TP 3 -\-launch -Launches the debugged application immediately upon startup of jdb. This option removes the need for using the \f2run\fP command. The debuged application is launched and then stopped just before the initial application class is loaded. At that point you can set any necessary breakpoints and use the \f2cont\fP to continue execution. -.TP 3 -\-listconnectors -List the connectors available in this VM -.TP 3 -\-connect <connector\-name>:<name1>=<value1>,... -Connects to target VM using named connector with listed argument values. -.TP 3 -\-dbgtrace [flags] -Prints info for debugging jdb. -.TP 3 -\-tclient -Runs the application in the Java HotSpot(tm) VM (Client). -.TP 3 -\-tserver -Runs the application in the Java HotSpot(tm) VM (Server). -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine used to run jdb. (Options for the application Java virtual machine are passed to the \f3run\fP command.) For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.LP -Other options are supported for alternate mechanisms for connecting the debugger and the VM it is to debug. The Java Platform Debugger Architecture has additional -.na -\f2documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection alternatives. -.LP -.SS -Options Forwarded to Debuggee Process -.LP -.RS 3 -.TP 3 -\-v \-verbose[:class|gc|jni] -Turns on verbose mode. -.TP 3 -\-D<name>=<value> -Sets a system property. -.TP 3 -\-classpath <directories separated by ":"> -Lists directories in which to look for classes. -.TP 3 -\-X<option> -Non\-standard target VM option -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), javah(1), javap(1), javadoc(1). -.LP - +Prints information for debugging the \f3jdb\fR command\&. +.TP +-tclient +.br +Runs the application in the Java HotSpot VM client\&. +.TP +-tserver +.br +Runs the application in the Java HotSpot VM server\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS +.TP +-v -verbose[:\fIclass\fR|gc|jni] +.br +Turns on verbose mode\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property\&. +.TP +-classpath \fIdir\fR +.br +Lists directories separated by colons in which to look for classes\&. +.TP +-X\fIoption\fR +.br +Nonstandard target JVM option\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jdeps.1 b/jdk/src/linux/doc/man/jdeps.1 new file mode 100644 index 00000000000..9b8f698f6a2 --- /dev/null +++ b/jdk/src/linux/doc/man/jdeps.1 @@ -0,0 +1,532 @@ +'\" t +.\" Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdeps.1 +.\" +.if n .pl 99999 +.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdeps \- Java class dependency analyzer\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fR\fIes\fR +Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. +.SH DESCRIPTION +The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. +.SH OPTIONS +.TP +-dotoutput <\fIdir\fR> +.br +Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. +.TP +-s, -summary +.br +Prints dependency summary only\&. +.TP +-v, -verbose +.br +Prints all class-level dependencies\&. +.TP +-verbose:package +.br +Prints package-level dependencies excluding dependencies within the same archive\&. +.TP +-verbose:class +.br +Prints class-level dependencies excluding dependencies within the same archive\&. +.TP +-cp <\fIpath\fR>, -classpath <\fIpath\fR> +.br +Specifies where to find class files\&. + +See also Setting the Class Path\&. +.TP +-p <\fIpkg name\fR>, -package <\fIpkg name\fR> +.br +Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-e <\fIregex\fR>, -regex <\fIregex\fR> +.br +Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-include <\fIregex\fR> +.br +Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. +.TP +-P, -profile +.br +Shows profile or the file containing a package\&. +.TP +-apionly +.br +Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. +.TP +-R, -recursive +.br +Recursively traverses all dependencies\&. +.TP +-version +.br +Prints version information\&. +.TP +-h, -?, -help +.br +Prints help message for \f3jdeps\fR\&. +.SH EXAMPLES +Analyzing the dependencies of Notepad\&.jar\&. +.sp +.nf +\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt \fP +.fi +.nf +\f3 \-> java\&.awt\&.event \fP +.fi +.nf +\f3 \-> java\&.beans \fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.logging \fP +.fi +.nf +\f3 \-> javax\&.swing \fP +.fi +.nf +\f3 \-> javax\&.swing\&.border \fP +.fi +.nf +\f3 \-> javax\&.swing\&.event \fP +.fi +.nf +\f3 \-> javax\&.swing\&.text \fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree \fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo \fP +.fi +.nf +\f3\fP +.fi +.sp +Use -P or -profile option to show on which profile that Notepad depends\&. +.sp +.nf +\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt Full JRE\fP +.fi +.nf +\f3 \-> java\&.awt\&.event Full JRE\fP +.fi +.nf +\f3 \-> java\&.beans Full JRE\fP +.fi +.nf +\f3 \-> java\&.io compact1\fP +.fi +.nf +\f3 \-> java\&.lang compact1\fP +.fi +.nf +\f3 \-> java\&.net compact1\fP +.fi +.nf +\f3 \-> java\&.util compact1\fP +.fi +.nf +\f3 \-> java\&.util\&.logging compact1\fP +.fi +.nf +\f3 \-> javax\&.swing Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.border Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.event Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.text Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo Full JRE\fP +.fi +.nf +\f3\fP +.fi +.sp +Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. +.sp +.nf +\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. +.sp +.nf +\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io\&.PrintWriter \fP +.fi +.nf +\f3 \-> java\&.lang\&.Exception \fP +.fi +.nf +\f3 \-> java\&.lang\&.Object \fP +.fi +.nf +\f3 \-> java\&.lang\&.String \fP +.fi +.nf +\f3 \-> java\&.lang\&.System \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. +.sp +.nf +\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.nio\&.charset \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.nio\&.file\&.attribute \fP +.fi +.nf +\f3 \-> java\&.text \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 javax\&.crypto (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.nio \fP +.fi +.nf +\f3 \-> java\&.security \fP +.fi +.nf +\f3 \-> java\&.security\&.cert \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.concurrent \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3 \-> javax\&.security\&.auth \fP +.fi +.nf +\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 javax\&.crypto\&.spec (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP +.fi +.nf +\f3 java\&.security (rt\&.jar)\fP +.fi +.nf +\f3 \-> javax\&.crypto\fP +.fi +.nf +\f3\fP +.fi +.sp +Generate dot files of the dependencies of Notepad demo\&. +.sp +.nf +\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files +.sp +.nf +\f3$ cat dot/Notepad\&.jar\&.dot \fP +.fi +.nf +\f3digraph "Notepad\&.jar" {\fP +.fi +.nf +\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.beans";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.io";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.lang";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.net";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3$ cat dot/summary\&.dot\fP +.fi +.nf +\f3digraph "summary" {\fP +.fi +.nf +\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jhat.1 b/jdk/src/linux/doc/man/jhat.1 index 62c72f68521..c53dc0fce38 100644 --- a/jdk/src/linux/doc/man/jhat.1 +++ b/jdk/src/linux/doc/man/jhat.1 @@ -1,141 +1,137 @@ -." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jhat 1 "10 May 2011" +'\" t +.\" Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jhat.1 +.\" +.if n .pl 99999 +.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jhat \- Java Heap Analysis Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jhat\fP [ \f2options\fP ] <heap\-dump\-file> -.fl +.SH NAME +jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -heap\-dump\-file -Java binary heap dump file to be browsed. For a dump file that contains multiple heap dumps, you may specify which dump in the file by appending "#<number> to the file name, i.e. "foo.hprof#3". -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jhat\fP command parses a java heap dump file and launches a webserver. jhat enables you to browse heap dumps using your favorite webbrowser. jhat supports pre\-designed queries (such as 'show all instances of a known class "Foo"') as well as \f3OQL\fP (\f3O\fPbject \f3Q\fPuery \f3L\fPanguage) \- a SQL\-like query language to query heap dumps. Help on OQL is available from the OQL help page shown by jhat. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ -.LP -.LP -There are several ways to generate a java heap dump: -.LP -.RS 3 -.TP 2 -o -Use jmap(1) \-dump option to obtain a heap dump at runtime; -.TP 2 -o -Use jconsole(1) option to obtain a heap dump via -.na -\f2HotSpotDiagnosticMXBean\fP @ -.fi -http://download.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime; -.TP 2 -o -Heap dump will be generated when OutOfMemoryError is thrown by specifying \-XX:+HeapDumpOnOutOfMemoryError VM option; -.TP 2 -o -Use -.na -\f2hprof\fP @ -.fi -http://java.sun.com/developer/technicalArticles/Programming/HPROF.html. -.RE - -.LP -.LP -\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-stack false/true -Turn off tracking object allocation call stack. Note that if allocation site information is not available in the heap dump, you have to set this flag to false. Default is true. -.TP 3 -\-refs false/true -Turn off tracking of references to objects. Default is true. By default, back pointers (objects pointing to a given object a.k.a referrers or in\-coming references) are calculated for all objects in the heap. -.TP 3 -\-port port\-number -Set the port for the jhat's HTTP server. Default is 7000. -.TP 3 -\-exclude exclude\-file -Specify a file that lists data members that should be excluded from the "reachable objects" query. For example, if the file lists \f2java.lang.String.value\fP, then, whenever list of objects reachable from a specific object "o" are calculated, reference paths involving \f2java.lang.String.value\fP field will not considered. -.TP 3 -\-baseline baseline\-dump\-file -Specify a baseline heap dump. Objects in both heap dumps with the same object ID will be marked as not being "new". Other objects will be marked as "new". This is useful while comparing two different heap dumps. -.TP 3 -\-debug int -Set debug level for this tool. 0 means no debug output. Set higher values for more verbose modes. -.TP 3 -\-version -Report version number and exit. -.TP 3 -\-h -Output help message and exit. -.TP 3 -\-help -Output help message and exit. -.TP 3 -\-J<flag> -Pass <flag> to the Java virtual machine on which jhat is run. For example, \-J\-Xmx512m to use a maximum heap size of 512MB. -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jmap(1) -.TP 2 -o -jconsole(1) -.TP 2 -o -.na -\f2hprof \- Heap and CPU profiling tool\fP @ -.fi -http://java.sun.com/developer/technicalArticles/Programming/HPROF.html -.RE - -.LP - +\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIheap-dump-file\fR +Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. +.SH DESCRIPTION +The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ +.PP +There are several ways to generate a Java heap dump: +.TP 0.2i +\(bu +Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. +.TP 0.2i +\(bu +Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html +.TP 0.2i +\(bu +Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. +.TP 0.2i +\(bu +Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.SH OPTIONS +.TP +-stack false|true +.br +Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. +.TP +-refs false|true +.br +Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. +.TP +-port \fIport-number\fR +.br +Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. +.TP +-exclude \fIexclude-file\fR +.br +Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. +.TP +-baseline \fIexclude-file\fR +.br +Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. +.TP +-debug \fIint\fR +.br +Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. +.TP +-version +.br +Reports the release number and exits +.TP +-h +.br +Dsiplays a help message and exits\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jconsole(1) +.TP 0.2i +\(bu +HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jinfo.1 b/jdk/src/linux/doc/man/jinfo.1 index ea072ffce64..42a5ebd3b18 100644 --- a/jdk/src/linux/doc/man/jinfo.1 +++ b/jdk/src/linux/doc/man/jinfo.1 @@ -1,147 +1,133 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jinfo 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jinfo.1 +.\" +.if n .pl 99999 +.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jinfo \- Configuration Info -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jinfo\fP [ option ] pid -.fl -\f3jinfo\fP [ option ] executable core -.fl -\f3jinfo\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi +.SH NAME +jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -option -Options are mutually exclusive. Option, if used, should follow immediately after the command name. -.RE +\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR +.fi +.nf -.LP -.RS 3 -.TP 3 -pid -process id for which the configuration info is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.RE +\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR +.fi +.nf -.LP -.RS 3 -.TP 3 -executable -Java executable from which the core dump was produced. -.RE - -.LP -.RS 3 -.TP 3 -core -core file for which the configuration info is to be printed. -.RE - -.LP -.RS 3 -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. -.RE - -.LP -.RS 3 -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jinfo\fP prints Java configuration information for a given Java process or core file or a remote debug server. Configuration information includes Java System properties and Java virtual machine command line flags. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: +\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoption\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the configuration information is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. +.PP +This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. +.SH OPTIONS +.TP +no-option +Prints both command-line flags and system property name-value pairs\&. +.TP +-flag \fIname\fR .br -jinfo \-J\-d64 \-sysprops pid -.LP -.LP -\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' need to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP -.LP -.LP -\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -<no option> -prints both command line flags as well as System properties name, value pairs. +Prints the name and value of the specified command-line flag\&. +.TP +-flag \fI[+|-]name\fR .br -.TP 3 -\-flag name -prints the name and value of the given command line flag. +enables or disables the specified Boolean command-line flag\&. +.TP +-flag \fIname=value\fR .br -.TP 3 -\-flag [+|\-]name -enables or disables the given boolean command line flag. +Sets the specified command-line flag to the specified value\&. +.TP +-flags .br -.TP 3 -\-flag name=value -sets the given command line flag to the specified value. +Prints command-line flags passed to the JVM\&. +.TP +-sysprops .br -.TP 3 -\-flags -prints command line flags passed to the JVM. pairs. +Prints Java system properties as name-value pairs\&. +.TP +-h .br -.TP 3 -\-sysprops -prints Java System properties as name, value pairs. +Prints a help message\&. +.TP +-help .br -.TP 3 -\-h -prints a help message -.TP 3 -\-help -prints a help message -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jps(1) -.TP 2 -o -jsadebugd(1) -.RE - -.LP - +Prints a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jjs.1 b/jdk/src/linux/doc/man/jjs.1 new file mode 100644 index 00000000000..47b5602ac10 --- /dev/null +++ b/jdk/src/linux/doc/man/jjs.1 @@ -0,0 +1,352 @@ +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jjs.1 +.\" +.if n .pl 99999 +.TH jjs 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jjs \- Invokes the Nashorn engine\&. +.SH SYNOPSIS +.sp +.nf +\f3\fBjjs\fR [\fIoptions\fR] [\fIscript\-files\fR] [\-\- \fIarguments\fR]\fP +.fi +.sp +.TP +\fIoptions\fR +One or more options of the \f3jjs\fR command, separated by spaces\&. For more information, see Options\&. +.TP +\fIscript-files\fR +One or more script files which you want to interpret using Nashorn, separated by spaces\&. If no files are specified, an interactive shell is started\&. +.TP +\fIarguments\fR +All values after the double hyphen marker (\f3--\fR) are passed through to the script or the interactive shell as arguments\&. These values can be accessed by using the \f3arguments\fR property (see )\&. +.SH DESCRIPTION +The \f3jjs\fR command-line tool is used to invoke the Nashorn engine\&. You can use it to interpret one or several script files, or to run an interactive shell\&. +.SH OPTIONS +The options of the \f3jjs\fR command control the conditions under which scripts are interpreted by Nashorn\&. +.TP +-ccs=\fIsize\fR , --class-cache-size=\fIsize\fR +.br +Sets the class cache size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes (KB), \f3m\fR or \f3M\fR to indicate megabytes (MB), \f3g\fR or \f3G\fR to indicate gigabytes (GB)\&. By default, the class cache size is set to 50 bytes\&. The following example shows how to set it to 1024 bytes (1 KB): +.sp +.nf +\f3\-css=100\fP +.fi +.nf +\f3\-css=1k\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-co, --compile-only +.br +Compiles the script without running it\&. +.TP +-cp \fIpath\fR , --classpath \fIpath\fR +.br +Specifies the path to the supporting class files To set multiple paths, the option can be repeated, or you can separate each path with a colon (:)\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property to be passed to the script by assigning a value to a property name\&. The following example shows how to invoke Nashorn in interactive mode and assign \f3myValue\fR to the property named \f3myKey\fR: +.sp +.nf +\f3>> \fIjjs \-DmyKey=myValue\fR\fP +.fi +.nf +\f3jjs> \fIjava\&.lang\&.System\&.getProperty("myKey")\fR\fP +.fi +.nf +\f3myValue\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This option can be repeated to set multiple properties\&. +.TP +-d=\fIpath\fR , --dump-debug-dir=\fIpath\fR +.br +Specifies the path to the directory where class files are dumped\&. +.TP +--debug-lines +.br +Generates a line number table in the class file\&. By default, this option is enabled\&. To disable it, specify \f3--debug-lines=false\fR\&. +.TP +--debug-locals +.br +Generates a local variable table in the class file\&. +.TP +-doe, --dump-on-error +.br +Provides a full stack trace when an arror occurs\&. By default, only a brief error message is printed\&. +.TP +--early-lvalue-error +.br +Reports invalid lvalue expressions as early errors (that is, when the code is parsed)\&. By default, this option is enabled\&. To disable it, specify \f3--early-lvalue-error=false\fR\&. When disabled, invalid lvalue expressions will not be reported until the code is executed\&. +.TP +--empty-statements +.br +Preserves empty statements in the Java abstract syntax tree\&. +.TP +-fv, --fullversion +.br +Prints the full Nashorn version string\&. +.TP +--function-statement-error +.br +Prints an error message when a function declaration is used as a statement\&. +.TP +--function-statement-warning +.br +Prints a warning message when a function declaration is used as a statement\&. +.TP +-fx +.br +Launches the script as a JavaFX application\&. +.TP +-h, -help +.br +Prints the list of options and their descriptions\&. +.TP +-J\fIoption\fR +.br +Passes the specified \f3java\fR launcher option to the JVM\&. The following example shows how to invoke Nashorn in interactive mode and set the maximum memory used by the JVM to 4 GB: +.sp +.nf +\f3>> \fIjjs \-J\-Xmx4g\fR\fP +.fi +.nf +\f3jjs> \fIjava\&.lang\&.Runtime\&.getRuntime()\&.maxMemory()\fR\fP +.fi +.nf +\f33817799680\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This option can be repeated to pass multiple \f3java\fR command options\&. +.TP +--lazy-compilation +.br +Enables lazy code generation strategies (that is, the entire script is not compiled at once)\&. This option is experimental\&. +.TP +--loader-per-compile +.br +Creates a new class loader per compile\&. By default, this option is enabled\&. To disable it, specify \f3--loader-per-compile=false\fR\&. +.TP +--log=\fIsubsystem\fR:\fIlevel\fR +.br +Performs logging at a given level for the specified subsystems\&. You can specify logging levels for multiple subsystems separating them with commas\&. For example: +.sp +.nf +\f3\-\-log=fields:finest,codegen:info\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +--package=\fIname\fR +.br +Specifies the package to which generated class files are added\&. +.TP +--parse-only +.br +Parses the code without compiling\&. +.TP +--print-ast +.br +Prints the abstract syntax tree\&. +.TP +--print-code +.br +Prints bytecode\&. +.TP +--print-lower-ast +.br +Prints the lowered abstract syntax tree\&. +.TP +--print-lower-parse +.br +Prints the lowered parse tree\&. +.TP +--print-no-newline +.br +Forces other \f3--print*\fR options to print the output on one line\&. +.TP +--print-parse +.br +Prints the parse tree\&. +.TP +--print-symbols +.br +Prints the symbol table\&. +.TP +-pcs, --profile-callsites +.br +Dumps callsite profile data\&. +.TP +-scripting +.br +Enables shell scripting features\&. +.TP +--stderr=\fIfilename\fR|\fIstream\fR|\fItty\fR +.br +Redirects the standard error stream to the specified file, stream (for example, to \f3stdout\fR), or text terminal\&. +.TP +--stdout=\fIfilename\fR|\fIstream\fR|\fItty\fR +.br +Redirects the standard output stream to the specified file, stream (for example, to \f3stderr\fR), or text terminal\&. +.TP +-strict +.br +Enables strict mode, which enforces stronger adherence to the standard (ECMAScript Edition 5\&.1), making it easier to detect common coding errors\&. +.TP +-t=\fIzone\fR , -timezone=\fIzone\fR +.br +Sets the specified time zone for script execution\&. It overrides the time zone set in the OS and used by the \f3Date\fR object\&. +.TP +-tcs=\fIparameter\fR , --trace-callsites=\fIparameter\fR +.br +Enables callsite trace mode\&. Possible parameters are the following: +.RS +.TP +miss +Trace callsite misses\&. +.TP +enterexit +Trace callsite enter/exit\&. +.TP +objects +Print object properties\&. +.RE + +.TP +--verify-code +.br +Verifies bytecode before running\&. +.TP +-v, -version +.br +Prints the Nashorn version string\&. +.TP +-xhelp +.br +Prints extended help for command-line options\&. +.SH EXAMPLES +\f3Example 1 Running a Script with Nashorn\fR +.sp +.nf +\f3jjs script\&.js\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Running Nashorn in Interactive Mode\fR +.sp +.nf +\f3>> \fIjjs\fR\fP +.fi +.nf +\f3jjs> \fIprintln("Hello, World!")\fR\fP +.fi +.nf +\f3Hello, World!\fP +.fi +.nf +\f3jjs> \fIquit()\fR\fP +.fi +.nf +\f3>>\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Passing Arguments to Nashorn\fR +.sp +.nf +\f3>> \fIjjs \-\- a b c\fR\fP +.fi +.nf +\f3jjs> \fIarguments\&.join(", ")\fR\fP +.fi +.nf +\f3a, b, c\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp +.SH SEE\ ALSO +\f3jrunscript\fR +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jmap.1 b/jdk/src/linux/doc/man/jmap.1 index f906dedc681..cada22c54fd 100644 --- a/jdk/src/linux/doc/man/jmap.1 +++ b/jdk/src/linux/doc/man/jmap.1 @@ -1,160 +1,144 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jmap 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jmap.1 +.\" +.if n .pl 99999 +.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jmap \- Memory Map -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jmap\fP [ option ] pid -.fl -\f3jmap\fP [ option ] executable core -.fl -\f3jmap\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi +.SH NAME +jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -option -Options are mutually exclusive. Option, if used, should follow immediately after the command name. -.TP 3 -pid -process id for which the memory map is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.br -.TP 3 -executable -Java executable from which the core dump was produced. -.br -.TP 3 -core -core file for which the memory map is to be printed. -.br -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. -.br -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.br -.RE +\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jmap\fP prints shared object memory maps or heap memory details of a given process or core file or a remote debug server. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: -.LP -.nf -\f3 -.fl -jmap \-J\-d64 \-heap pid -.fl -\fP -.fi +\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf -.LP -.LP -\f3NOTE: This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP -.LP -.LP -\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP +\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the memory map is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH OPTIONS +.TP +<no option> +When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. +.TP +-dump:[live,] format=b, file=\fIfilename\fR .br - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -<no option> -When no option is used jmap prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility. +Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. +.TP +-finalizerinfo .br -.TP 3 -\-dump:[live,]format=b,file=<filename> -Dumps the Java heap in hprof binary format to filename. The \f2live\fP suboption is optional. If specified, only the live objects in the heap are dumped. To browse the heap dump, you can use jhat(1) (Java Heap Analysis Tool) to read the generated file. +Prints information about objects that are awaiting finalization\&. +.TP +-heap .br -.TP 3 -\-finalizerinfo -Prints information on objects awaiting finalization. +Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. +.TP +-histo[:live] .br -.TP 3 -\-heap -Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed. +Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. +.TP +-clstats .br -.TP 3 -\-histo[:live] -Prints a histogram of the heap. For each Java class, number of objects, memory size in bytes, and fully qualified class names are printed. VM internal class names are printed with '*' prefix. If the \f2live\fP suboption is specified, only live objects are counted. +Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. +.TP +-F .br -.TP 3 -\-permstat -Prints class loader wise statistics of permanent generation of Java heap. For each class loader, its name, liveness, address, parent class loader, and the number and size of classes it has loaded are printed. In addition, the number and size of interned Strings are printed. +Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. +.TP +-h .br -.TP 3 -\-F -Force. Use with jmap \-dump or jmap \-histo option if the pid does not respond. The \f2live\fP suboption is not supported in this mode. +Prints a help message\&. +.TP +-help .br -.TP 3 -\-h -Prints a help message. +Prints a help message\&. +.TP +-J\fIflag\fR .br -.br -.TP 3 -\-help -Prints a help message. -.br -.br -.TP 3 -\-J<flag> -Passes <flag> to the Java virtual machine on which jmap is run. -.br -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -pmap(1) -.TP 2 -o -jhat(1) -.TP 2 -o -jps(1) -.TP 2 -o -jsadebugd(1) -.RE - -.LP - +Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jhat(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jps.1 b/jdk/src/linux/doc/man/jps.1 index 1ec15e124ea..f03c31d9755 100644 --- a/jdk/src/linux/doc/man/jps.1 +++ b/jdk/src/linux/doc/man/jps.1 @@ -1,250 +1,205 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jps 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jps.1 +.\" +.if n .pl 99999 +.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jps \- Java Virtual Machine Process Status Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jps\fP [ \f2options\fP ] [ \f2hostid\fP ] +.SH NAME +jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIhostid\fR +The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. +.SH DESCRIPTION +The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. +.PP +If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. +.PP +The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. +.PP +The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. +.PP +The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. +.SH OPTIONS +The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. +.TP +-q .br - -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -hostid -The host identifier of the host for which the process report should be generated. The \f2hostid\fP may include optional components that indicate the communications protocol, port number, and other implementation specific data. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jps\fP tool lists the instrumented HotSpot Java Virtual Machines (JVMs) on the target system. The tool is limited to reporting information on JVMs for which it has the access permissions. -.LP -.LP -If \f3jps\fP is run without specifying a \f2hostid\fP, it will look for instrumented JVMs on the local host. If started with a \f2hostid\fP, it will look for JVMs on the indicated host, using the specified protocol and port. A \f3jstatd\fP process is assumed to be running on the target host. -.LP -.LP -The \f3jps\fP command will report the local VM identifier, or \f2lvmid\fP, for each instrumented JVM found on the target system. The \f3lvmid\fP is typically, but not necessarily, the operating system's process identifier for the JVM process. With no options, \f3jps\fP will list each Java application's \f2lvmid\fP followed by the short form of the application's class name or jar file name. The short form of the class name or JAR file name omits the class's package information or the JAR files path information. -.LP -.LP -The \f3jps\fP command uses the \f3java\fP launcher to find the class name and arguments passed to the \f2main\fP method. If the target JVM is started with a custom launcher, the class name (or JAR file name) and the arguments to the \f2main\fP method will not be available. In this case, the \f3jps\fP command will output the string \f2Unknown\fP for the class name or JAR file name and for the arguments to the main method. -.LP -.LP -The list of JVMs produced by the \f3jps\fP command may be limited by the permissions granted to the principal running the command. The command will only list the JVMs for which the principle has access rights as determined by operating system specific access control mechanisms. -.LP -.LP -\f3NOTE:\fP This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME platforms. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jps\fP command supports a number of options that modify the output of the command. These options are subject to change or removal in the future. -.LP -.RS 3 -.TP 3 -\-q -Suppress the output of the class name, JAR file name, and arguments passed to the \f2main\fP method, producing only a list of local VM identifiers. -.TP 3 -\-m -Output the arguments passed to the main method. The output may be null for embedded JVMs. -.TP 3 -\-l -Output the full package name for the application's main class or the full path name to the application's JAR file. -.TP 3 -\-v -Output the arguments passed to the JVM. -.TP 3 -\-V -Output the arguments passed to the JVM through the flags file (the .hotspotrc file or the file specified by the \-XX:Flags=<\f2filename\fP> argument). -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3jps\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.RE - -.LP -.SS -HOST IDENTIFIER -.LP -.LP -The host identifier, or \f2hostid\fP is a string that indicates the target system. The syntax of the \f2hostid\fP string largely corresponds to the syntax of a URI: -.LP -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][[//]\fP\f4hostname\fP\f3][:\fP\f4port\fP\f3][/\fP\f4servername\fP\f3]\fP +Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. +.TP +-m .br -\f3 -.fl -\fP -.fi - -.LP -.RS 3 -.TP 3 -protocol -The communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific, optimized, local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP. -.TP 3 -hostname -A hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host. -.TP 3 -port -The default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used. -.TP 3 -servername -The treatment of this parameter depends on the implementation. For the optimized, local protocol, this field is ignored. For the \f3rmi\fP protocol, this parameter is a string representing the name of the RMI remote object on the remote host. See the \f3\-n\fP option for the jstatd(1) command. -.RE - -.LP -.SH "OUTPUT FORMAT" -.LP -.LP -The output of the \f3jps\fP command follows the following pattern: -.LP -.nf -\f3 -.fl -\fP\f4lvmid\fP\f3 [ [ \fP\f4classname\fP\f3 | \fP\f4JARfilename\fP\f3 | "Unknown"] [ \fP\f4arg\fP\f3* ] [ \fP\f4jvmarg\fP\f3* ] ]\fP +Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. +.TP +-l .br -\f3 -.fl -\fP -.fi - -.LP -.LP -Where all output tokens are separated by white space. An \f2arg\fP that includes embedded white space will introduce ambiguity when attempting to map arguments to their actual positional parameters. +Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. +.TP +-v .br +Displays the arguments passed to the JVM\&. +.TP +-V .br -\f3NOTE\fP: You are advised not to write scripts to parse \f3jps\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jps\fP output, expect to modify them for future releases of this tool. +Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. +.TP +-J\f3option\fR .br - -.LP -.SH "EXAMPLES" -.LP -.LP -This section provides examples of the \f3jps\fP command. -.LP -.LP -Listing the instrumented JVMs on the local host: -.LP -.nf -\f3 -.fl -\fP\f3jps\fP -.br - -.fl -18027 Java2Demo.JAR -.br - -.fl -18032 jps -.br - -.fl -18005 jstat -.br - -.fl -.fi - -.LP -.LP -Listing the instrumented JVMs on a remote host: -.LP -.LP -This example assumes that the \f3jstat\fP server and either the its internal RMI registry or a separate external \f3rmiregistry\fP process are running on the remote host on the default port (port 1099). It also assumes that the local host has appropriate permissions to access the remote host. This example also includes the \f2\-l\fP option to output the long form of the class names or JAR file names. -.LP -.nf -\f3 -.fl -\fP\f3jps \-l remote.domain\fP -.br - -.fl -3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR -.br - -.fl -2857 sun.tools.jstatd.jstatd -.br - -.fl -.fi - -.LP -.LP -Listing the instrumented JVMs on a remote host with a non\-default port for the RMI registry -.LP -.LP -This example assumes that the \f3jstatd\fP server, with an internal RMI registry bound to port 2002, is running on the remote host. This example also uses the \f2\-m\fP option to include the arguments passed to the \f2main\fP method of each of the listed Java applications. -.LP -.nf -\f3 -.fl -\fP\f3jps \-m remote.domain:2002\fP -.br - -.fl -3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR -.br - -.fl -3102 sun.tools.jstatd.jstatd \-p 2002 -.fl -.fi - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jstat(1) \- the Java virtual machine Statistics Monitoring Tool -.TP 2 -o -jstatd(1) \- the jstat daemon -.TP 2 -o -rmiregistry(1) \- the Java Remote Object Registry -.RE - -.LP - +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH HOST\ IDENTIFIER +The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][[//]hostname][:port][/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +hostname +A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. +.TP +port +The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +servername +The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. +.SH OUTPUT\ FORMAT +The output of the \f3jps\fR command follows the following pattern: +.sp +.nf +\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP +.fi +.nf +\f3\fP +.fi +.sp +All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. +.PP +\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. +.SH EXAMPLES +This section provides examples of the \f3jps\fR command\&. +.PP +List the instrumented JVMs on the local host: +.sp +.nf +\f3jps\fP +.fi +.nf +\f318027 Java2Demo\&.JAR\fP +.fi +.nf +\f318032 jps\fP +.fi +.nf +\f318005 jstat\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. +.sp +.nf +\f3jps \-l remote\&.domain\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f32857 sun\&.tools\&.jstatd\&.jstatd\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. +.sp +.nf +\f3jps \-m remote\&.domain:2002\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jrunscript.1 b/jdk/src/linux/doc/man/jrunscript.1 index 7c6548fa794..981be31bf1a 100644 --- a/jdk/src/linux/doc/man/jrunscript.1 +++ b/jdk/src/linux/doc/man/jrunscript.1 @@ -1,187 +1,196 @@ -." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jrunscript 1 "10 May 2011" +'\" t +.\" Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Scripting Tools +.\" Title: jrunscript.1 +.\" +.if n .pl 99999 +.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jrunscript \- command line script shell -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jrunscript\fP [ \f2options\fP ] [ arguments... ] -.fl -.fi +.SH NAME +jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -arguments -Arguments, if used, should follow immediately after options or command name. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jrunscript\fP is a command line script shell. jrunscript supports both an interactive (read\-eval\-print) mode and a batch (\-f option) mode of script execution. This is a scripting language independent shell. By default, JavaScript is the language used, but the \-l option can be used to specify a different language. Through Java to scripting language communication, jrunscript supports "exploratory programming" style. -.LP -.LP -\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-classpath path -Specify where to find the user's .class files that are accessed by the script. -.TP 3 -\-cp path -This is a synonym for \-classpath \f2path\fP -.TP 3 -\-Dname=value -Set a Java system property. -.TP 3 -\-J<flag> -Pass <flag> directly to the Java virtual machine on which jrunscript is run. -.TP 3 -\-l language -Use the specified scripting language. By default, JavaScript is used. Note that to use other scripting languages, you also need to specify the corresponding script engine's jar file using \-cp or \-classpath option. -.TP 3 -\-e script -Evaluate the given script. This option can be used to run "one liner" scripts specified completely on the command line. -.TP 3 -\-encoding encoding -Specify the character encoding used while reading script files. -.TP 3 -\-f script\-file -Evaluate the given script file (batch mode). -.TP 3 -\-f \- -Read and evaluate a script from standard input (interactive mode). -.TP 3 -\-help\ -Output help message and exit. -.TP 3 -\-?\ -Output help message and exit. -.TP 3 -\-q\ -List all script engines available and exit. -.RE - -.LP -.SH "ARGUMENTS" -.LP -.LP -If [arguments...] are present and if no \f3\-e\fP or \f3\-f\fP option is used, then the first argument is the script file and the rest of the arguments, if any, are passed as script arguments. If [arguments..] and \f3\-e\fP or \f3\-f\fP option are used, then all [arguments..] are passed as script arguments. If [arguments..], \f3\-e\fP and \f3\-f\fP are missing, interactive mode is used. Script arguments are available to a script in an engine variable named "arguments" of type String array. -.LP -.SH "EXAMPLES" -.LP -.SS -Executing inline scripts -.LP -.nf -\f3 -.fl -jrunscript \-e "print('hello world')" -.fl -jrunscript \-e "cat('http://java.sun.com')" -.fl -\fP -.fi - -.LP -.SS -Use specified language and evaluate given script file -.LP -.nf -\f3 -.fl -jrunscript \-l js \-f test.js -.fl -\fP -.fi - -.LP -.SS -Interactive mode -.LP -.nf -\f3 -.fl -jrunscript -.fl -js> print('Hello World\\n'); -.fl -Hello World -.fl -js> 34 + 55 -.fl -89.0 -.fl -js> t = new java.lang.Thread(function() { print('Hello World\\n'); }) -.fl -Thread[Thread\-0,5,main] -.fl -js> t.start() -.fl -js> Hello World -.fl - -.fl -js> -.fl -\fP -.fi - -.LP -.SS -Run script file with script arguments -.LP -.nf -\f3 -.fl -jrunscript test.js arg1 arg2 arg3 -.fl -\fP -.fi - -.LP -test.js is script file to execute and arg1, arg2 and arg3 are passed to script as script arguments. Script can access these using "arguments" array. -.SH "SEE ALSO" -.LP -.LP -If JavaScript is used, then before evaluating any user defined script, jrunscript initializes certain built\-in functions and objects. These JavaScript built\-ins are documented in -.na -\f2jsdocs\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/share/jsdocs/allclasses\-noframe.html. -.LP - +\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIarguments\fR +Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. +.SH DESCRIPTION +The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +Indicate where any class files are that the script needs to access\&. +.TP +-cp \fIpath\fR +.br +Same as \f3-classpath\fR\f3path\fR\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a Java system property\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. +.TP +-I \fIlanguage\fR +.br +Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. +.TP +-e \fIscript\fR +.br +Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the character encoding used to read script files\&. +.TP +-f \fIscript-file\fR +.br +Evaluates the specified script file (batch mode)\&. +.TP +-f - +.br +Reads and evaluates a script from standard input (interactive mode)\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-? +.br +Displays a help message and exits\&. +.TP +-q +.br +Lists all script engines available and exits\&. +.SH ARGUMENTS +If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. +.SH EXAMPLES +.SS EXECUTE\ INLINE\ SCRIPTS +.sp +.nf +\f3jrunscript \-e "print(\&'hello world\&')"\fP +.fi +.nf +\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE +.sp +.nf +\f3jrunscript \-l js \-f test\&.js\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INTERACTIVE\ MODE +.sp +.nf +\f3jrunscript\fP +.fi +.nf +\f3js> print(\&'Hello World\en\&');\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3js> 34 + 55\fP +.fi +.nf +\f389\&.0\fP +.fi +.nf +\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP +.fi +.nf +\f3Thread[Thread\-0,5,main]\fP +.fi +.nf +\f3js> t\&.start()\fP +.fi +.nf +\f3js> Hello World\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3js>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS +The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. +.sp +.nf +\f3jrunscript test\&.js arg1 arg2 arg3\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jsadebugd.1 b/jdk/src/linux/doc/man/jsadebugd.1 index 3d77b1d4113..a559377caff 100644 --- a/jdk/src/linux/doc/man/jsadebugd.1 +++ b/jdk/src/linux/doc/man/jsadebugd.1 @@ -1,109 +1,109 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jsadebugd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jsadebugd.1 +.\" +.if n .pl 99999 +.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jsadebugd \- Serviceability Agent Debug Daemon -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jsadebugd\fP pid [ server\-id ] -.fl -\f3jsadebugd\fP executable core [ server\-id ] -.fl -.fi +.SH NAME +jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -pid -process id of the process to which the debug server should attach. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. At most one instance of the debug server may be attached to a single process. -.TP 3 -executable -Java executable from which the core dump was produced -.TP 3 -core -Core file to which the debug server should attach. -.TP 3 -server\-id -Optional unique id, needed if multiple debug servers are started on the same machine. This ID must be used by remote clients to identify the particular debug server to attach. Within a single machine, this ID must be unique. -.RE +\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] +.fi +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jsadebugd\fP attaches to a Java process or core file and acts as a debug server. Remote clients such as jstack(1), jmap(1), and jinfo(1) can attach to the server using Java Remote Method Invocation (RMI). Before starting \f2jsadebugd\fP, -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi must be started with: -.LP -.nf -\f3 -.fl -\fP\f4rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi.jar\fP\f3 -.fl -\fP -.fi - -.LP -.LP -where \f2$JAVA_HOME\fP is the JDK installation directory. If rmiregistry was not started, jsadebugd will start an rmiregistry in a standard (1099) port internally. Debug server may be stopped by sending SIGINT (pressing Ctrl\-C) to it. -.LP -.LP -\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced. -.LP -.LP -For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jinfo(1) -.TP 2 -o -jmap(1) -.TP 2 -o -jps(1) -.TP 2 -o -jstack(1) -.TP 2 -o -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi -.RE - -.LP - +\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] +.fi +.sp +.TP +\fIpid\fR +The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file to which the debug server should attach\&. +.TP +\fIserver-id\fR +An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. +.SH DESCRIPTION +The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: +.sp +.nf +\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. +.PP +\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jinfo(1) +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstack(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jstack.1 b/jdk/src/linux/doc/man/jstack.1 index e70b10ed5e7..e91f2ef0bbe 100644 --- a/jdk/src/linux/doc/man/jstack.1 +++ b/jdk/src/linux/doc/man/jstack.1 @@ -1,148 +1,138 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstack 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jstack.1 +.\" +.if n .pl 99999 +.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstack \- Stack Trace +.SH NAME +jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the stack trace is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: +.sp +.nf +\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-F .br - -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jstack\fP [ option ] pid -.fl -\f3jstack\fP [ option ] executable core -.fl -\f3jstack\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.LP -Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS. -.LP -.RS 3 -.TP 3 -pid -process id for which the stack trace is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.RE - -.LP -.RS 3 -.TP 3 -executable -Java executable from which the core dump was produced. +Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. +.TP +-l .br -.TP 3 -core -core file for which the stack trace is to be printed. +Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html +.TP +-m .br -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. +Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. +.TP +-h .br -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jstack\fP prints Java stack traces of Java threads for a given Java process or core file or a remote debug server. For each Java frame, the full class name, method name, 'bci' (byte code index) and line number, if available, are printed. With the \-m option, jstack prints both Java and native frames of all threads along with the 'pc' (program counter). For each native frame, the closest native symbol to 'pc', if available, is printed. C++ mangled names are not demangled. To demangle C++ names, the output of this command may be piped to \f3c++filt\fP. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: +Prints a help message\&. +.TP +-help .br - -.LP -.nf -\f3 -.fl -jstack \-J\-d64 \-m pid -.fl -\fP -.fi - -.LP -.LP -\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced. -.LP -.LP -For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-F -Force a stack dump when 'jstack [\-l] pid' does not respond. -.TP 3 -\-l -Long listing. Prints additional information about locks such as list of owned java.util.concurrent -.na -\f2ownable synchronizers\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html. -.TP 3 -\-m -prints mixed mode (both Java and native C/C++ frames) stack trace. -.TP 3 -\-h -prints a help message. -.br -.br -.TP 3 -\-help -prints a help message -.br -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -pstack(1) -.TP 2 -o -c++filt(1) -.TP 2 -o -jps(1) -.TP 2 -o -jsadebugd(1) -.RE - -.LP -.SH "KNOWN BUGS" -.LP -.LP -Mixed mode stack trace, the \-m option, does not work with the remote debug server. -.LP - +Prints a help message\&. +.SH KNOWN\ BUGS +In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pstack(1) +.TP 0.2i +\(bu +C++filt(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jstat.1 b/jdk/src/linux/doc/man/jstat.1 index c83d410bef0..405df264980 100644 --- a/jdk/src/linux/doc/man/jstat.1 +++ b/jdk/src/linux/doc/man/jstat.1 @@ -1,5329 +1,568 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstat 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 10 May 2011 +.\" SectDesc: Monitoring Tools +.\" Title: jstat.1 +.\" +.if n .pl 99999 +.TH jstat 1 "10 May 2011" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstat \- Java Virtual Machine Statistics Monitoring Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jstat\fP [ \f2generalOption\fP | \f2outputOptions\fP \f2vmid\fP [\f2interval\fP[s|ms] [\f2count\fP]] ] -.fl -.fi +.SH NAME +jstat \- Monitors Java Virtual Machine (JVM) statistics\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -generalOption -A single general command\-line option (\-help, \-options, or \-version) -.TP 3 -outputOptions -One or more output options, consisting of a single \f2statOption\fP, plus any of the \-t, \-h, and \-J options. -.TP 3 -vmid -Virtual machine identifier, a string indicating the target Java virtual machine (JVM). The general syntax is -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][//]\fP\f4lvmid\fP[@\f2hostname\fP[:\f2port\fP]/\f2servername\fP] -.fl -.fi -The syntax of the vmid string largely corresponds to the syntax of a URI. The \f2vmid\fP can vary from a simple integer representing a local JVM to a more complex construction specifying a communications protocol, port number, and other implementation\-specific values. See Virtual Machine Identifier for details. -.TP 3 -interval[s|ms] -Sampling interval in the specified units, seconds (s) or milliseconds (ms). Default units are milliseconds. Must be a positive integer. If specified, \f3jstat\fP will produce its output at each interval. -.TP 3 -count -Number of samples to display. Default value is infinity; that is, \f3jstat\fP displays statistics until the target JVM terminates or the \f3jstat\fP command is terminated. Must be a positive integer. -.RE +\fBjstat\fR [ \fIgeneralOption\fR | \fIoutputOptions vmid\fR [ \fIinterval\fR[s|ms] [ \fIcount \fR] ] +.fi +.sp +.TP +\fIgeneralOption\fR +A single general command-line option \f3-help\fR or \f3-options\fR\&. See General Options\&. +.TP +\fIoutputOptions\fR +One or more output options that consist of a single \f3statOption\fR, plus any of the \f3-t\fR, \f3-h\fR, and \f3-J\fR options\&. See Output Options\&. +.TP +\fIvmid\fR +Virtual machine identifier, which is a string that indicates the target JVM\&. The general syntax is the following: +.sp +.nf +\f3[protocol:][//]lvmid[@hostname[:port]/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jstat\fP tool displays performance statistics for an instrumented HotSpot Java virtual machine (JVM). The target JVM is identified by its virtual machine identifier, or \f2vmid\fP option described below. -.LP -.LP -\f3NOTE\fP: This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME. platforms. -.br -.LP -.SS -VIRTUAL MACHINE IDENTIFIER -.LP -.LP -The syntax of the \f2vmid\fP string largely corresponds to the syntax of a URI: -.LP -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][//]\fP\f4lvmid\fP[@\f2hostname\fP][:\f2port\fP][/\f2servername\fP] -.fl -.fi +The syntax of the \f3vmid\fR string corresponds to the syntax of a URI\&. The \f3vmid\fR string can vary from a simple integer that represents a local JVM to a more complex construction that specifies a communications protocol, port number, and other implementation-specific values\&. See Virtual Machine Identifier\&. +.TP +\fIinterval\fR [s|ms] +Sampling interval in the specified units, seconds (s) or milliseconds (ms)\&. Default units are milliseconds\&. Must be a positive integer\&. When specified, the \f3jstat\fR command produces its output at each interval\&. +.TP +\fIcount\fR +Number of samples to display\&. The default value is infinity which causes the \f3jstat\fR command to display statistics until the target JVM terminates or the \f3jstat\fR command is terminated\&. This value must be a positive integer\&. +.SH DESCRIPTION +The \f3jstat\fR command displays performance statistics for an instrumented Java HotSpot VM\&. The target JVM is identified by its virtual machine identifier, or \f3vmid\fR option\&. +.SH VIRTUAL\ MACHINE\ IDENTIFIER +The syntax of the \f3vmid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][//]lvmid[@hostname[:port]/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \fIprotocol\fR value is omitted and a host name is not specified, then the default protocol is a platform-specific optimized local protocol\&. If the \fIprotocol\fR value is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +\fIlvmid\fR +The local virtual machine identifier for the target JVM\&. The \f3lvmid\fR is a platform-specific value that uniquely identifies a JVM on a system\&. The \f3lvmid\fR is the only required component of a virtual machine identifier\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the target JVM process\&. You can use the \f3jps\fR command to determine the \f3lvmid\fR\&. Also, you can determine the \f3lvmid\fR on UNIX platforms with the \f3ps\fR command, and on Windows with the Windows Task Manager\&. +.TP +\fIhostname\fR +A hostname or IP address that indicates the target host\&. If the \fIhostname\fR value is omitted, then the target host is the local host\&. +.TP +\fIport\fR +The default port for communicating with the remote server\&. If the \fIhostname\fR value is omitted or the \fIprotocol\fR value specifies an optimized, local protocol, then the \fIport\fR value is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation-specific\&. For the default \f3rmi\fR protocol, the port value indicates the port number for the rmiregistry on the remote host\&. If the \fIport\fR value is omitted and the \fIprotocol\fR value indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +\fIservername\fR +The treatment of the \f3servername\fR parameter depends on implementation\&. For the optimized local protocol, this field is ignored\&. For the \f3rmi\fR protocol, it represents the name of the RMI remote object on the remote host\&. +.SH OPTIONS +The \f3jstat\fR command supports two types of options, general options and output options\&. General options cause the \f3jstat\fR command to display simple usage and version information\&. Output options determine the content and format of the statistical output\&. +.PP +All options and their functionality are subject to change or removal in future releases\&. +.SS GENERAL\ OPTIONS +If you specify one of the general options, then you cannot specify any other option or parameter\&. +.TP +-help +.br +Displays a help message\&. +.TP +-options +.br +Displays a list of static options\&. See Output Options\&. +.SS OUTPUT\ OPTIONS +If you do not specify a general option, then you can specify output options\&. Output options determine the content and format of the \f3jstat\fR command\&'s output, and consist of a single \f3statOption\fR, plus any of the other output options (\f3-h\fR, \f3-t\fR, and \f3-J\fR)\&. The \f3statOption\fR must come first\&. +.PP +Output is formatted as a table, with columns that are separated by spaces\&. A header row with titles describes the columns\&. Use the \f3-h\fR option to set the frequency at which the header is displayed\&. Column header names are consistent among the different options\&. In general, if two options provide a column with the same name, then the data source for the two columns is the same\&. +.PP +Use the \f3-t\fR option to display a time stamp column, labeled Timestamp as the first column of output\&. The Timestamp column contains the elapsed time, in seconds, since the target JVM started\&. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems\&. +.PP +Use the interval and count parameters to determine how frequently and how many times, respectively, the \f3jstat\fR command displays its output\&. +.PP +\fINote:\fR Do not to write scripts to parse the \f3jstat\fR command\&'s output because the format might change in future releases\&. If you write scripts that parse \f3jstat\fR command output, then expect to modify them for future releases of this tool\&. +.TP +-\fIstatOption\fR +.br +Determines the statistics information the \f3jstat\fR command displays\&. The following lists the available options\&. Use the \f3-options\fR general option to display the list of options for a particular platform installation\&. See Stat Options and Output\&. -.LP -.RS 3 -.TP 3 -protocol -The communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific optimized local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP. -.TP 3 -lvmid -The local virtual machine identifier for the target JVM. The \f2lvmid\fP is a platform\-specific value that uniquely identifies a JVM on a system. The \f2lvmid\fP is the only required component of a virtual machine identifier. The \f2lvmid\fP is typically, but not necessarily, the operating system's process identifier for the target JVM process. You can use the jps(1) command to determine the \f2lvmid\fP. Also, you can determine \f2lvmid\fP on Unix platforms with the \f3ps\fP command, and on Windows with the Windows Task Manager. -.TP 3 -hostname -A hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host. -.TP 3 -port -The default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol, the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used. -.TP 3 -servername -The treatment of this parameter depends on implementation. For the optimized local protocol, this field is ignored. For the \f3rmi\fP protocol, it represents the name of the RMI remote object on the remote host. -.RE +\f3class\fR: Displays statistics about the behavior of the class loader\&. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jstat\fP command supports two types of options, general options and output options. General options cause \f3jstat\fP to display simple usage and version information. Output options determine the content and format of the statistical output. -.br +\f3compiler\fR: Displays statistics about the behavior of the Java HotSpot VM Just-in-Time compiler\&. -.LP -.LP -\f3NOTE\fP: All options, and their functionality are subject to change or removal in future releases. -.LP -.SS -GENERAL OPTIONS -.LP -.LP -If you specify one of the general options, you cannot specify any other option or parameter. -.LP -.RS 3 -.TP 3 -\-help -Display help message. -.TP 3 -\-version -Display version information. -.TP 3 -\-options -Display list of statistics options. See the Output Options section below. -.RE +\f3gc\fR: Displays statistics about the behavior of the garbage collected heap\&. -.LP -.SS -OUTPUT OPTIONS -.LP -.LP -If you do not specify a general option, then you can specify output options. Output options determine the content and format of \f3jstat\fP's output, and consist of a single \f2statOption\fP, plus any of the other output options (\-h, \-t, and \-J). The \f2statOption\fP must come first. -.LP -.LP -Output is formatted as a table, with columns are separated by spaces. A header row with titles describes the columns. Use the \f3\-h\fP option to set the frequency at which the header is displayed. Column header names are generally consistent between the different options. In general, if two options provide a column with the same name, then the data source for the two columns are the same. -.LP -.LP -Use the \f3\-t\fP option to display a time stamp column, labeled \f2Timestamp\fP as the first column of output. The \f2Timestamp\fP column contains the elapsed time, in seconds, since startup of the target JVM. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems. -.LP -.LP -Use the \f2interval\fP and \f2count\fP parameters to determine how frequently and how many times, respectively, \f3jstat\fP displays its output. -.LP -.LP -\f3NOTE\fP: You are advised not to write scripts to parse \f3jstat's\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jstat\fP output, expect to modify them for future releases of this tool. -.LP -.RS 3 -.TP 3 -\-statOption -Determines the statistics information that \f3jstat\fP displays. The following table lists the available options. Use the \f3\-options\fP general option to display the list of options for a particular platform installation. -.br -.br -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics on the behavior of the class loader. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the HotSpot Just\-in\-Time compiler. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the garbage collected heap. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the capacities of the generations and their corresponding spaces. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Summary of garbage collection statistics (same as \f3\-gcutil\fP), with the cause of the last and current (if applicable) garbage collection events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the new generation. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the new generations and its corresponding spaces. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the old and permanent generations. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the old generation. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the permanent generation. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Summary of garbage collection statistics. -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -HotSpot compilation method statistics. -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wclass -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wcompiler -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgc -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgccapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgccause -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcnew -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcnewcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcold -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcoldcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcpermcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcutil -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wprintcompilation -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Displays...\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 215 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Displays...\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'class\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'compiler\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gc\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gccapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gccause\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcnew\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcnewcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcold\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcoldcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcpermcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcutil\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'printcompilation\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-52 -.TP 3 -\-h n -Display a column header every \f2n\fP samples (output rows), where \f2n\fP is a positive integer. Default value is 0, which displays the column header above the first row of data. -.TP 3 -\-t n -Display a timestamp column as the first column of output. The timestamp is the time since the start time of the target JVM. -.TP 3 -\-JjavaOption -Pass \f2javaOption\fP to the \f3java\fP application launcher. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. For a complete list of options, see java(1) -.RE +\f3gccapacity\fR: Displays statistics about the capacities of the generations and their corresponding spaces\&. -.LP -.SS -STATOPTIONS AND OUTPUT -.LP -.LP -The following tables summarize the columns that \f3jstat\fP outputs for each \f2statOption\fP. -.br +\f3gccause\fR: Displays a summary about garbage collection statistics (same as \f3-gcutil\fR), with the cause of the last and current (when applicable) garbage collection events\&. -.LP -.SS -\-class Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of classes unloaded. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of Kbytes unloaded. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Time spent performing class load and unload operations. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wClass Loader Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wLoaded -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBytes -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wUnloaded -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBytes -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTime -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of classes loaded. -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Kbytes loaded. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 261 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Class Loader Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Loaded\h'|\n(41u'Number of classes loaded. -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Bytes\h'|\n(41u'Number of Kbytes loaded. -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Unloaded\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Bytes\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Time\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-21 +\f3gcnew\fR: Displays statistics of the behavior of the new generation\&. -.LP -.SS -\-compiler Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks performed. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks that failed. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks that were invalidated. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Time spent performing compilation tasks. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Compile type of the last failed compilation. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Class name and method for the last failed compilation. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wHotSpot Just\-In\-Time Compiler Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wCompiled -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailed -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wInvalid -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTime -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailedType -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailedMethod -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 297 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'HotSpot Just\-In\-Time Compiler Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Compiled\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Failed\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Invalid\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Time\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FailedType\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FailedMethod\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-29 +\f3gcnewcapacity\fR: Displays statistics about the sizes of the new generations and its corresponding spaces\&. -.LP -.SS -\-gc Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Old space utilization (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization (KB). -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC Events. -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wGarbage\-collected heap statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 367 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Garbage\-collected heap statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(m|u+\n(.Vu -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-63 +\f3gcold\fR: Displays statistics about the behavior of the old generation and Metaspace Statistics\&. -.LP -.SS -\-gccapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum new generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum new generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current new generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum old generation capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum old generation capacity (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old generation capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum permanent generation capacity (KB). -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum Permanent generation capacity (KB). -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current Permanent generation capacity (KB). -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current Permanent space capacity (KB). -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di o+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of Young generation GC Events. -.br -.di -.nr o| \n(dn -.nr o- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wMemory Pool Generation and Space Capacities -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Full GC Events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(o- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 441 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Memory Pool Generation and Space Capacities\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(m|u+\n(.Vu -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(o|u+\n(.Vu -.if (\n(o|+\n(#^-1v)>\n(#- .nr #- +(\n(o|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.o+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of Full GC Events. -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.rm o+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-67 +\f3gcoldcapacity\fR: Displays statistics about the sizes of the old generation\&. -.LP -.SS -\-gccause Option -.LP -.LP -This option displays the same summary of garbage collection statistics as the \f3\-gcutil\fP option, but includes the causes of the last garbage collection event and (if applicable) the current garbage collection event. In addition to the columns listed for \f3\-gcutil\fP, this option adds the following columns: -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Cause of last Garbage Collection. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Cause of current Garbage Collection. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wGarbage Collection Statistics, Including GC Events -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wLGCC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 464 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Garbage Collection Statistics, Including GC Events\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'LGCC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-13 +\f3gcmetacapacity\fR: Displays statistics about the sizes of the metaspace\&. -.LP -.SS -\-gcnew Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum tenuring threshold. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Desired survivor size (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wNew Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wMTT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wDSS -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wTenuring threshold. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 518 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'New Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'TT\h'|\n(41u'Tenuring threshold. -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'MTT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'DSS\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-47 +\f3gcutil\fR: Displays a summary about garbage collection statistics\&. -.LP -.SS -\-gcnewcapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\f3printcompilation\fR: Displays Java HotSpot VM compilation method statistics\&. +.TP +-h \fIn\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum new generation capacity (KB). +Displays a column header every \fIn\fR samples (output rows), where \fIn\fR is a positive integer\&. Default value is 0, which displays the column header the first row of data\&. +.TP +-t .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Display sa timestamp column as the first column of output\&. The time stamp is the time since the start time of the target JVM\&. +.TP +-J\fIjavaOption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum new generation capacity (KB). +Passes \f3javaOption\fR to the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. For a complete list of options, see java(1)\&. +.SS STAT\ OPTIONS\ AND\ OUTPUT +The following information summarizes the columns that the \f3jstat\fR command outputs for each \fIstatOption\fR\&. +.TP +-class \fIoption\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current new generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum survivor space 0 capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum survivor space 1 capacity (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum eden space capacity (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wNew Generation Space Size Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0CMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1CMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wECMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Full GC Events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 572 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'New Generation Space Size Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0CMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1CMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'ECMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of Full GC Events. -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-47 +Class loader statistics\&. -.LP -.SS -\-gcold Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -old space utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wOld and Permanent Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 614 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Old and Permanent Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Loaded\fR: Number of classes loaded\&. -.LP -.SS -\-gcoldcapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum old generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum old generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wOld Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 656 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Old Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Bytes\fR: Number of KBs loaded\&. -.LP -.SS -\-gcpermcapacity Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum permanent generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum permanent generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wPermanent Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 698 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Permanent Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Unloaded\fR: Number of classes unloaded\&. -.LP -.SS -\-gcutil Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization as a percentage of the space's current capacity. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization as a percentage of the space's current capacity. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization as a percentage of the space's current capacity. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Old space utilization as a percentage of the space's current capacity. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization as a percentage of the space's current capacity. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wSummary of Garbage Collection Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0 -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1 -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wE -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wO -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 748 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Summary of Garbage Collection Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'E\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'O\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'P\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-43 +\f3Bytes\fR: Number of Kbytes unloaded\&. -.LP -.SS -\-printcompilation Option -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\f3Time\fR: Time spent performing class loading and unloading operations\&. +.TP +-compiler \fIoption\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks performed. +Java HotSpot VM Just-in-Time compiler statistics\&. + +\f3Compiled\fR: Number of compilation tasks performed\&. + +\f3Failed\fR: Number of compilations tasks failed\&. + +\f3Invalid\fR: Number of compilation tasks that were invalidated\&. + +\f3Time\fR: Time spent performing compilation tasks\&. + +\f3FailedType\fR: Compile type of the last failed compilation\&. + +\f3FailedMethod\fR: Class name and method of the last failed compilation\&. +.TP +-gc \fIoption\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Garbage-collected heap statistics\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3S0U\fR: Survivor space 0 utilization (KB)\&. + +\f3S1U\fR: Survivor space 1 utilization (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3EU\fR: Eden space utilization (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3OU\fR: Old space utilization (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3MU\fR: Metacspace utilization (KB)\&. + +\f3YGC\fR: Number of young generation garbage collection events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gccapacity \fIoption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of bytes of bytecode for the method. +Memory pool generation and space capacities\&. + +\f3NGCMN\fR: Minimum new generation capacity (KB)\&. + +\f3NGCMX\fR: Maximum new generation capacity (KB)\&. + +\f3NGC\fR: Current new generation capacity (KB)\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3OGCMN\fR: Minimum old generation capacity (KB)\&. + +\f3OGCMX\fR: Maximum old generation capacity (KB)\&. + +\f3OGC\fR: Current old generation capacity (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3MCMN\fR: Minimum metaspace capacity (KB)\&. + +\f3MCMX\fR: Maximum metaspace capacity (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3YGC\fR: Number of Young generation GC Events\&. + +\f3FGC\fR: Number of Full GC Events\&. +.TP +-gccause \fIoption\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +This option displays the same summary of garbage collection statistics as the \f3-gcutil\fR option, but includes the causes of the last garbage collection event and (when applicable) the current garbage collection event\&. In addition to the columns listed for \f3-gcutil\fR, this option adds the following columns\&. + +Garbage collection statistics, including garbage collection Events\&. + +\f3LGCC\fR: Cause of last garbage collection\&. + +\f3GCC\fR: Cause of current garbage collection\&. +.TP +-gcnew \fIoption\fR .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Class name and method name identifying the compiled method. Class name uses "/" instead of "." as namespace separator. Method name is the method within the given class. The format for these two fields is consistent with the HotSpot \- \f3XX:+PrintComplation\fP option. +New generation statistics\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3S0U\fR: Survivor space 0 utilization (KB)\&. + +\f3S1U\fR: Survivor space 1 utilization (KB)\&. + +\f3TT\fR: Tenuring threshold\&. + +\f3MTT\fR: Maximum tenuring threshold\&. + +\f3DSS\fR: Desired survivor size (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3EU\fR: Eden space utilization (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. +.TP +-gcnewcapacity \fIoption\fR .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wHotSpot Compiler Method Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wCompiled -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSize -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wType -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wMethod -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wCompilation type. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 774 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'HotSpot Compiler Method Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Compiled\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Size\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Type\h'|\n(41u'Compilation type. -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Method\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-19 +New generation space size statistics\&. -.LP -.SH "EXAMPLES" -.LP -.LP -This section presents some examples of monitoring a local JVM with a \f2lvmid\fP of 21891. -.LP -.SS -Using the gcutil option -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes 7 samples at 250 millisecond intervals and displays the output as specified by the \f3\-gcutil\fP option. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcutil 21891 250 7\fP +NGCMN: Minimum new generation capacity (KB)\&. + +\f3NGCMX\fR: Maximum new generation capacity (KB)\&. + +\f3NGC\fR: Current new generation capacity (KB)\&. + +\f3S0CMX\fR: Maximum survivor space 0 capacity (KB)\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1CMX\fR: Maximum survivor space 1 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3ECMX\fR: Maximum eden space capacity (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of Full GC Events\&. +.TP +-gcold \fIoption\fR .br +old and permanent generation statistics\&. -.fl - S0 S1 E O P YGC YGCT FGC FGCT GCT +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3MU\fR: Metaspace utilization (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3OU\fR: old space utilization (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcoldcapacity \fIoption\fR .br +Old generation statistics\&. -.fl - 12.44 0.00 27.20 9.49 96.70 78 0.176 5 0.495 0.672 +\f3OGCMN\fR: Minimum old generation capacity (KB)\&. + +\f3OGCMX\fR: Maximum old generation capacity (KB)\&. + +\f3OGC\fR: Current old generation capacity (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcmetacapacity \fIoption\fR .br +Permanent generation statistics\&. -.fl - 12.44 0.00 62.16 9.49 96.70 78 0.176 5 0.495 0.672 +\f3MCMN\fR: Minimum metaspace capacity (KB)\&. + +\f3MCMX\fR: Maximum metaspace capacity (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcutil \fIoption\fR .br +Summary of garbage collection statistics\&. -.fl - 12.44 0.00 83.97 9.49 96.70 78 0.176 5 0.495 0.672 +\f3S0\fR: Survivor space 0 utilization as a percentage of the space\&'s current capacity\&. + +\f3S1\fR: Survivor space 1 utilization as a percentage of the space\&'s current capacity\&. + +\f3E\fR: Eden space utilization as a percentage of the space\&'s current capacity\&. + +\f3O\fR: Old space utilization as a percentage of the space\&'s current capacity\&. + +\f3M\fR: Metaspace utilization as a percentage of the space\&'s current capacity\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-printcompilation \fIoption\fR .br +Java HotSpot VM compiler method statistics\&. -.fl - 0.00 7.74 0.00 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Compiled\fR: Number of compilation tasks performed by the most recently compiled method\&. -.fl - 0.00 7.74 23.37 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Size\fR: Number of bytes of byte code of the most recently compiled method\&. -.fl - 0.00 7.74 43.82 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Type\fR: Compilation type of the most recently compiled method\&. -.fl - 0.00 7.74 58.11 9.51 96.71 79 0.177 5 0.495 0.673 -.br - -.fl -.fi - -.LP -.LP -The output of this example shows that a young generation collection occurred between the 3rd and 4th sample. The collection took 0.001 seconds and promoted objects from the eden space (E) to the old space (O), resulting in an increase of old space utilization from 9.49% to 9.51%. Before the collection, the survivor space was 12.44% utilized, but after this collection it is only 7.74% utilized. -.LP -.SS -Repeating the column header string -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes samples at 250 millisecond intervals and displays the output as specified by \f3\-gcutil\fP option. In addition, it uses the \f3\-h3\fP option to output the column header after every 3 lines of data. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcnew \-h3 21891 250\fP -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 0.0 31.7 31 31 32.0 512.0 178.6 249 0.203 -.br - -.fl - 64.0 64.0 0.0 31.7 31 31 32.0 512.0 355.5 249 0.203 -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 21.9 250 0.204 -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 245.9 250 0.204 -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 421.1 250 0.204 -.br - -.fl - 64.0 64.0 0.0 19.0 31 31 32.0 512.0 84.4 251 0.204 -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 0.0 19.0 31 31 32.0 512.0 306.7 251 0.204 -.br - -.fl -.fi - -.LP -.LP -In addition to showing the repeating header string, this example shows that between the 2nd and 3rd samples, a young GC occurred. Its duration was 0.001 seconds. The collection found enough live data that the survivor space 0 utilization (S0U) would would have exceeded the desired survivor Size (DSS). As a result, objects were promoted to the old generation (not visible in this output), and the tenuring threshold (TT) was lowered from 31 to 2. -.LP -.LP -Another collection occurs between the 5th and 6th samples. This collection found very few survivors and returned the tenuring threshold to 31. -.LP -.SS -Including a time stamp for each sample -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes 3 samples at 250 millisecond intervals. The \f3\-t\fP option is used to generate a time stamp for each sample in the first column. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcoldcapacity \-t 21891 250 3\fP -.br - -.fl -Timestamp OGCMN OGCMX OGC OC YGC FGC FGCT GCT -.br - -.fl - 150.1 1408.0 60544.0 11696.0 11696.0 194 80 2.874 3.799 -.br - -.fl - 150.4 1408.0 60544.0 13820.0 13820.0 194 81 2.938 3.863 -.br - -.fl - 150.7 1408.0 60544.0 13820.0 13820.0 194 81 2.938 3.863 -.br - -.fl -.fi - -.LP -.LP -The \f2Timestamp\fP column reports the elapsed time in seconds since the start of the target JVM. In addition, the \f3\-gcoldcapacity\fP output shows the old generation capacity (OGC) and the old space capacity (OC) increasing as the heap expands to meet allocation and/or promotion demands. The old generation capacity (OGC) has grown to from 11696 KB to 13820 KB after the 81st Full GC (FGC). The maximum capacity of the generation (and space) is 60544 KB (OGCMX), so it still has room to expand. -.LP -.SS -Monitor instrumentation for a remote JVM -.LP -.LP -This example attaches to \f2lvmid\fP 40496 on the system named \f2remote.domain\fP using the \f3\-gcutil\fP option, with samples taken every second indefinitely. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcutil 40496@remote.domain 1000\fP -.br - -.fl -... \f2output omitted\fP -.br - -.fl -.fi - -.LP -.LP -The \f2lvmid\fP is combined with the name of the remote host to construct a \f2vmid\fP of \f240496@remote.domain\fP. This \f2vmid\fP results in the use of the \f3rmi\fP protocol to communicate to the default \f3jstatd\fP server on the remote host. The \f3jstatd\fP server is located using the \f3rmiregistry\fP on \f2remote.domain\fP that is bound to the default \f3rmiregistry\fP port (port 1099). -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jps(1) \- the Java Process Status Application -.TP 2 -o -jstatd(1) \- the jvmstat daemon -.TP 2 -o -rmiregistry(1) \- the Java Remote Object Registry -.RE - -.LP - +\f3Method\fR: Class name and method name identifying the most recently compiled method\&. Class name uses slash (/) instead of dot (\&.) as a name space separator\&. Method name is the method within the specified class\&. The format for these two fields is consistent with the HotSpot \f3-XX:+PrintComplation\fR option\&. +.SH EXAMPLES +This section presents some examples of monitoring a local JVM with an \fIlvmid\fR of 21891\&. +.SS THE\ GCUTIL\ OPTION +This example attaches to lvmid 21891 and takes 7 samples at 250 millisecond intervals and displays the output as specified by the -\f3gcutil\fR option\&. +.PP +The output of this example shows that a young generation collection occurred between the third and fourth sample\&. The collection took 0\&.001 seconds and promoted objects from the eden space (E) to the old space (O), resulting in an increase of old space utilization from 9\&.49% to 9\&.51%\&. Before the collection, the survivor space was 12\&.44% utilized, but after this collection it is only 7\&.74% utilized\&. +.sp +.nf +\f3jstat \-gcutil 21891 250 7\fP +.fi +.nf +\f3 S0 S1 E O M YGC YGCT FGC FGCT GCT\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS REPEAT\ THE\ COLUMN\ HEADER\ STRING +This example attaches to lvmid 21891 and takes samples at 250 millisecond intervals and displays the output as specified by \f3-gcutil\fR option\&. In addition, it uses the \f3-h3\fR option to output the column header after every 3 lines of data\&. +.PP +In addition to showing the repeating header string, this example shows that between the second and third samples, a young GC occurred\&. Its duration was 0\&.001 seconds\&. The collection found enough active data that the survivor space 0 utilization (S0U) would have exceeded the desired survivor Size (DSS)\&. As a result, objects were promoted to the old generation (not visible in this output), and the tenuring threshold (TT) was lowered from 31 to 2\&. +.PP +Another collection occurs between the fifth and sixth samples\&. This collection found very few survivors and returned the tenuring threshold to 31\&. +.sp +.nf +\f3jstat \-gcnew \-h3 21891 250\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 31\&.7 31 31 32\&.0 512\&.0 178\&.6 249 0\&.203\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 31\&.7 31 31 32\&.0 512\&.0 355\&.5 249 0\&.203\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 21\&.9 250 0\&.204\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 245\&.9 250 0\&.204\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 421\&.1 250 0\&.204\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 19\&.0 31 31 32\&.0 512\&.0 84\&.4 251 0\&.204\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 19\&.0 31 31 32\&.0 512\&.0 306\&.7 251 0\&.204\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INCLUDE\ A\ TIME\ STAMP\ FOR\ EACH\ SAMPLE +This example attaches to lvmid 21891 and takes 3 samples at 250 millisecond intervals\&. The \f3-t\fR option is used to generate a time stamp for each sample in the first column\&. +.PP +The Timestamp column reports the elapsed time in seconds since the start of the target JVM\&. In addition, the \f3-gcoldcapacity\fR output shows the old generation capacity (OGC) and the old space capacity (OC) increasing as the heap expands to meet allocation or promotion demands\&. The old generation capacity (OGC) has grown to from 11,696 KB to 13820 KB after the eighty-first full garbage collection (FGC)\&. The maximum capacity of the generation (and space) is 60,544 KB (OGCMX), so it still has room to expand\&. +.sp +.nf +\f3Timestamp OGCMN OGCMX OGC OC YGC FGC FGCT GCT\fP +.fi +.nf +\f3 150\&.1 1408\&.0 60544\&.0 11696\&.0 11696\&.0 194 80 2\&.874 3\&.799\fP +.fi +.nf +\f3 150\&.4 1408\&.0 60544\&.0 13820\&.0 13820\&.0 194 81 2\&.938 3\&.863\fP +.fi +.nf +\f3 150\&.7 1408\&.0 60544\&.0 13820\&.0 13820\&.0 194 81 2\&.938 3\&.863\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS MONITOR\ INSTRUMENTATION\ FOR\ A\ REMOTE\ JVM +This example attaches to lvmid 40496 on the system named remote\&.domain using the \f3-gcutil\fR option, with samples taken every second indefinitely\&. +.PP +The lvmid is combined with the name of the remote host to construct a \fIvmid\fR of \f340496@remote\&.domain\fR\&. This vmid results in the use of the \f3rmi\fR protocol to communicate to the default \f3jstatd\fR server on the remote host\&. The \f3jstatd\fR server is located using the rmiregistry on \f3remote\&.domain\fR that is bound to the default rmiregistry port (port 1099)\&. +.sp +.nf +\f3jstat \-gcutil 40496@remote\&.domain 1000\fP +.fi +.nf +\f3\fI\&.\&.\&. output omitted\fR\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/jstatd.1 b/jdk/src/linux/doc/man/jstatd.1 index fd9b0f7b1e2..8db6e9678a2 100644 --- a/jdk/src/linux/doc/man/jstatd.1 +++ b/jdk/src/linux/doc/man/jstatd.1 @@ -1,257 +1,210 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstatd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jstatd.1 +.\" +.if n .pl 99999 +.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstatd \- Virtual Machine jstat Daemon -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -jstatd [ \fP\f4options\fP\f3 ]\fP +.SH NAME +jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstatd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. +.PP +The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. +.SH OPTIONS +.TP +-nr .br -\f3 -.fl -\fP -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Command\-line options. The options may be in any order. If there are redundant or contradictory options, the last option specified will take precedence. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jstatd\fP tool is an RMI server application that monitors for the creation and termination of instrumented HotSpot Java virtual machines (JVMs) and provides a interface to allow remote monitoring tools to attach to JVMs running on the local host. -.LP -.LP -The \f3jstatd\fP server requires the presence of an RMI registry on the local host. The \f3jstatd\fP server will attempt to attach to the RMI registry on the default port, or on the port indicated by the \f2\-p port\fP option. If an RMI registry is not found, one will be created within the \f3jstatd\fP application bound to the port indicated by the \f2\-p port\fP option or to the default RMI registry port if \f2\-p port\fP is omitted. Creation of an internal RMI registry can be inhibited by specifying the \f2\-nr\fP option. -.LP -.LP -\f3NOTE:\fP This utility is unsupported and may or may not be available in future versions of the JDK. It is not currently available on the Windows 98 and Windows ME platforms. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jstatd\fP command supports the following options: -.LP -.RS 3 -.TP 3 -\-nr -Do not attempt to create an internal RMI registry within the \f2jstatd\fP process when an existing RMI registry is not found. -.TP 3 -\-p\ port -Port number where the RMI registry is expected to be found, or, if not found, created if \f2\-nr\fP is not specified. -.TP 3 -\-n\ rminame -Name to which the remote RMI object is bound in the RMI registry. The default name is \f2JStatRemoteHost\fP. If multiple \f3jstatd\fP servers are started on the same host, the name of the exported RMI object for each server can be made unique by specifying this option. However, doing so will require that the unique server name be included in the monitoring client's \f2hostid\fP and \f2vmid\fP strings. -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.RE - -.LP -.SH "SECURITY" -.LP -.LP -The \f3jstatd\fP server can only monitor JVMs for which it has the appropriate native access permissions. Therefor the \f3jstatd\fP process must be running with the same user credentials as the target JVMs. Some user credentials, such as the \f2root\fP user in UNIX(TM) based systems, have permission to access the instrumentation exported by any JVM on the system. A \f3jstatd\fP process running with such credentials can monitor any JVM on the system, but introduces additional security concerns. -.LP -.LP -The \f3jstatd\fP server does not provide any authentication of remote clients. Therefore, running a \f3jstatd\fP server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fP process has access permissions to any user on the network. This exposure may be undesireable in your environment and local security policies should be considered before starting the \f3jstatd\fP process, particularly in production environments or on unsecure networks. -.LP -.LP -The \f3jstatd\fP server installs an instance of RMISecurityPolicy if no other security manager has been installed and therefore requires a security policy file to be specified. The policy file must conform to the default policy implementation's -.na -\f2Policy File Syntax\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html. -.LP -.LP -The following policy file will allow the \f3jstatd\fP server to run without any security exceptions. This policy is less liberal then granting all permissions to all codebases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fP server. -.LP -.nf -\f3 -.fl -grant codebase "file:${java.home}/../lib/tools.jar" {\fP +Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. +.TP +-p \fIport\fR .br -\f3 -.fl - permission java.security.AllPermission;\fP +The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. +.TP +-n \fIrminame\fR .br -\f3 -.fl -};\fP +Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. +.TP +-J\fIoption\fR .br -\f3 -.fl -\fP -.fi - -.LP -.LP -To use this policy, copy the text into a file called \f2jstatd.all.policy\fP and run the \f3jstatd\fP server as follows: -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=jstatd.all.policy\fP -.br -\f3 -.fl -\fP -.fi - -.LP -.LP -For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP addreess spoofing attacks. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fP server and use the \f3jstat\fP and \f3jps\fP tools locally. -.LP -.SH "REMOTE INTERFACE" -.LP -.LP -The interface exported by the \f3jstatd\fP process is proprietary and is guaranteed to change. Users and developers are discouraged from writing to this interface. -.LP -.SH "EXAMPLES" -.LP -.LP -Here are some examples of starting \f3jstatd\fP. Note that the \f3jstatd\fP scripts automatically start the server in the background. -.LP -.SS -Using Internal RMI Registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an internal RMI registry. This example assumes that no other server is bound to the default RMI Registry port (port 1099). -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy -.fl -\fP -.fi - -.LP -.SS -Using External RMI Registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP with a external RMI registry. -.LP -.nf -\f3 -.fl -rmiregistry& -.fl -jstatd \-J\-Djava.security.policy=all.policy -.fl -\fP -.fi - -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an external RMI registry server on port 2020. -.LP -.nf -\f3 -.fl -rmiregistry 2020& -.fl -jstatd \-J\-Djava.security.policy=all.policy \-p 2020 -.fl -\fP -.fi - -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an external RMI registry on port 2020, bound to name AlternateJstatdServerName. -.LP -.nf -\f3 -.fl -rmiregistry 2020& -.fl -jstatd \-J\-Djava.security.policy=all.policy \-p 2020 \-n AlternateJstatdServerName -.fl -\fP -.fi - -.LP -.SS -Inhibiting creation of an in\-process RMI registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP such that it will not create a RMI registry if one is not found. This example assumes an RMI registry is already running. If it is not, an appropriate error message is emitted. -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy \-nr -.fl -\fP -.fi - -.LP -.SS -Enabling RMI logging capabilities. -.LP -.LP -This example demonstrates starting \f3jstatd\fP with RMI logging capabilities enabled. This technique is useful as a troubleshooting aid or for monitoring server activities. -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy \-J\-Djava.rmi.server.logCalls=true -.fl -\fP -.fi - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jps(1) \- the Java Process Status Application -.TP 2 -o -jstat(1) \- the Java Virtual Machine Statistics Monitoring Tool -.TP 2 -o -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry -.RE - -.LP - +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SECURITY +The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. +.PP +The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. +.PP +The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.PP +The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. +.sp +.nf +\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP +.fi +.nf +\f3 permission java\&.security\&.AllPermission;\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp +To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. +.SH REMOTE\ INTERFACE +The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. +.SH EXAMPLES +The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background +.SS INTERNAL\ RMI\ REGISTRY +This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXTERNAL\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session with a external RMI registry\&. +.sp +.nf +\f3rmiregistry&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. +.sp +.nf +\f3jrmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. +.sp +.nf +\f3rmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3 \-n AlternateJstatdServerName\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS ENABLE\ RMI\ LOGGING +This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/keytool.1 b/jdk/src/linux/doc/man/keytool.1 index 528f4a5fe57..72758893e3a 100644 --- a/jdk/src/linux/doc/man/keytool.1 +++ b/jdk/src/linux/doc/man/keytool.1 @@ -1,1765 +1,1300 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH keytool 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 6 August 2013 +.\" SectDesc: Security Tools +.\" Title: keytool.1 +.\" +.if n .pl 99999 +.TH keytool 1 "6 August 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -keytool \- Key and Certificate Management Tool -.LP -.LP -Manages a keystore (database) of cryptographic keys, X.509 certificate chains, and trusted certificates. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3keytool\fP [ commands ] -.fl -.fi +.SH NAME +keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -The keytool command interface has changed in Java SE 6. See the Changes Section for a detailed description. Note that previously defined commands are still supported. -.LP -.SH "DESCRIPTION" -.LP -\f3keytool\fP is a key and certificate management utility. It allows users to administer their own public/private key pairs and associated certificates for use in self\-authentication (where the user authenticates himself/herself to other users/services) or data integrity and authentication services, using digital signatures. It also allows users to cache the public keys (in the form of certificates) of their communicating peers. -.LP -A \f2certificate\fP is a digitally signed statement from one entity (person, company, etc.), saying that the public key (and some other information) of some other entity has a particular value. (See Certificates.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity. \f2Integrity\fP means that the data has not been modified or tampered with, and \f2authenticity\fP means the data indeed comes from whoever claims to have created and signed it. -.LP -.LP -\f3keytool\fP also enables users to administer secret keys used in symmetric encryption/decryption (e.g. DES). -.LP -.LP -\f3keytool\fP stores the keys and certificates in a \f2keystore\fP. -.LP -.SH "COMMAND AND OPTION NOTES" -.LP -.LP -The various commands and their options are listed and described below. Note: -.LP -.RS 3 -.TP 2 -o -All command and option names are preceded by a minus sign (\-). -.TP 2 -o -The options for each command may be provided in any order. -.TP 2 -o -All items not italicized or in braces or square brackets are required to appear as is. -.TP 2 -o -Braces surrounding an option generally signify that a default value will be used if the option is not specified on the command line. Braces are also used around the \f2\-v\fP, \f2\-rfc\fP, and \f2\-J\fP options, which only have meaning if they appear on the command line (that is, they don't have any "default" values other than not existing). -.TP 2 -o -Brackets surrounding an option signify that the user is prompted for the value(s) if the option is not specified on the command line. (For a \f2\-keypass\fP option, if you do not specify the option on the command line, \f3keytool\fP will first attempt to use the keystore password to recover the private/secret key, and if this fails, will then prompt you for the private/secret key password.) -.TP 2 -o -Items in italics (option values) represent the actual values that must be supplied. For example, here is the format of the \f2\-printcert\fP command: -.nf -\f3 -.fl - keytool \-printcert {\-file \fP\f4cert_file\fP\f3} {\-v} -.fl -\fP -.fi -.LP -When specifying a \f2\-printcert\fP command, replace \f2cert_file\fP with the actual file name, as in: -.nf -\f3 -.fl - keytool \-printcert \-file VScert.cer -.fl -\fP -.fi -.TP 2 -o -Option values must be quoted if they contain a blank (space). -.TP 2 -o -The \f2\-help\fP command is the default. Thus, the command line -.nf -\f3 -.fl - keytool -.fl -\fP -.fi -.LP -is equivalent to -.nf -\f3 -.fl - keytool \-help -.fl -\fP -.fi -.RE +\fBkeytool\fR [\fIcommands\fR] +.fi +.sp +.TP +\fIcommands\fR +See Commands\&. These commands are categorized by task as follows: +.RS +.TP 0.2i +\(bu +Create or Add Data to the Keystore +.RS +.TP 0.2i +\(bu +-gencert +.TP 0.2i +\(bu +-genkeypair +.TP 0.2i +\(bu +-genseckey +.TP 0.2i +\(bu +-importcert +.TP 0.2i +\(bu +-importpassword +.RE -.LP -.SS -Option Defaults -.LP -.LP -Below are the defaults for various option values. -.LP -.nf -\f3 -.fl -\-alias "mykey" -.fl +.TP 0.2i +\(bu +Import Contents From Another Keystore +.RS +.TP 0.2i +\(bu +-importkeystore +.RE -.fl -\-keyalg -.fl - "DSA" (when using \fP\f3\-genkeypair\fP\f3) -.fl - "DES" (when using \fP\f3\-genseckey\fP\f3) -.fl +.TP 0.2i +\(bu +Generate Certificate Request +.RS +.TP 0.2i +\(bu +-certreq +.RE -.fl -\-keysize -.fl - 2048 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "RSA") -.fl - 1024 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "DSA") -.fl - 256 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "EC") -.fl - 56 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DES") -.fl - 168 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DESede") -.fl +.TP 0.2i +\(bu +Export Data +.RS +.TP 0.2i +\(bu +-exportcert +.RE -.fl +.TP 0.2i +\(bu +Display Data +.RS +.TP 0.2i +\(bu +-list +.TP 0.2i +\(bu +-printcert +.TP 0.2i +\(bu +-printcertreq +.TP 0.2i +\(bu +-printcrl +.RE -.fl -\-validity 90 -.fl +.TP 0.2i +\(bu +Manage the Keystore +.RS +.TP 0.2i +\(bu +-storepasswd +.TP 0.2i +\(bu +-keypasswd +.TP 0.2i +\(bu +-delete +.TP 0.2i +\(bu +-changealias +.RE -.fl -\-keystore the file named \fP\f4.keystore\fP\f3 in the user's home directory -.fl +.TP 0.2i +\(bu +Get Help +.RS +.TP 0.2i +\(bu +-help +.RE -.fl -\-storetype the value of the "keystore.type" property in the security properties file, -.fl - which is returned by the static \fP\f4getDefaultType\fP\f3 method in -.fl - \fP\f4java.security.KeyStore\fP\f3 -.fl +.RE -.fl -\-file stdin if reading, stdout if writing -.fl +.SH DESCRIPTION +The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. +.PP +A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. +.PP +The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. +.PP +The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. +.SH COMMAND\ AND\ OPTION\ NOTES +See Commands for a listing and description of the various commands\&. +.TP 0.2i +\(bu +All command and option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options for each command can be provided in any order\&. +.TP 0.2i +\(bu +All items not italicized or in braces or brackets are required to appear as is\&. +.TP 0.2i +\(bu +Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. +.TP 0.2i +\(bu +Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. +.TP 0.2i +\(bu +Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: -.fl -\-protected false -.fl -\fP -.fi +\f3keytool -printcert {-file cert_file} {-v}\fR -.LP -.LP -In generating a public/private key pair, the signature algorithm (\f2\-sigalg\fP option) is derived from the algorithm of the underlying private key: -.LP -.RS 3 -.TP 2 -o -If the underlying private key is of type "DSA", the \f2\-sigalg\fP option defaults to "SHA1withDSA" -.TP 2 -o -If the underlying private key is of type "RSA", the \f2\-sigalg\fP option defaults to "SHA256withRSA". -.TP 2 -o -If the underlying private key is of type "EC", the \f2\-sigalg\fP option defaults to "SHA256withECDSA". -.RE - -.LP -.LP -Please consult the -.na -\f2Java Cryptography Architecture API Specification & Reference\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA for a full list of \f2\-keyalg\fP and \f2\-sigalg\fP you can choose from. -.LP -.SS -Common Options -.LP -.LP -The \f2\-v\fP option can appear for all commands except \f2\-help\fP. If it appears, it signifies "verbose" mode; more information will be provided in the output. -.LP -.LP -There is also a \f2\-J\fP\f2javaoption\fP option that may appear for any command. If it appears, the specified \f2javaoption\fP string is passed through directly to the Java interpreter. This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line. -.LP -.LP -These options may appear for all commands operating on a keystore: -.LP -.RS 3 -.TP 3 -\-storetype storetype -.LP -This qualifier specifies the type of keystore to be instantiated. -.TP 3 -\-keystore keystore -.LP -The keystore location. -.LP -If the JKS storetype is used and a keystore file does not yet exist, then certain \f3keytool\fP commands may result in a new keystore file being created. For example, if \f2keytool \-genkeypair\fP is invoked and the \f2\-keystore\fP option is not specified, the default keystore file named \f2.keystore\fP in the user's home directory will be created if it does not already exist. Similarly, if the \f2\-keystore \fP\f2ks_file\fP option is specified but \f2ks_file\fP does not exist, then it will be created -.LP -Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based (for example, if it resides on a hardware token device). -.TP 3 -\-storepass[:env|:file] argument -.LP -The password which is used to protect the integrity of the keystore. -.LP -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP, which must be at least 6 characters long. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -.LP -\f3Note\fP: All other options that require passwords, such as \f2\-keypass\fP, \f2\-srckeypass\fP, \f2\-destkeypass\fP \f2\-srcstorepass\fP, and \f2\-deststorepass\fP, accept the \f2env\fP and \f2file\fP modifiers. (Remember to separate the password option and the modifier with a colon, (\f2:\fP).) -.LP -The password must be provided to all commands that access the keystore contents. For such commands, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for it. -.LP -When retrieving information from the keystore, the password is optional; if no password is given, the integrity of the retrieved information cannot be checked and a warning is displayed. -.TP 3 -\-providerName provider_name -.LP -Used to identify a cryptographic service provider's name when listed in the security properties file. -.TP 3 -\-providerClass provider_class_name -.LP -Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file. -.TP 3 -\-providerArg provider_arg -.LP -Used in conjunction with \f2\-providerClass\fP. Represents an optional string input argument for the constructor of \f2provider_class_name\fP. -.TP 3 -\-protected -.LP -Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader. -.LP -Note: Since there are two keystores involved in \f2\-importkeystore\fP command, two options, namely, \f2\-srcprotected\fP and \f2\-destprotected\fP are provided for the source keystore and the destination keystore respectively. -.TP 3 -\-ext {name{:critical}{=value}} -.LP -Denotes an X.509 certificate extension. The option can be used in \-genkeypair and \-gencert to embed extensions into the certificate generated, or in \f2\-certreq\fP to show what extensions are requested in the certificate request. The option can appear multiple times. name can be a supported extension name (see below) or an arbitrary OID number. value, if provided, denotes the parameter for the extension; if omitted, denotes the default value (if defined) of the extension or the extension requires no parameter. The \f2:critical\fP modifier, if provided, means the extension's isCritical attribute is true; otherwise, false. You may use \f2:c\fP in place of \f2:critical\fP. -.RE - -.LP -.LP -Currently keytool supports these named extensions (case\-insensitive): -.LP -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +When you specify a \f3-printcert\fR command, replace \f3cert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR +.TP 0.2i +\(bu +Option values must be put in quotation marks when they contain a blank (space)\&. +.TP 0.2i +\(bu +The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. +.SH OPTION\ DEFAULTS +The following examples show the defaults for various option values\&. +.sp +.nf +\f3\-alias "mykey"\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keyalg\fP +.fi +.nf +\f3 "DSA" (when using \-genkeypair)\fP +.fi +.nf +\f3 "DES" (when using \-genseckey)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keysize\fP +.fi +.nf +\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP +.fi +.nf +\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP +.fi +.nf +\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP +.fi +.nf +\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP +.fi +.nf +\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-validity 90\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-storetype <the value of the "keystore\&.type" property in the\fP +.fi +.nf +\f3 security properties file, which is returned by the static\fP +.fi +.nf +\f3 getDefaultType method in java\&.security\&.KeyStore>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-file\fP +.fi +.nf +\f3 stdin (if reading)\fP +.fi +.nf +\f3 stdout (if writing)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-protected false\fP +.fi +.nf +\f3\fP +.fi +.sp +In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: +.TP 0.2i +\(bu +If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. +.PP +For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA +.SH COMMON\ OPTIONS +The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. +.PP +There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.PP +These options can appear for all commands operating on a keystore: +.TP +-storetype \fIstoretype\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -The full form: "ca:{true|false}[,pathlen:<len>]"; or, <len>, a shorthand for "ca:true,pathlen:<len>"; or omitted, means "ca:true" +This qualifier specifies the type of keystore to be instantiated\&. +.TP +-keystore \fIkeystore\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +The keystore location\&. + +If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. + +Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. +.TP +-storepass[:\fIenv\fR| :\fIfile\fR] argument .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -usage(,usage)*, usage can be one of digitalSignature, nonRepudiation (contentCommitment), keyEncipherment, dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly, decipherOnly. Usage can be abbreviated with the first few letters (say, dig for digitalSignature) or in camel\-case style (say, dS for digitalSignature, cRLS for cRLSign), as long as no ambiguity is found. Usage is case\-insensitive. +The password that is used to protect the integrity of the keystore\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named argument\&. +.RE + + +\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. + +The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. + +When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. +.TP +-providerName \fIprovider_name\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. +.TP +-providerClass \fIprovider_class_name\fR .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -usage(,usage)*, usage can be one of anyExtendedKeyUsage, serverAuth, clientAuth, codeSigning, emailProtection, timeStamping, OCSPSigning, or any OID string. Named usage can be abbreviated with the first few letters or in camel\-case style, as long as no ambiguity is found. Usage is case\-insensitive. +Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. +.TP +-providerArg \fIprovider_arg\fR .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 +Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. +.TP +-protected .br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. +.TP +-ext \fI{name{:critical} {=value}}\fR +.br +Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. +.SH NAMED\ EXTENSIONS +The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. +.TP +BC or BasicContraints +\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. +.TP +KU or KeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +EKU or ExtendedKeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP SAN or SubjectAlternativeName -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -type:value(,type:value)*, type can be EMAIL, URI, DNS, IP, or OID, value is the string format value for the type. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. +.TP IAN or IssuerAlternativeName -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -same as SubjectAlternativeName -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -method:location\-type:location\-value (,method:location\-type:location\-value)*, method can be "timeStamping", "caRepository" or any OID. location\-type and location\-value can be any type:value supported by the SubjectAlternativeName extension. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. +.TP +SIA or SubjectInfoAccess +\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. +.TP AIA or AuthorityInfoAccess +\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. +.PP +When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. +.PP +A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. +.PP +If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. +.PP +The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. +.PP +\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. +.SH COMMANDS +.TP +-gencert .br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 +\f3{-rfc} {-infile infile} {-outfile outfile} {-alias alias} {-sigalg sigalg} {-dname dname} {-startdate startdate {-ext ext}* {-validity valDays} [-keypass keypass] {-keystore keystore} [-storepass storepass] {-storetype storetype} {-providername provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. + +When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. + +The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. + +The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. + +The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: +.sp +.nf +\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: +.sp +.nf +\f3keytool \-alias ca1 \-certreq |\fP +.fi +.nf +\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP +.fi +.nf +\f3 keytool \-alias ca1 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-alias ca2 \-certreq |\fP +.fi +.nf +\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP +.fi +.nf +\f3 $KT \-alias ca2 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: +.sp +.nf +\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-genkeypair .br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -same as SubjectInfoAccess. method can be "ocsp","caIssuers" or any OID. +\f3{-alias alias} {-keyalg keyalg} {-keysize keysize} {-sigalg sigalg} [-dname dname] [-keypass keypass] {-startdate value} {-ext ext}* {-validity valDays} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. + +The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. + +The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. + +The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. + +The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. + +The option value can be set in one of these two forms: + +\f3([+-]nnn[ymdHMS])+\fR + +\f3[yyyy/mm/dd] [HH:MM:SS]\fR + +With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: +.sp +.nf +\f3Calendar c = new GregorianCalendar();\fP +.fi +.nf +\f3c\&.add(Calendar\&.YEAR, \-1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.MONTH, 1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.DATE, \-1);\fP +.fi +.nf +\f3return c\&.getTime()\fP +.fi +.nf +\f3\fP +.fi +.sp + + +With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. + +When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. + +The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. + +This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. +.TP +-genseckey .br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Name\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBC or BasicConstraints -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wKU or KeyUsage -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEKU or ExtendedkeyUsage -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSIA or SubjectInfoAccess -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(f- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(i- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Value\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 319 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Name\fP\h'|\n(41u'\f3Value\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'BC or BasicConstraints\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'KU or KeyUsage\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EKU or ExtendedkeyUsage\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.ne \n(g|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'SIA or SubjectInfoAccess\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.ne \n(j|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-38 +\f3-genseckey {-alias alias} {-keyalg keyalg} {-keysize keysize} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -For name as OID, value is the HEX dumped DER encoding of the extnValue for the extension excluding the OCTET STRING type and length bytes. Any extra character other than standard HEX numbers (0\-9, a\-f, A\-F) are ignored in the HEX string. Therefore, both \f2"01:02:03:04"\fP and \f2"01020304"\fP are accepted as identical values. If there's no value, the extension has an empty value field then. -.LP -.LP -A special name \f2'honored'\fP, used in \f2\-gencert\fP only, denotes how the extensions included in the certificate request should be honored. The value for this name is a comma separated list of \f2"all"\fP (all requested extensions are honored), \f2"name{:[critical|non\-critical]}"\fP (the named extension is honored, but using a different isCritical attribute) and \f2"\-name"\fP (used with all, denotes an exception). Requested extensions are not honored by default. -.LP -.LP -If, besides the \-ext honored option, another named or OID \-ext option is provided, this extension will be added to those already honored. However, if this name (or OID) also appears in the honored value, its value and criticality overrides the one in the request. -.LP -.LP -The subjectKeyIdentifier extension is always created. For non self\-signed certificates, the authorityKeyIdentifier is always created. -.LP -.LP -\f3Note:\fP Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard. See Warning Regarding Certificate Conformance for details. -.LP -.SH "COMMANDS" -.LP -.SS -Creating or Adding Data to the Keystore -.LP -.RS 3 -.TP 3 -\-gencert {\-rfc} {\-infile infile} {\-outfile outfile} {\-alias alias} {\-sigalg sigalg} {\-dname dname} {\-startdate startdate {\-ext ext}* {\-validity valDays} [\-keypass keypass] {\-keystore keystore} [\-storepass storepass] {\-storetype storetype} {\-providername provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a certificate as a response to a certificate request file (which can be created by the \f2keytool \-certreq\fP command). The command reads the request from \f2infile\fP (if omitted, from the standard input), signs it using alias's private key, and output the X.509 certificate into \f2outfile\fP (if omitted, to the standard output). If \f2\-rfc\fP is specified, output format is BASE64\-encoded PEM; otherwise, a binary DER is created. -.LP -\f2sigalg\fP specifies the algorithm that should be used to sign the certificate. \f2startdate\fP is the start time/date that the certificate is valid. \f2valDays\fP tells the number of days for which the certificate should be considered valid. -.LP -If \f2dname\fP is provided, it's used as the subject of the generated certificate. Otherwise, the one from the certificate request is used. -.LP -\f2ext\fP shows what X.509 extensions will be embedded in the certificate. Read Common Options for the grammar of \f2\-ext\fP. -.LP -The \f2\-gencert\fP command enables you to create certificate chains. The following example creates a certificate, \f2e1\fP, that contains three certificates in its certificate chain. -.LP -The following commands creates four key pairs named \f2ca\fP, \f2ca1\fP, \f2ca2\fP, and \f2e1\fP: -.nf -\f3 -.fl -keytool \-alias ca \-dname CN=CA \-genkeypair -.fl -keytool \-alias ca1 \-dname CN=CA \-genkeypair -.fl -keytool \-alias ca2 \-dname CN=CA \-genkeypair -.fl -keytool \-alias e1 \-dname CN=E1 \-genkeypair -.fl -\fP -.fi -.LP -The following two commands create a chain of signed certificates; \f2ca\fP signs ca1 and \f2ca1 signs ca2\fP, all of which are self\-issued: -.nf -\f3 -.fl -keytool \-alias ca1 \-certreq | keytool \-alias ca \-gencert \-ext san=dns:ca1 | keytool \-alias ca1 \-importcert -.fl -keytool \-alias ca2 \-certreq | $KT \-alias ca1 \-gencert \-ext san=dns:ca2 | $KT \-alias ca2 \-importcert -.fl -\fP -.fi -.LP -The following command creates the certificate \f2e1\fP and stores it in the file \f2e1.cert\fP, which is signed by \f2ca2\fP. As a result, \f2e1\fP should contain \f2ca\fP, \f2ca1\fP, and \f2ca2\fP in its certificate chain: -.nf -\f3 -.fl -keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1.cert -.fl -\fP -.fi -.TP 3 -\-genkeypair {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} {\-sigalg sigalg} [\-dname dname] [\-keypass keypass] {\-startdate value} {\-ext ext}* {\-validity valDays} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a key pair (a public key and associated private key). Wraps the public key into an X.509 v3 self\-signed certificate, which is stored as a single\-element certificate chain. This certificate chain and the private key are stored in a new keystore entry identified by \f2alias\fP. -.LP -\f2keyalg\fP specifies the algorithm to be used to generate the key pair, and \f2keysize\fP specifies the size of each key to be generated. \f2sigalg\fP specifies the algorithm that should be used to sign the self\-signed certificate; this algorithm must be compatible with \f2keyalg\fP. -.LP -\f2dname\fP specifies the X.500 Distinguished Name to be associated with \f2alias\fP, and is used as the \f2issuer\fP and \f2subject\fP fields in the self\-signed certificate. If no distinguished name is provided at the command line, the user will be prompted for one. -.LP -\f2keypass\fP is a password used to protect the private key of the generated key pair. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long. -.LP -\f2startdate\fP specifies the issue time of the certificate, also known as the "Not Before" value of the X.509 certificate's Validity field. -.LP -The option value can be set in one of these two forms: -.RS 3 -.TP 3 -1. -([+\-]\f2nnn\fP[ymdHMS])+ -.TP 3 -2. -[yyyy/mm/dd] [HH:MM:SS] -.RE -.LP -With the first form, the issue time is shifted by the specified value from the current time. The value is a concatenation of a sequence of sub values. Inside each sub value, the plus sign ("+") means shifting forward, and the minus sign ("\-") means shifting backward. The time to be shifted is \f2nnn\fP units of years, months, days, hours, minutes, or seconds (denoted by a single character of "y", "m", "d", "H", "M", or "S" respectively). The exact value of the issue time is calculated using the \f2java.util.GregorianCalendar.add(int field, int amount)\fP method on each sub value, from left to right. For example, by specifying \f2"\-startdate \-1y+1m\-1d"\fP, the issue time will be: -.nf -\f3 -.fl - Calendar c = new GregorianCalendar(); -.fl - c.add(Calendar.YEAR, \-1); -.fl - c.add(Calendar.MONTH, 1); -.fl - c.add(Calendar.DATE, \-1); -.fl - return c.getTime() -.fl -\fP -.fi -.LP -With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone). The user may provide only one part, which means the other part is the same as the current date (or time). User must provide the exact number of digits as shown in the format definition (padding with 0 if shorter). When both the date and time are provided, there is one (and only one) space character between the two parts. The hour should always be provided in 24 hour format. -.LP -When the option is not provided, the start date is the current time. The option can be provided at most once. -.LP -\f2valDays\fP specifies the number of days (starting at the date specified by \f2\-startdate\fP, or the current date if \f2\-startdate\fP is not specified) for which the certificate should be considered valid. -.LP -This command was named \f2\-genkey\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarity the new name, \f2\-genkeypair\fP, is preferred going forward. -.TP 3 -\-genseckey {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a secret key and stores it in a new \f2KeyStore.SecretKeyEntry\fP identified by \f2alias\fP. -.LP -\f2keyalg\fP specifies the algorithm to be used to generate the secret key, and \f2keysize\fP specifies the size of the key to be generated. \f2keypass\fP is a password used to protect the secret key. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long. -.TP 3 -\-importcert {\-alias alias} {\-file cert_file} [\-keypass keypass] {\-noprompt} {\-trustcacerts} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X.509 certificates) from the file \f2cert_file\fP, and stores it in the keystore entry identified by \f2alias\fP. If no file is given, the certificate or certificate chain is read from stdin. -.LP -\f3keytool\fP can import X.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type. The data to be imported must be provided either in binary encoding format, or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard. In the latter case, the encoding must be bounded at the beginning by a string that starts with "\-\-\-\-\-BEGIN", and bounded at the end by a string that starts with "\-\-\-\-\-END". -.LP -You import a certificate for two reasons: -.RS 3 -.TP 3 -1. -to add it to the list of trusted certificates, or -.TP 3 -2. -to import a certificate reply received from a CA as the result of submitting a Certificate Signing Request (see the \-certreq command) to that CA. -.RE -.LP -Which type of import is intended is indicated by the value of the \f2\-alias\fP option: -.RS 3 -.TP 3 -1. -\f3If the alias does not point to a key entry\fP, then \f3keytool\fP assumes you are adding a trusted certificate entry. In this case, the alias should not already exist in the keystore. If the alias does already exist, then \f3keytool\fP outputs an error, since there is already a trusted certificate for that alias, and does not import the certificate. -.TP 3 -2. -\f3If the alias points to a key entry\fP, then \f3keytool\fP assumes you are importing a certificate reply. -.RE -\f3Importing a New Trusted Certificate\fP -.LP -Before adding the certificate to the keystore, \f3keytool\fP tries to verify it by attempting to construct a chain of trust from that certificate to a self\-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore. -.LP -If the \f2\-trustcacerts\fP option has been specified, additional certificates are considered for the chain of trust, namely the certificates in a file named "cacerts". -.LP -If \f3keytool\fP fails to establish a trust path from the certificate to be imported up to a self\-signed certificate (either from the keystore or the "cacerts" file), the certificate information is printed out, and the user is prompted to verify it, e.g., by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner himself/herself. Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! \-\- see WARNING Regarding Importing Trusted Certificates. The user then has the option of aborting the import operation. If the \f2\-noprompt\fP option is given, however, there will be no interaction with the user. -\f3Importing a Certificate Reply\fP -.LP -When importing a certificate reply, the certificate reply is validated using trusted certificates from the keystore, and optionally using the certificates configured in the "cacerts" keystore file (if the \f2\-trustcacerts\fP option was specified). -.LP -The methods of determining whether the certificate reply is trusted are described in the following: -.RS 3 -.TP 2 -o -\f3If the reply is a single X.509 certificate\fP, \f3keytool\fP attempts to establish a trust chain, starting at the certificate reply and ending at a self\-signed certificate (belonging to a root CA). The certificate reply and the hierarchy of certificates used to authenticate the certificate reply form the new certificate chain of \f2alias\fP. If a trust chain cannot be established, the certificate reply is not imported. In this case, \f3keytool\fP does not print out the certificate and prompt the user to verify it, because it is very hard (if not impossible) for a user to determine the authenticity of the certificate reply. -.TP 2 -o -\f3If the reply is a PKCS#7 formatted certificate chain or a sequence of X.509 certificates\fP, the chain is ordered with the user certificate first followed by zero or more CA certificates. If the chain ends with a self\-signed root CA certificate and \f2\-trustcacerts\fP option was specified, \f3keytool\fP will attempt to match it with any of the trusted certificates in the keystore or the "cacerts" keystore file. If the chain does not end with a self\-signed root CA certificate and the \f2\-trustcacerts\fP option was specified, \f3keytool\fP will try to find one from the trusted certificates in the keystore or the "cacerts" keystore file and add it to the end of the chain. If the certificate is not found and \f2\-noprompt\fP option is not specified, the information of the last certificate in the chain is printed out, and the user is prompted to verify it. -.RE -.LP -If the public key in the certificate reply matches the user's public key already stored with under \f2alias\fP, the old certificate chain is replaced with the new certificate chain in the reply. The old chain can only be replaced if a valid \f2keypass\fP, the password used to protect the private key of the entry, is supplied. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it. -.LP -This command was named \f2\-import\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-importcert\fP, is preferred going forward. -.TP 3 -\-importkeystore \-srckeystore srckeystore \-destkeystore destkeystore {\-srcstoretype srcstoretype} {\-deststoretype deststoretype} [\-srcstorepass srcstorepass] [\-deststorepass deststorepass] {\-srcprotected} {\-destprotected} {\-srcalias srcalias {\-destalias destalias} [\-srckeypass srckeypass] [\-destkeypass destkeypass] } {\-noprompt} {\-srcProviderName src_provider_name} {\-destProviderName dest_provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Imports a single entry or all entries from a source keystore to a destination keystore. -.LP -When the \f2srcalias\fP option is provided, the command imports the single entry identified by the alias to the destination keystore. If a destination alias is not provided with \f2destalias\fP, then \f2srcalias\fP is used as the destination alias. If the source entry is protected by a password, \f2srckeypass\fP will be used to recover the entry. If \f2srckeypass\fP is not provided, then \f3keytool\fP will attempt to use \f2srcstorepass\fP to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. The destination entry will be protected using \f2destkeypass\fP. If \f2destkeypass\fP is not provided, the destination entry will be protected with the source entry password. -.LP -If the \f2srcalias\fP option is not provided, then all entries in the source keystore are imported into the destination keystore. Each destination entry will be stored under the alias from the source entry. If the source entry is protected by a password, \f2srcstorepass\fP will be used to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, the user will be prompted whether to skip the entry and continue, or to quit. The destination entry will be protected with the source entry password. -.LP -If the destination alias already exists in the destination keystore, the user is prompted to either overwrite the entry, or to create a new entry under a different alias name. -.LP -Note that if \f2\-noprompt\fP is provided, the user will not be prompted for a new destination alias. Existing entries will automatically be overwritten with the destination alias name. Finally, entries that can not be imported are automatically skipped and a warning is output. -.TP 3 -\-printcertreq {\-file file} -.LP -Prints the content of a PKCS #10 format certificate request, which can be generated by the keytool \-certreq command. The command reads the request from file; if omitted, from the standard input. -.RE +Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. -.LP -.SS -Exporting Data -.LP -.RS 3 -.TP 3 -\-certreq {\-alias alias} {\-dname dname} {\-sigalg sigalg} {\-file certreq_file} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a Certificate Signing Request (CSR), using the PKCS#10 format. -.LP -A CSR is intended to be sent to a certificate authority (CA). The CA will authenticate the certificate requestor (usually off\-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self\-signed certificate) in the keystore. -.LP -The private key associated with \f2alias\fP is used to create the PKCS#10 certificate request. In order to access the private key, the appropriate password must be provided, since private keys are protected in the keystore with a password. If \f2keypass\fP is not provided at the command line, and is different from the password used to protect the integrity of the keystore, the user is prompted for it. If dname is provided, it's used as the subject in the CSR. Otherwise, the X.500 Distinguished Name associated with alias is used. -.LP -\f2sigalg\fP specifies the algorithm that should be used to sign the CSR. -.LP -The CSR is stored in the file \f2certreq_file\fP. If no file is given, the CSR is output to stdout. -.LP -Use the \f2importcert\fP command to import the response from the CA. -.TP 3 -\-exportcert {\-alias alias} {\-file cert_file} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-rfc} {\-v} {\-protected} {\-Jjavaoption} -.LP -Reads (from the keystore) the certificate associated with \f2alias\fP, and stores it in the file \f2cert_file\fP. -.LP -If no file is given, the certificate is output to stdout. -.LP -The certificate is by default output in binary encoding, but will instead be output in the printable encoding format, as defined by the Internet RFC 1421 standard, if the \f2\-rfc\fP option is specified. -.LP -If \f2alias\fP refers to a trusted certificate, that certificate is output. Otherwise, \f2alias\fP refers to a key entry with an associated certificate chain. In that case, the first certificate in the chain is returned. This certificate authenticates the public key of the entity addressed by \f2alias\fP. -.LP -This command was named \f2\-export\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-exportcert\fP, is preferred going forward. -.RE +The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. +.TP +-importcert +.br +\f3-importcert {-alias alias} {-file cert_file} [-keypass keypass] {-noprompt} {-trustcacerts} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.SS -Displaying Data -.LP -.RS 3 -.TP 3 -\-list {\-alias alias} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v | \-rfc} {\-protected} {\-Jjavaoption} -.LP -Prints (to stdout) the contents of the keystore entry identified by \f2alias\fP. If no alias is specified, the contents of the entire keystore are printed. -.LP -This command by default prints the SHA1 fingerprint of a certificate. If the \f2\-v\fP option is specified, the certificate is printed in human\-readable format, with additional information such as the owner, issuer, serial number, and any extensions. If the \f2\-rfc\fP option is specified, certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 standard -.LP -You cannot specify both \f2\-v\fP and \f2\-rfc\fP. -.TP 3 -\-printcert {\-file cert_file | \-sslserver host[:port]} {\-jarfile JAR_file {\-rfc} {\-v} {\-Jjavaoption} -.LP -Reads the certificate from the file \f2cert_file\fP, the SSL server located at \f2host:port\fP, or the signed JAR file \f2JAR_file\fP (with the option \f2\-jarfile\fP and prints its contents in a human\-readable format. When no port is specified, the standard HTTPS port 443 is assumed. Note that \f2\-sslserver\fP and \f2\-file\fP options cannot be provided at the same time. Otherwise, an error is reported. If neither option is given, the certificate is read from stdin. -.LP -If \f2\-rfc\fP is specified, keytool prints the certificate in PEM mode as defined by the Internet RFC 1421 standard. -.LP -If the certificate is read from a file or stdin, it may be either binary encoded or in printable encoding format, as defined by the Internet RFC 1421 standard -.LP -If the SSL server is behind a firewall, \f2\-J\-Dhttps.proxyHost=proxyhost\fP and \f2\-J\-Dhttps.proxyPort=proxyport\fP can be specified on the command line for proxy tunneling. See the -.na -\f2JSSE Reference Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html for more information. -.LP -\f3Note\fP: This option can be used independently of a keystore. -.TP 3 -\-printcrl \-file crl_ {\-v} -.LP -Reads the certificate revocation list (CRL) from the file \f2crl_file\fP. -.LP -A Certificate Revocation List (CRL) is a list of digital certificates which have been revoked by the Certificate Authority (CA) that issued them. The CA generates \f2crl_file\fP. -.LP -\f3Note\fP: This option can be used independently of a keystore. -.RE +Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. -.LP -.SS -Managing the Keystore -.LP -.RS 3 -.TP 3 -\-storepasswd [\-new new_storepass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption} -.LP -Changes the password used to protect the integrity of the keystore contents. The new password is \f2new_storepass\fP, which must be at least 6 characters long. -.TP 3 -\-keypasswd {\-alias alias} [\-keypass old_keypass] [\-new new_keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption} -.LP -Changes the password under which the private/secret key identified by \f2alias\fP is protected, from \f2old_keypass\fP to \f2new_keypass\fP, which must be at least 6 characters long. -.LP -If the \f2\-keypass\fP option is not provided at the command line, and the key password is different from the keystore password, the user is prompted for it. -.LP -If the \f2\-new\fP option is not provided at the command line, the user is prompted for it. -.TP 3 -\-delete [\-alias alias] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Deletes from the keystore the entry identified by \f2alias\fP. The user is prompted for the alias, if no alias is provided at the command line. -.TP 3 -\-changealias {\-alias alias} [\-destalias destalias] [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Move an existing keystore entry from the specified \f2alias\fP to a new alias, \f2destalias\fP. If no destination alias is provided, the command will prompt for one. If the original entry is protected with an entry password, the password can be supplied via the "\-keypass" option. If no key password is provided, the \f2storepass\fP (if given) will be attempted first. If that attempt fails, the user will be prompted for a password. -.RE +The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. -.LP -.SS -Getting Help -.LP -.RS 3 -.TP 3 -\-help -.LP -Lists the basic commands and their options. -.LP -For more information about a specific command, enter the following, where \f2command_name\fP is the name of the command: -.nf -\f3 -.fl - keytool \-\fP\f4command_name\fP\f3 \-help -.fl -\fP -.fi -.RE +You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. -.LP -.SH "EXAMPLES" -.LP -.LP -Suppose you want to create a keystore for managing your public/private key pair and certificates from entities you trust. -.LP -.SS -Generating Your Key Pair -.LP -.LP -The first thing you need to do is create a keystore and generate the key pair. You could use a command such as the following: -.LP -.nf -\f3 -.fl - keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US" -.fl - \-alias business \-keypass \fP\f4<new password for private key>\fP\f3 \-keystore /working/mykeystore -.fl - \-storepass \fP\f4<new password for keystore>\fP\f3 \-validity 180 -.fl -\fP -.fi +Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. +.TP +-importpassword +.br +\f3{-alias alias} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -(Please note: This must be typed as a single line. Multiple lines are used in the examples just for legibility purposes.) -.LP -.LP -This command creates the keystore named "mykeystore" in the "working" directory (assuming it doesn't already exist), and assigns it the password specified by \f2<new password for keystore>\fP. It generates a public/private key pair for the entity whose "distinguished name" has a common name of "Mark Jones", organizational unit of "Java", organization of "Oracle" and two\-letter country code of "US". It uses the default "DSA" key generation algorithm to create the keys, both 1024 bits long. -.LP -.LP -It creates a self\-signed certificate (using the default "SHA1withDSA" signature algorithm) that includes the public key and the distinguished name information. This certificate will be valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias "business". The private key is assigned the password specified by \f2<new password for private key>\fP. -.LP -.LP -The command could be significantly shorter if option defaults were accepted. As a matter of fact, no options are required; defaults are used for unspecified options that have default values, and you are prompted for any required values. Thus, you could simply have the following: -.LP -.nf -\f3 -.fl - keytool \-genkeypair -.fl -\fP -.fi +Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. +.TP +-importkeystore +.br +\f3{-srcstoretype srcstoretype} {-deststoretype deststoretype} [-srcstorepass srcstorepass] [-deststorepass deststorepass] {-srcprotected} {-destprotected} {-srcalias srcalias {-destalias destalias} [-srckeypass srckeypass] } [-destkeypass destkeypass] {-noprompt} {-srcProviderName src_provider_name} {-destProviderName dest_provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -In this case, a keystore entry with alias "mykey" is created, with a newly\-generated key pair and a certificate that is valid for 90 days. This entry is placed in the keystore named ".keystore" in your home directory. (The keystore is created if it doesn't already exist.) You will be prompted for the distinguished name information, the keystore password, and the private key password. -.LP -.LP -The rest of the examples assume you executed the \f2\-genkeypair\fP command without options specified, and that you responded to the prompts with values equal to those given in the first \f2\-genkeypair\fP command, above (for example, a distinguished name of "cn=Mark Jones, ou=Java, o=Oracle, c=US"). -.LP -.SS -Requesting a Signed Certificate from a Certification Authority -.LP -.LP -So far all we've got is a self\-signed certificate. A certificate is more likely to be trusted by others if it is signed by a Certification Authority (CA). To get such a signature, you first generate a Certificate Signing Request (CSR), via the following: -.LP -.nf -\f3 -.fl - keytool \-certreq \-file MarkJ.csr -.fl -\fP -.fi +Imports a single entry or all entries from a source keystore to a destination keystore\&. -.LP -.LP -This creates a CSR (for the entity identified by the default alias "mykey") and puts the request in the file named "MarkJ.csr". Submit this file to a CA, such as VeriSign, Inc. The CA will authenticate you, the requestor (usually off\-line), and then will return a certificate, signed by them, authenticating your public key. (In some cases, they will actually return a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain.) -.LP -.SS -Importing a Certificate for the CA -.LP -.LP -You need to replace your self\-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a "root" CA. -.LP -.LP -Before you import the certificate reply from a CA, you need one or more "trusted certificates" in your keystore or in the \f2cacerts\fP keystore file (which is described in importcert command): -.LP -.RS 3 -.TP 2 -o -If the certificate reply is a certificate chain, you just need the top certificate of the chain (that is, the "root" CA certificate authenticating that CA's public key). -.TP 2 -o -If the certificate reply is a single certificate, you need a certificate for the issuing CA (the one that signed it), and if that certificate is not self\-signed, you need a certificate for its signer, and so on, up to a self\-signed "root" CA certificate. -.RE +When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. -.LP -.LP -The "cacerts" keystore file ships with several VeriSign root CA certificates, so you probably won't need to import a VeriSign certificate as a trusted certificate in your keystore. But if you request a signed certificate from a different CA, and a certificate authenticating that CA's public key hasn't been added to "cacerts", you will need to import a certificate from the CA as a "trusted certificate". -.LP -.LP -A certificate from a CA is usually either self\-signed, or signed by another CA (in which case you also need a certificate authenticating that CA's public key). Suppose company ABC, Inc., is a CA, and you obtain a file named "ABCCA.cer" that is purportedly a self\-signed certificate from ABC, authenticating that CA's public key. -.LP -.LP -Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! View it first (using the \f3keytool\fP \f2\-printcert\fP command, or the \f3keytool\fP \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. You can call the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show (or that a secure public key repository shows). Only if the fingerprints are equal is it guaranteed that the certificate has not been replaced in transit with somebody else's (for example, an attacker's) certificate. If such an attack took place, and you did not check the certificate before you imported it, you would end up trusting anything the attacker has signed. -.LP -.LP -If you trust that the certificate is valid, then you can add it to your keystore via the following: -.LP -.nf -\f3 -.fl - keytool \-importcert \-alias abc \-file ABCCA.cer -.fl -\fP -.fi +If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. -.LP -.LP -This creates a "trusted certificate" entry in the keystore, with the data from the file "ABCCA.cer", and assigns the alias "abc" to the entry. -.LP -.SS -Importing the Certificate Reply from the CA -.LP -.LP -Once you've imported a certificate authenticating the public key of the CA you submitted your certificate signing request to (or there's already such a certificate in the "cacerts" file), you can import the certificate reply and thereby replace your self\-signed certificate with a certificate chain. This chain is the one returned by the CA in response to your request (if the CA reply is a chain), or one constructed (if the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the "cacerts" keystore file. -.LP -.LP -For example, suppose you sent your certificate signing request to VeriSign. You can then import the reply via the following, which assumes the returned certificate is named "VSMarkJ.cer": -.LP -.nf -\f3 -.fl - keytool \-importcert \-trustcacerts \-file VSMarkJ.cer -.fl -\fP -.fi +If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. -.LP -.SS -Exporting a Certificate Authenticating Your Public Key -.LP -.LP -Suppose you have used the jarsigner(1) tool to sign a Java ARchive (JAR) file. Clients that want to use the file will want to authenticate your signature. -.LP -.LP -One way they can do this is by first importing your public key certificate into their keystore as a "trusted" entry. You can export the certificate and supply it to your clients. As an example, you can copy your certificate to a file named \f2MJ.cer\fP via the following, assuming the entry is aliased by "mykey": -.LP -.nf -\f3 -.fl - keytool \-exportcert \-alias mykey \-file MJ.cer -.fl -\fP -.fi +If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. +.TP +-printcertreq +.br +\f3{-file file}\fR -.LP -.LP -Given that certificate, and the signed JAR file, a client can use the \f3jarsigner\fP tool to authenticate your signature. -.LP -.SS -Importing Keystore -.LP -.LP -The command "importkeystore" is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command. You can use this command to import entries from a different type of keystore. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys). If \f3keytool\fP has difficulties recover the private keys or secret keys from the source keystore, it will prompt you for a password. If it detects alias duplication, it will ask you for a new one, you can specify a new alias or simply allow \f3keytool\fP to overwrite the existing one. -.LP -.LP -For example, to import entries from a normal JKS type keystore key.jks into a PKCS #11 type hardware based keystore, you can use the command: -.LP -.nf -\f3 -.fl - keytool \-importkeystore -.fl - \-srckeystore key.jks \-destkeystore NONE -.fl - \-srcstoretype JKS \-deststoretype PKCS11 -.fl - \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3 -.fl -\fP -.fi +Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. +.TP +-certreq +.br +\f3{-alias alias} {-dname dname} {-sigalg sigalg} {-file certreq_file} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -The importkeystore command can also be used to import a single entry from a source keystore to a destination keystore. In this case, besides the options you see in the above example, you need to specify the alias you want to import. With the srcalias option given, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want. The following command demonstrates this: -.LP -.nf -\f3 -.fl - keytool \-importkeystore -.fl - \-srckeystore key.jks \-destkeystore NONE -.fl - \-srcstoretype JKS \-deststoretype PKCS11 -.fl - \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3 -.fl - \-srcalias myprivatekey \-destalias myoldprivatekey -.fl - \-srckeypass \fP\f4<source entry password>\fP\f3 \-destkeypass \fP\f4<destination entry password>\fP\f3 -.fl - \-noprompt -.fl -\fP -.fi +Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. -.LP -.SS -Generating Certificates for a Typical SSL Server -.LP -.LP -The following are keytool commands to generate keypairs and certificates for three entities, namely, Root CA (root), Intermediate CA (ca), and SSL server (server). Ensure that you store all the certificates in the same keystore. In these examples, it is recommended that you specify RSA as the key algorithm. -.LP -.nf -\f3 -.fl -keytool \-genkeypair \-keystore root.jks \-alias root \-ext bc:c -.fl -keytool \-genkeypair \-keystore ca.jks \-alias ca \-ext bc:c -.fl -keytool \-genkeypair \-keystore server.jks \-alias server -.fl +A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. -.fl -keytool \-keystore root.jks \-alias root \-exportcert \-rfc > root.pem -.fl +The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. -.fl -keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-certreq \-alias ca | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore root.jks \-gencert \-alias root \-ext BC=0 \-rfc > ca.pem -.fl -keytool \-keystore ca.jks \-importcert \-alias ca \-file ca.pem -.fl +The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. -.fl -keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore server.jks \-certreq \-alias server | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-gencert \-alias ca \-ext ku:c=dig,kE \-rfc > server.pem -.fl -cat root.pem ca.pem server.pem | keytool \-keystore server.jks \-importcert \-alias server -.fl -\fP -.fi +The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. -.LP -.SH "TERMINOLOGY and WARNINGS" -.LP -.SS -KeyStore -.LP -.LP -A keystore is a storage facility for cryptographic keys and certificates. -.LP -.RS 3 -.TP 2 -o -\f3KeyStore Entries\fP -.LP -Keystores may have different types of entries. The two most applicable entry types for \f3keytool\fP include: -.RS 3 -.TP 3 -1. -\f3key entries\fP \- each holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate "chain" for the corresponding public key. The \f3keytool\fP can handle both types of entries, while the \f3jarsigner\fP tool only handle the latter type of entry, that is private keys and their associated certificate chains. -.TP 3 -2. -\f3trusted certificate entries\fP \- each contains a single public key certificate belonging to another party. It is called a "trusted certificate" because the keystore owner trusts that the public key in the certificate indeed belongs to the identity identified by the "subject" (owner) of the certificate. The issuer of the certificate vouches for this, by signing the certificate. -.RE -.TP 2 -o -\f3KeyStore Aliases\fP -.LP -All keystore entries (key and trusted certificate entries) are accessed via unique \f2aliases\fP. -.LP -An alias is specified when you add an entity to the keystore using the \-genseckey command to generate a secret key, \-genkeypair command to generate a key pair (public and private key) or the \-importcert command to add a certificate or certificate chain to the list of trusted certificates. Subsequent \f3keytool\fP commands must use this same alias to refer to the entity. -.LP -For example, suppose you use the alias \f2duke\fP to generate a new public/private key pair and wrap the public key into a self\-signed certificate (see Certificate Chains) via the following command: -.nf -\f3 -.fl - keytool \-genkeypair \-alias duke \-keypass dukekeypasswd -.fl -\fP -.fi -.LP -This specifies an initial password of "dukekeypasswd" required by subsequent commands to access the private key associated with the alias \f2duke\fP. If you later want to change duke's private key password, you use a command like the following: -.nf -\f3 -.fl - keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass -.fl -\fP -.fi -.LP -This changes the password from "dukekeypasswd" to "newpass". -.LP -Please note: A password should not actually be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system. If you don't specify a required password option on a command line, you will be prompted for it. -.TP 2 -o -\f3KeyStore Implementation\fP -.LP -The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore. -.LP -Currently, two command\-line tools (\f3keytool\fP and \f3jarsigner\fP) and a GUI\-based tool named \f3Policy Tool\fP make use of keystore implementations. Since \f2KeyStore\fP is publicly available, users can write additional security applications that use it. -.LP -There is a built\-in default implementation, provided by Oracle. It implements the keystore as a file, utilizing a proprietary keystore type (format) named "JKS". It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password. -.LP -Keystore implementations are provider\-based. More specifically, the application interfaces supplied by \f2KeyStore\fP are implemented in terms of a "Service Provider Interface" (SPI). That is, there is a corresponding abstract \f2KeystoreSpi\fP class, also in the \f2java.security\fP package, which defines the Service Provider Interface methods that "providers" must implement. (The term "provider" refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API.) Thus, to provide a keystore implementation, clients must implement a "provider" and supply a KeystoreSpi subclass implementation, as described in -.na -\f2How to Implement a Provider for the Java Cryptography Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html. -.LP -Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible. -.LP -\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL. -.LP -For \f3keytool\fP and \f3jarsigner\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Keystore" menu. -.LP -If you don't explicitly specify a keystore type, the tools choose a keystore implementation based simply on the value of the \f2keystore.type\fP property specified in the security properties file. The security properties file is called \f2java.security\fP, and it resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -Each tool gets the \f2keystore.type\fP value and then examines all the currently\-installed providers until it finds one that implements keystores of that type. It then uses the keystore implementation from that provider. -.LP -The \f2KeyStore\fP class defines a static method named \f2getDefaultType\fP that lets applications and applets retrieve the value of the \f2keystore.type\fP property. The following line of code creates an instance of the default keystore type (as specified in the \f2keystore.type\fP property): -.nf -\f3 -.fl - KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); -.fl -\fP -.fi -.LP -The default keystore type is "jks" (the proprietary type of the keystore implementation provided by Oracle). This is specified by the following line in the security properties file: -.nf -\f3 -.fl - keystore.type=jks -.fl -\fP -.fi -.LP -To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type. -.LP -For example, if you have a provider package that supplies a keystore implementation for a keystore type called "pkcs12", change the line to -.nf -\f3 -.fl - keystore.type=pkcs12 -.fl -\fP -.fi -.LP -Note: case doesn't matter in keystore type designations. For example, "JKS" would be considered the same as "jks". -.RE +Use the \f3importcert\fR command to import the response from the CA\&. +.TP +-exportcert +.br +\f3{-alias alias} {-file cert_file} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-rfc} {-v} {-protected} {-Jjavaoption}\fR -.LP -.SS +Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. + +The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. + +This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. +.TP +-list +.br +\f3{-alias alias} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v | -rfc} {-protected} {-Jjavaoption}\fR + +Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. + +This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +You cannot specify both \f3-v\fR and \f3-rfc\fR\&. +.TP +-printcert +.br +\f3{-file cert_file | -sslserver host[:port]} {-jarfile JAR_file {-rfc} {-v} {-Jjavaoption}\fR + +Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. + +When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. + +If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. + +If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-printcrl +.br +\f3-file crl_ {-v}\fR + +Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-storepasswd +.br +\f3[-new new_storepass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-Jjavaoption}\fR + +Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. +.TP +-keypasswd +.br +\f3{-alias alias} [-keypass old_keypass] [-new new_keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-Jjavaoption}\fR + +Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. + +If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. + +If the \f3-new\fR option is not provided at the command line, then the user is prompted for it +.TP +-delete +.br +\f3[-alias alias] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. +.TP +-changealias +.br +\f3{-alias alias} [-destalias destalias] [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. +.TP +-help +.br +Lists the basic commands and their options\&. + +For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. +.SH EXAMPLES +This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. +.SS GENERATE\ THE\ KEY\ PAIR +First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: +.sp +.nf +\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP +.fi +.nf +\f3 \-alias business \-keypass <new password for private key>\fP +.fi +.nf +\f3 \-keystore /working/mykeystore\fP +.fi +.nf +\f3 \-storepass <new password for keystore> \-validity 180\fP +.fi +.nf +\f3\fP +.fi +.sp +The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. +.PP +The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. +.PP +The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: +.sp +.nf +\f3keytool \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp +In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. +.PP +The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. +.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA +Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: +.sp +.nf +\f3keytool \-certreq \-file MarkJ\&.csr\fP +.fi +.nf +\f3\fP +.fi +.sp +This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. +.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA +You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. +.PP +Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. +.TP 0.2i +\(bu +If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. +.TP 0.2i +\(bu +If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. +.PP +The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. +.PP +A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. +.PP +If you trust that the certificate is valid, then you can add it to your keystore with the following command: +.sp +.nf +\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. +.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA +After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. +.PP +For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: +.sp +.nf +\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY +If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. +.PP +You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: +.sp +.nf +\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. +.SS IMPORT\ KEYSTORE +The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. +.PP +For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP +.fi +.nf +\f3 \-srckeypass <source entry password>\fP +.fi +.nf +\f3 \-destkeypass <destination entry password>\fP +.fi +.nf +\f3 \-noprompt\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER +The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. +.sp +.nf +\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP +.fi +.nf +\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP +.fi +.nf +\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP +.fi +.nf +\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP +.fi +.nf +\f3cat root\&.pem ca\&.pem server\&.pem |\fP +.fi +.nf +\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH TERMS +.TP +Keystore +A keystore is a storage facility for cryptographic keys and certificates\&. +.TP +Keystore entries +Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: + +\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. + +\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. +.TP +KeyStore aliases +All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. + +An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. + +For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. +.sp +.nf +\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: +.sp +.nf +\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. +.TP +KeyStore implementation +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies well-defined interfaces to access and modify the information in a keystore\&. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular type of keystore\&. + +Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. + +There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. + +Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html + +Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. + +The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. + +For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. + +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. + +Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. +.TP Certificate -.LP -A \f3certificate\fP (also known as a \f3public\-key certificate\fP) is a digitally signed statement from one entity (the \f2issuer\fP), saying that the public key (and some other information) of another entity (the \f2subject\fP) has some specific value. -.RS 3 -.TP 2 -o -\f3Certificate Terms\fP -.RS 3 -.TP 3 -Public Keys -.LP -These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity. Public keys are used to verify signatures. -.TP 3 -Digitally Signed -.LP -If some data is \f2digitally signed\fP it has been stored with the "identity" of an entity, and a signature that proves that entity knows about the data. The data is rendered unforgeable by signing with the entity's private key. -.TP 3 -Identity -.LP -A known way of addressing an entity. In some systems the identity is the public key, in others it can be anything from a Unix UID to an Email address to an X.509 Distinguished Name. -.TP 3 -Signature -.LP -A signature is computed over some data using the private key of an entity (the \f2signer\fP, which in the case of a certificate is also known as the \f2issuer\fP). -.TP 3 -Private Keys -.LP -These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it's supposed to be kept secret). Private and public keys exist in pairs in all public key cryptography systems (also referred to as "public key crypto systems"). In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key. Private keys are used to compute signatures. -.TP 3 -Entity -.LP -An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree. -.RE -.LP -Basically, public key cryptography requires access to users' public keys. In a large\-scale networked environment it is impossible to guarantee that prior relationships between communicating entities have been established or that a trusted repository exists with all used public keys. Certificates were invented as a solution to this public key distribution problem. Now a \f2Certification Authority\fP (CA) can act as a trusted third party. CAs are entities (for example, businesses) that are trusted to sign (issue) certificates for other entities. It is assumed that CAs will only create valid and reliable certificates, as they are bound by legal agreements. There are many public Certification Authorities, such as -.na -\f2VeriSign\fP @ -.fi -http://www.verisign.com/, -.na -\f2Thawte\fP @ -.fi -http://www.thawte.com/, -.na -\f2Entrust\fP @ -.fi -http://www.entrust.com/, and so on. You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization. -.LP -Using \f3keytool\fP, it is possible to display, import, and export certificates. It is also possible to generate self\-signed certificates. -.LP -\f3keytool\fP currently handles X.509 certificates. -.TP 2 -o -\f3X.509 Certificates\fP -.LP -The X.509 standard defines what information can go into a certificate, and describes how to write it down (the data format). All the data in a certificate is encoded using two related standards called ASN.1/DER. \f2Abstract Syntax Notation 1\fP describes data. The \f2Definite Encoding Rules\fP describe a single way to store and transfer that data. -.LP -All X.509 certificates have the following data, in addition to the signature: -.RS 3 -.TP 3 -Version -.LP -This identifies which version of the X.509 standard applies to this certificate, which affects what information can be specified in it. Thus far, three versions are defined. \f3keytool\fP can import and export v1, v2, and v3 certificates. It generates v3 certificates. -.LP -\f2X.509 Version 1\fP has been available since 1988, is widely deployed, and is the most generic. -.LP -\f2X.509 Version 2\fP introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject and/or issuer names over time. Most certificate profile documents strongly recommend that names not be reused, and that certificates should not make use of unique identifiers. Version 2 certificates are not widely used. -.LP -\f2X.509 Version 3\fP is the most recent (1996) and supports the notion of extensions, whereby anyone can define an extension and include it in the certificate. Some common extensions in use today are: \f2KeyUsage\fP (limits the use of the keys to particular purposes such as "signing\-only") and \f2AlternativeNames\fP (allows other identities to also be associated with this public key, e.g. DNS names, Email addresses, IP addresses). Extensions can be marked \f2critical\fP to indicate that the extension should be checked and enforced/used. For example, if a certificate has the KeyUsage extension marked critical and set to "keyCertSign" then if this certificate is presented during SSL communication, it should be rejected, as the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use. -.TP 3 -Serial Number -.LP -The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues. This information is used in numerous ways, for example when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL). -.TP 3 -Signature Algorithm Identifier -.LP -This identifies the algorithm used by the CA to sign the certificate. -.TP 3 -Issuer Name -.LP -The X.500 Distinguished Name of the entity that signed the certificate. This is normally a CA. Using this certificate implies trusting the entity that signed this certificate. (Note that in some cases, such as \f2root or top\-level\fP CA certificates, the issuer signs its own certificate.) -.TP 3 -Validity Period -.LP -Each certificate is valid only for a limited amount of time. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate or the amount one is willing to pay for a certificate. This is the expected period that entities can rely on the public value, if the associated private key has not been compromised. -.TP 3 -Subject Name -.LP -The name of the entity whose public key the certificate identifies. This name uses the X.500 standard, so it is intended to be unique across the Internet. This is the X.500 Distinguished Name (DN) of the entity, for example, -.nf -\f3 -.fl - CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US -.fl -\fP -.fi -.LP -(These refer to the subject's Common Name, Organizational Unit, Organization, and Country.) -.TP 3 -Subject Public Key Information -.LP -This is the public key of the entity being named, together with an algorithm identifier which specifies which public key crypto system this key belongs to and any associated key parameters. -.RE -.TP 2 -o -\f3Certificate Chains\fP -.LP -\f3keytool\fP can create and manage keystore "key" entries that each contain a private key and an associated certificate "chain". The first certificate in the chain contains the public key corresponding to the private key. -.LP -When keys are first generated (see the \-genkeypair command), the chain starts off containing a single element, a \f2self\-signed certificate\fP. A self\-signed certificate is one for which the issuer (signer) is the same as the subject (the entity whose public key is being authenticated by the certificate). Whenever the \f2\-genkeypair\fP command is called to generate a new public/private key pair, it also wraps the public key into a self\-signed certificate. -.LP -Later, after a Certificate Signing Request (CSR) has been generated (see the \-certreq command) and sent to a Certification Authority (CA), the response from the CA is imported (see \-importcert), and the self\-signed certificate is replaced by a chain of certificates. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject's public key. The next certificate in the chain is one that authenticates the \f2CA\fP's public key. -.LP -In many cases, this is a self\-signed certificate (that is, a certificate from the CA authenticating its own public key) and the last certificate in the chain. In other cases, the CA may return a chain of certificates. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a \f2different\fP CA, authenticating the public key of the CA you sent the CSR to. Then, the next certificate in the chain will be a certificate authenticating the second CA's key, and so on, until a self\-signed "root" certificate is reached. Each certificate in the chain (after the first) thus authenticates the public key of the signer of the previous certificate in the chain. -.LP -Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs). In this case, the certificate chain must be established from trusted certificate information already stored in the keystore. -.LP -A different reply format (defined by the PKCS#7 standard) also includes the supporting certificate chain, in addition to the issued certificate. Both reply formats can be handled by \f3keytool\fP. -.LP -The top\-level (root) CA certificate is self\-signed. However, the trust into the root's public key does not come from the root certificate itself (anybody could generate a self\-signed certificate with the distinguished name of say, the VeriSign root CA!), but from other sources like a newspaper. The root CA public key is widely known. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a "vehicle" to transport the root CA's public key. Before you add the root CA certificate to your keystore, you should view it (using the \f2\-printcert\fP option) and compare the displayed fingerprint with the well\-known fingerprint (obtained from a newspaper, the root CA's Web page, etc.). -.TP 2 -o -\f3The cacerts Certificates File\fP -.LP -A certificates file named \f3"cacerts"\fP resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -The "cacerts" file represents a system\-wide keystore with CA certificates. System administrators can configure and manage that file using \f3keytool\fP, specifying "jks" as the keystore type. The "cacerts" keystore file ships with a default set of root CA certificates; list them with the following command: -.nf -\f3 -.fl -keytool \-list \-keystore \fP\f4java.home\fP\f3/lib/security/cacerts -.fl -\fP -.fi -.LP -The initial password of the "cacerts" keystore file is "changeit". System administrators should change that password and the default access permission of that file upon installing the SDK. -.LP -\f3IMPORTANT: Verify Your \fP\f4cacerts\fP\f3 File\fP: Since you trust the CAs in the \f2cacerts\fP file as entities for signing and issuing certificates to other entities, you must manage the \f2cacerts\fP file carefully. The \f2cacerts\fP file should contain only certificates of the CAs you trust. It is your responsibility to verify the trusted root CA certificates bundled in the \f2cacerts\fP file and make your own trust decisions. To remove an untrusted CA certificate from the \f2cacerts\fP file, use the delete option of the \f2keytool\fP command. You can find the \f2cacerts\fP file in the JRE installation directory. Contact your system administrator if you do not have permission to edit this file. -.TP 2 -o -\f3The Internet RFC 1421 Certificate Encoding Standard\fP -.LP -Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding. This certificate format, also known as "Base 64 encoding", facilitates exporting certificates to other applications by email or through some other mechanism. -.LP -Certificates read by the \f2\-importcert\fP and \f2\-printcert\fP commands can be in either this format or binary encoded. -.LP -The \f2\-exportcert\fP command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, if the \f2\-rfc\fP option is specified. -.LP -The \f2\-list\fP command by default prints the SHA1 fingerprint of a certificate. If the \f2\-v\fP option is specified, the certificate is printed in human\-readable format, while if the \f2\-rfc\fP option is specified, the certificate is output in the printable encoding format. -.LP -In its printable encoding format, the encoded certificate is bounded at the beginning by -.nf -\f3 -.fl -\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\- -.fl -\fP -.fi -.LP -and at the end by -.nf -\f3 -.fl -\-\-\-\-\-END CERTIFICATE\-\-\-\-\- -.fl -\fP -.fi -.RE +A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: -.LP -.SS -X.500 Distinguished Names -.LP -.LP -X.500 Distinguished Names are used to identify entities, such as those which are named by the \f2subject\fP and \f2issuer\fP (signer) fields of X.509 certificates. \f3keytool\fP supports the following subparts: -.LP -.RS 3 -.TP 2 -o -\f2commonName\fP \- common name of a person, e.g., "Susan Jones" -.TP 2 -o -\f2organizationUnit\fP \- small organization (e.g., department or division) name, e.g., "Purchasing" -.TP 2 -o -\f2organizationName\fP \- large organization name, e.g., "ABCSystems, Inc." -.TP 2 -o -\f2localityName\fP \- locality (city) name, e.g., "Palo Alto" -.TP 2 -o -\f2stateName\fP \- state or province name, e.g., "California" -.TP 2 -o -\f2country\fP \- two\-letter country code, e.g., "CH" -.RE +\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. -.LP -.LP -When supplying a distinguished name string as the value of a \f2\-dname\fP option, as for the \f2\-genkeypair\fP command, the string must be in the following format: -.LP -.nf -\f3 -.fl -CN=\fP\f4cName\fP\f3, OU=\fP\f4orgUnit\fP\f3, O=\fP\f4org\fP\f3, L=\fP\f4city\fP\f3, S=\fP\f4state\fP\f3, C=\fP\f4countryCode\fP\f3 -.fl -\fP -.fi +\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. -.LP -.LP -where all the italicized items represent actual values and the above keywords are abbreviations for the following: -.LP -.nf -\f3 -.fl - CN=commonName -.fl - OU=organizationUnit -.fl - O=organizationName -.fl - L=localityName -.fl - S=stateName -.fl - C=country -.fl -\fP -.fi +\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. -.LP -.LP -A sample distinguished name string is -.LP -.nf -\f3 -.fl -CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US -.fl -\fP -.fi +\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. -.LP -.LP -and a sample command using such a string is -.LP -.nf -\f3 -.fl -keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, -.fl -S=California, C=US" \-alias mark -.fl -\fP -.fi +\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. -.LP -.LP -Case does not matter for the keyword abbreviations. For example, "CN", "cn", and "Cn" are all treated the same. -.LP -.LP -Order matters; each subcomponent must appear in the designated order. However, it is not necessary to have all the subcomponents. You may use a subset, for example: -.LP -.nf -\f3 -.fl -CN=Steve Meier, OU=Java, O=Oracle, C=US -.fl -\fP -.fi +\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. -.LP -.LP -If a distinguished name string value contains a comma, the comma must be escaped by a "\\" character when you specify the string on a command line, as in -.LP -.nf -\f3 -.fl - cn=Peter Schuster, ou=Java\\, Product Development, o=Oracle, c=US -.fl -\fP -.fi +Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. -.LP -.LP -It is never necessary to specify a distinguished name string on a command line. If it is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents. In this case, a comma does not need to be escaped by a "\\". -.LP -.SS -WARNING Regarding Importing Trusted Certificates -.LP -.LP -IMPORTANT: Be sure to check a certificate very carefully before importing it as a trusted certificate! -.LP -.LP -View it first (using the \f2\-printcert\fP command, or the \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. For example, suppose someone sends or emails you a certificate, and you put it in a file named \f2/tmp/cert\fP. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f2\-printcert\fP command to view its fingerprints, as in -.LP -.nf -\f3 -.fl - keytool \-printcert \-file /tmp/cert -.fl - Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll -.fl - Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll -.fl - Serial Number: 59092b34 -.fl - Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997 -.fl - Certificate Fingerprints: -.fl - MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F -.fl - SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE -.fl - SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90: -.fl - 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4 -.fl -\fP -.fi +You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. -.LP -.LP -Then call or otherwise contact the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show. Only if the fingerprints are equal is it guaranteed that the certificate has not been replaced in transit with somebody else's (for example, an attacker's) certificate. If such an attack took place, and you did not check the certificate before you imported it, you would end up trusting anything the attacker has signed (for example, a JAR file with malicious class files inside). -.LP -.LP -Note: it is not required that you execute a \f2\-printcert\fP command prior to importing a certificate, since before adding a certificate to the list of trusted certificates in the keystore, the \f2\-importcert\fP command prints out the certificate information and prompts you to verify it. You then have the option of aborting the import operation. Note, however, this is only the case if you invoke the \f2\-importcert\fP command without the \f2\-noprompt\fP option. If the \f2\-noprompt\fP option is given, there is no interaction with the user. -.LP -.SS -Warning Regarding Passwords -.LP -.LP -Most commands operating on a keystore require the store password. Some commands require a private/secret key password. -.LP -.LP -Passwords can be specified on the command line (in the \f2\-storepass\fP and \f2\-keypass\fP options, respectively). However, a password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system. -.LP -.LP -If you don't specify a required password option on a command line, you will be prompted for it. -.LP -.SS -Warning Regarding Certificate Conformance -.LP -.LP -The Internet standard -.na -\f2RFC 5280\fP @ -.fi -http://tools.ietf.org/rfc/rfc5280.txt has defined a profile on conforming X.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions. \f3keytool\fP has not enforced all these rules so it can generate certificates which do not conform to the standard, and these certificates might be rejected by JRE or other applications. Users should make sure that they provide the correct options for \f2\-dname\fP, \f2\-ext\fP, etc. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jar(1) tool documentation -.TP 2 -o -jarsigner(1) tool documentation -.TP 2 -o -the -.na -\f4Security\fP @ -.fi -http://download.oracle.com/javase/tutorial/security/index.html trail of the -.na -\f4Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/ for examples of the use of \f3keytool\fP -.RE +The \f3keytool\fR command currently handles X\&.509 certificates\&. +.TP +X\&.509 Certificates +The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. -.LP -.SH "CHANGES" -.LP -.LP -The command interface for keytool changed in Java SE 6. -.LP -.LP -\f3keytool\fP no longer displays password input when entered by users. Since password input can no longer be viewed when entered, users will be prompted to re\-enter passwords any time a password is being set or changed (for example, when setting the initial keystore password, or when changing a key password). -.LP -.LP -Some commands have simply been renamed, and other commands deemed obsolete are no longer listed in this document. All previous commands (both renamed and obsolete) are still supported in this release and will continue to be supported in future releases. The following summarizes all of the changes made to the keytool command interface: -.LP -.LP -Renamed commands: -.LP -.RS 3 -.TP 2 -o -\f2\-export\fP, renamed to \f2\-exportcert\fP -.TP 2 -o -\f2\-genkey\fP, renamed to \f2\-genkeypair\fP -.TP 2 -o -\f2\-import\fP, renamed to \f2\-importcert\fP -.RE +All X\&.509 certificates have the following data, in addition to the signature: -.LP -.LP -Commands deemed obsolete and no longer documented: -.LP -.RS 3 -.TP 2 -o -.na -\f2\-keyclone\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#keycloneCmd -.TP 2 -o -.na -\f2\-identitydb\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#identitydbCmd -.TP 2 -o -.na -\f2\-selfcert\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#selfcertCmd -.RE +\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. -.LP - +X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. + +X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. + +X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. + +\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. + +\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. + +\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. + +\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. + +\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, +.sp +.nf +\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. + +\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. +.TP +Certificate Chains +The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. + +When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. + +Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. + +In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. + +Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. + +A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. + +The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. +.TP +The cacerts Certificates File +A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. + +The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: +.sp +.nf +\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. + +\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. + +To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file +.TP +Internet RFC 1421 Certificate Encoding Standard +Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. + +Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. + +The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. + +In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: +.sp +.nf +\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3encoded certificate goes here\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +X\&.500 Distinguished Names +X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: + +\fIcommonName\fR: The common name of a person such as Susan Jones\&. + +\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. + +\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. + +\fIstateName\fR: State or province name, for example, California\&. + +\fIcountry\fR: Two-letter country code, for example, CH\&. + +When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: +.sp +.nf +\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP +.fi +.nf +\f3\fP +.fi +.sp + + +All the italicized items represent actual values and the previous keywords are abbreviations for the following: +.sp +.nf +\f3CN=commonName\fP +.fi +.nf +\f3OU=organizationUnit\fP +.fi +.nf +\f3O=organizationName\fP +.fi +.nf +\f3L=localityName\fP +.fi +.nf +\f3S=stateName\fP +.fi +.nf +\f3C=country\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample distinguished name string is: +.sp +.nf +\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample command using such a string is: +.sp +.nf +\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP +.fi +.nf +\f3S=California, C=US" \-alias mark\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. + +Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: +.sp +.nf +\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: +.sp +.nf +\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. +.SH WARNINGS +.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING +\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. +.PP +Windows Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file \etmp\ecert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.sp + +.PP +Oracle Solaris Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file /tmp/cert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.nf +\f3\fP +.fi +.sp +Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. +.PP +\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS PASSWORDS\ WARNING +Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. +.SS CERTIFICATE\ CONFORMANCE\ WARNING +The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt +.PP +The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. +.SH NOTES +.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE +Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. +.PP +If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. +.PP +If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS IMPORT\ A\ CERTIFICATE\ REPLY +When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. +.PP +The methods of determining whether the certificate reply is trusted are as follows: +.TP 0.2i +\(bu +If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. +.TP 0.2i +\(bu +If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. +.PP +If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. +.PP +This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/native2ascii.1 b/jdk/src/linux/doc/man/native2ascii.1 index 54beff1d0ab..7e7ec7cfaa9 100644 --- a/jdk/src/linux/doc/man/native2ascii.1 +++ b/jdk/src/linux/doc/man/native2ascii.1 @@ -1,72 +1,87 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH native2ascii 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Internationalization Tools +.\" Title: native2ascii.1 +.\" +.if n .pl 99999 +.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -native2ascii \- Native\-to\-ASCII Converter -.LP -.LP -Converts a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes, or visa versa. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f4native2ascii\fP\f2 [options] [inputfile [outputfile]]\fP -.fl -.fi +.SH NAME +native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f2native2ascii\fP converts files that are encoded to any character encoding that is supported by the Java runtime environment to files encoded in ASCII, using Unicode escapes ("\\uxxxx" notation) for all characters that are not part of the ASCII character set. This process is required for properties files containing characters not in ISO\-8859\-1 character sets. The tool can also perform the reverse conversion. -.LP -.LP -If \f2outputfile\fP is omitted, standard output is used for output. If, in addition, \f2inputfile\fP is omitted, standard input is used for input. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-reverse -Perform the reverse operation: Convert a file encoded in ISO\-8859\-1 with Unicode escapes to a file in any character encoding supported by the Java runtime environment. +\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] +.fi +.sp +.TP +\fIinputfile\fR +The encoded file to be converted to ASCII\&. +.TP +\fIoutputfile\fR +The converted ASCII file\&. +.SH DESCRIPTION +The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. +.PP +If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. +.SH OPTIONS +.TP +-reverse .br +Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. +.TP +-encoding \fIencoding_name\fR .br -.TP 3 -\-encoding encoding_name -Specifies the name of the character encoding to be used by the conversion procedure. If this option is not present, the default character encoding (as determined by the \f2java.nio.charset.Charset.defaultCharset\fP method) is used. The \f2encoding_name\fP string must be the name of a character encoding that is supported by the Java runtime environment \- see the -.na -\f4Supported Encodings\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html document. +Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html +.TP +-J\fIoption\fR .br -.br -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP - +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/orbd.1 b/jdk/src/linux/doc/man/orbd.1 index 108ad9e1ce2..1575df4bdea 100644 --- a/jdk/src/linux/doc/man/orbd.1 +++ b/jdk/src/linux/doc/man/orbd.1 @@ -1,368 +1,214 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH orbd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: orbd.1 +.\" +.if n .pl 99999 +.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -orbd \- The Object Request Broker Daemon -.LP -.LP -\f3orbd\fP is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. -.LP -.LP -\f3See also:\fP -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -orbd <\fP\f3options\fP\f3> -.fl -\fP -.fi +.SH NAME +orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The Server Manager included with the \f3orbd\fP tool is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. The persistent servers, while publishing the persistent object references in the Naming Service, include the port number of the ORBD in the object reference instead of the port number of the Server. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages: -.LP -.RS 3 -.TP 2 -o -The object reference in the Naming Service remains independent of the server life cycle. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shutdown, the ORBD will always return the correct object reference to the invoking client. -.TP 2 -o -The client needs to lookup the object reference in the Naming Service only once, and can keep re\-using this reference independent of the changes introduced due to server life cycle. -.RE - -.LP -.LP -To access ORBD's Server Manager, the server must be started using servertool(1), which is a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. For more information on the Server Manager, see the section in this document titled \f2Server Manager\fP. -.LP -.LP -When \f2orbd\fP starts up, it also starts a naming service. For more information on the naming service, link to -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html. -.LP -.SH "OPTIONS" -.LP -.SS -Required Options -.LP -.RS 3 -.TP 3 -\-ORBInitialPort nameserverport -Specifies the port on which the name server should be started. Once started, \f2orbd\fP will listen for incoming requests on this port. Note that when using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. (required) -.RE - -.LP -.LP - -.LP -.SS -OTHER OPTIONS -.LP -.RS 3 -.TP 3 -\-port port -Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects. The default value for this port is 1049. This port number is added to the port field of the persistent Interoperable Object References (IOR). (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-defaultdb directory -Specifies the base where the ORBD persistent storage directory \f2orb.db\fP is created. If this option is not specified, the default value is "./orb.db". (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-serverPollingTime milliseconds -Specifies how often ORBD checks for the health of persistent servers registered via \f2servertool\fP. The default value is 1,000 ms. The value specified for \f2milliseconds\fP must be a valid positive integer. (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-serverStartupDelay milliseconds -Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered via \f2servertool\fP is restarted. The default value is 1,000 ms. The value specified for \f2milliseconds\fP must be a valid positive integer. (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.TP 3 - -.RE - -.LP -.SH "Starting and Stopping the Naming Service" -.LP -.LP -A Naming Service is a CORBA service that allows -.na -\f2CORBA objects\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#CORBA%20object to be named by means of binding a name to an object reference. The -.na -\f2name binding\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#name%20binding may be stored in the naming service, and a client may supply the name to obtain the desired object reference. -.LP -.LP -Prior to running a client or a server, you will start ORBD. ORBD includes a persistent Naming Service and a transient Naming Service, both of which are an implementation of the COS Naming Service. -.LP -.LP -The \f4Persistent\fP\f3 Naming Service\fP provides persistence for naming contexts. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure. If ORBD is restarted, the Persistent Naming Service will restore the naming context graph, so that the binding of all clients' and servers' names remains intact (persistent). -.LP -.LP -\ -.LP -.LP -For backward compatibility, \f2tnameserv\fP, a \f4Transient\fP\f3 Naming Service\fP shipped with older versions of the JDK, is also included in this release of J2SE. A transient naming service retains naming contexts as long as it is running. If there is a service interruption, the naming context graph is lost. -.LP -.LP -The \f2\-ORBInitialPort\fP argument is a required command\-line argument for \f2orbd\fP, and is used to set the port number on which the Naming Service will run. The following instructions assume you can use port 1050 for the Java\ IDL Object Request Broker Daemon. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. You can substitute a different port if necessary. -.LP -.LP -To start \f2orbd\fP from a UNIX command shell, enter: -.LP -.nf -\f3 -.fl - orbd \-ORBInitialPort 1050& -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Now that ORBD is running, you can run your server and client applications. When running the client and server applications, they must be made aware of the port number (and machine name, if applicable) where the Naming Service is running. One way to do this is to add the following code to your application: -.LP -.nf -\f3 -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - props.put("org.omg.CORBA.ORBInitialHost", "MyHost"); -.fl - ORB orb = ORB.init(args, props); -.fl -\fP -.fi - -.LP -.LP -In this example, the Naming Service is running on port 1050 on host "MyHost". Another way is to specify the port number and/or machine name when running the server or client application from the command line. For example, you would start your "HelloApplication" with the following command line: -.LP -.nf -\f3 -.fl - java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost -.fl -\fP -.fi - -.LP -.LP -To stop the naming service, use the relevant operating system command, such as \f2pkill orbd\fP on Solaris, or \f2Ctrl+C\fP in the DOS window in which \f2orbd\fP is running. Note that names registered with the naming service may disappear when the service is terminated if the naming service is transient. The Java IDL naming service will run until it is explicitly stopped. -.LP -.LP -For more information on the Naming Service included with ORBD, see -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html. -.LP -.SH "Server Manager" -.LP -.LP -To access ORBD's Server Manager and run a persistent server, the server must be started using servertool(1), which is a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. When a server is started using \f2servertool\fP, it must be started on the same host and port on which \f2orbd\fP is executing. If the server is run on a different port, the information stored in the database for local contexts will be invalid and the service will not work properly. -.LP -.SS -Server Manager: an Example -.LP -.LP -Using the -.na -\f2sample tutorial\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlExample.html for our demonstration, you would run the \f2idlj\fP compiler and \f2javac\fP compiler as shown in the tutorial. To run the Server Manager, follow these steps for running the application: -.LP -.LP -Start \f2orbd\fP. -.LP -.LP -To start \f2orbd\fP from a UNIX command shell, enter: -.LP -.LP -\ -.LP -.nf -\f3 -.fl - orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Note that \f21050\fP is the port on which you want the name server to run. \f2\-ORBInitialPort\fP is a required command\-line argument. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. -.LP -.LP -Start the \f2servertool\fP: -.LP -.LP -To start the Hello server, enter: -.LP -.nf -\f3 -.fl - servertool \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Make sure the name server (\f2orbd\fP) port is the same as in the previous step, for example, \f2\-ORBInitialPort 1050\fP. The \f2servertool\fP must be started on the same port as the name server. -.LP -.LP -The \f2servertool\fP command line interface appears. -.LP -.LP - -.LP -.LP -Start the Hello server from the \f2servertool\fP prompt: -.LP -.nf -\f3 -.fl - servertool > register \-server HelloServer \-classpath . \-applicationName -.fl - HelloServerApName -.fl -\fP -.fi - -.LP -.LP -The \f2servertool\fP registers the server, assigns it the name of "HelloServerApName", and displays its server id, along with a listing of all registered servers. -.LP -.LP - -.LP -.LP -Run the client application from another terminal window or prompt: -.LP -.LP -\ -.LP -.nf -\f3 -.fl - java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost -.fl -\fP -.fi - -.LP -.LP -For this example, you can omit \f2\-ORBInitialHost localhost\fP since the name server is running on the same host as the Hello client. If the name server is running on a different host, use \f2\-ORBInitialHost\fP \f2nameserverhost\fP to specify the host on which the IDL name server is running. -.LP -.LP -Specify the name server (\f2orbd\fP) port as done in the previous step, for example, \f2\-ORBInitialPort 1050\fP. -.LP -.LP -\ -.LP -.LP -\ -.LP -.LP -When you have finished experimenting with the Server Manager, be sure to shut down or kill the name server (\f2orbd\fP) and \f2servertool\fP. -.LP -.LP -To shut down \f2orbd\fP from a DOS prompt, select the window that is running the server and enter \f2Ctrl+C\fP to shut it down. To shut down \f2orbd\fPfrom a Unix shell, find the process, and kill it. The server will continue to wait for invocations until it is explicitly stopped. -.LP -.LP -To shut down the \f2servertool\fP, type \f2quit\fP and press the \f2Enter\fP key on the keyboard. -.LP -.SH "See Also" -.LP -.RS 3 -.TP 2 -o -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html +\fBorbd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The persistent servers, while publishing the persistent object references in the naming service, include the port number of the ORBD in the object reference instead of the port number of the server\&. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages: +.TP 0.2i +\(bu +The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. +.TP 0.2i +\(bu +The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. +.PP +To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. +.PP +When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. +.SH OPTIONS +.TP +-ORBInitialPort \fInameserverport\fR .br -.TP 2 -o -servertool(1) -.RE - -.LP +Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. +.SS NONREQUIRED\ OPTIONS +.TP +-port \fIport\fR .br - -.LP - +Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. +.TP +-defaultdb \fIdirectory\fR +.br +Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. +.TP +-serverPollingTime \fImilliseconds\fR +.br +Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-serverStartupDelay milliseconds +.br +Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE +A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. +.PP +Before running a client or a server, you will start ORBD\&. ORBD includes a persistent naming service and a transient naming service, both of which are an implementation of the COS Naming Service\&. +.PP +The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. +.PP +For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. +.PP +The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. +.PP +To start \f3orbd\fR from a UNIX command shell, enter: +.sp +.nf +\f3orbd \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start orbd \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: +.sp +.nf +\f3Properties props = new Properties();\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP +.fi +.nf +\f3ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: +.sp +.nf +\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP +.fi +.nf +\f3\fP +.fi +.sp +To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. +.PP +For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.SH SERVER\ MANAGER +To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. +.PP +See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html +.PP +In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: +.PP +Start \f3orbd\fR\&. +.PP +UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. +.PP +MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. +.PP +Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. +.PP +Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. +.PP +Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. +.PP +In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: +.sp +.nf +\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP +.fi +.nf +\f3 HelloServerApName\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: +.sp +.nf +\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP +.fi +.nf +\f3\fP +.fi +.sp +For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. +.PP +To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +servertool(1) +.TP 0.2i +\(bu +Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/pack200.1 b/jdk/src/linux/doc/man/pack200.1 index 8f34d6dd51a..f414cdb6170 100644 --- a/jdk/src/linux/doc/man/pack200.1 +++ b/jdk/src/linux/doc/man/pack200.1 @@ -1,340 +1,291 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH pack200 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: pack200.1 +.\" +.if n .pl 99999 +.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -pack200 \- JAR Packing tool -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4pack200\fP\f2 [ \fP\f2options\fP ] \f2output\-file\fP \f2JAR\-file\fP -.LP -.LP -Options may be in any order. The last option on the command line or in a properties file supersedes all previously specified options. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -output\-file -Name of the output file. -.TP 3 -JAR\-file -Name of the input file. -.RE +.SH NAME +pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f2pack200\fP tool is a Java application that transforms a JAR file into a compressed \f2pack200\fP file using the Java \f2gzip\fP compressor. The \f2pack200\fP files are highly compressed files that can be directly deployed, saving bandwidth and reducing download time. -.LP -.LP -The \f2pack200\fP tool uses several options to fine\-tune and set the compression engine. -.LP -.SS -Typical usage: -.LP -.LP -\f2% pack200 myarchive.pack.gz myarchive.jar\fP -.LP -.LP -In this example, \f2myarchive.pack.gz\fP is produced using the default \f2pack200\fP settings. -.LP -.SH "OPTIONS" -.LP -.LP -\f4\-r \-\-repack\fP -.LP -.LP -Produces a JAR file by packing the file \f2myarchive.jar\fP and unpacking it. The resulting file can be used as an input to the \f2jarsigner(1)\fP tool. -.LP -.LP -\f2% pack200 \-\-repack myarchive\-packer.jar myarchive.jar\fP -.LP -.LP -\f2% pack200 \-\-repack myarchive.jar\fP -.LP -.LP -\f4\-g \-\-no\-gzip\fP -.LP -.LP -Produces a \f2pack200\fP file. With this option a suitable compressor must be used, and the target system must use a corresponding decompresser. -.LP -.LP -\f2% pack200 \-\-no\-gzip myarchive.pack myarchive.jar\fP -.LP -.LP -\f4\-G \-\-strip\-debug\fP -.LP -.LP -Strips attributes used for debugging from the output. These include \f2SourceFile\fP, \f2LineNumberTable\fP, \f2LocalVariableTable\fP and \f2LocalVariableTypeTable\fP. Removing these attributes reduces the size of both downloads and installations but reduces the usefulness of debuggers. -.LP -.LP -\f4\-\-keep\-file\-order\fP -.LP -.LP -Preserve the order of files in the input file; this is the default behavior. -.LP -.LP -\f4\-O \-\-no\-keep\-file\-order\fP -.LP -.LP -The packer will reorder and transmit all elements. Additionally, the packer may remove JAR directory names. This will reduce the download size; however, certain JAR file optimizations, such as indexing, may not work correctly. -.LP -.LP -\f4\-Svalue \-\-segment\-limit=\fP\f2value\fP -.LP -.LP -The value is the estimated target size N (in bytes) of each archive segment. If a single input file requires +\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR +.fi +.sp +Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIoutput-file\fR +Name of the output file\&. +.TP +\fIJAR-file\fR +Name of the input file\&. +.SH DESCRIPTION +The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. +.PP +The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: +.sp +.nf +\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-r, --repack .br -more than N bytes, it will be given its own archive segment. As a special case, a value of \f2\-1\fP will produce a single large segment with all input files, while a value of \f20\fP will produce one segment for each class. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory. -.LP -.LP -The size of each segment is estimated by counting the size of each input file to be transmitted in the segment, along with the size of its name and other transmitted properties. -.LP -.LP -The default is \-1, which means the packer will always create a single segment output file. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs. -.LP -.LP -A 10MB JAR packed without this limit will typically pack about 10% smaller, but the packer may require a larger Java heap (about ten times the segment limit). -.LP -.LP -\f4\-Evalue \-\-effort=\fP\f2value\fP -.LP -.LP -If the value is set to a single decimal digit, the packer will use the indicated amount of effort in compressing the archive. Level \f21\fP may produce somewhat larger size and faster compression speed, while level \f29\fP will take much longer but may produce better compression. The special value \f20\fP instructs the packer to copy through the original JAR file directly with no compression. The JSR 200 standard requires any unpacker to understand this special case as a pass\-through of the entire archive. -.LP -.LP -The default is \f25\fP, investing a modest amount of time to produce reasonable compression. -.LP -.LP -\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP -.LP -.LP -Overrides the default, which preserves the input information, but may cause the transmitted archive to be larger. The possible values are: -.LP -.RS 3 -.TP 3 -true -.TP 3 -false -In either case, the packer will set the deflation hint accordingly in the output archive, and will not transmit the individual deflation hints of archive elements. -.RE +Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: +.sp +.nf +\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP +.fi +.nf +\f3pack200 \-\-repack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.RS 3 -.TP 3 -keep -Preserve deflation hints observed in the input JAR. (This is the default.) -.RE -.LP -.LP -\f4\-mvalue \-\-modification\-time=\fP\f2value\fP -.LP -.LP -The possible values are: -.LP -.RS 3 -.TP 3 -latest -The packer will attempt to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment. This single value will be transmitted as part of the segment and applied to all the entries in each segment. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date. -.TP 3 -keep -Preserves modification times observed in the input JAR. (This is the default.) -.RE +The following example preserves the order of files in the input file\&. +.TP +-g, --no-gzip +.br +Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. +.sp +.nf +\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -\f4\-Pfile \-\-pass\-file=\fP\f2file\fP -.LP -.LP -Indicates that a file should be passed through bytewise with no compression. By repeating the option, multiple files may be specified. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator "\f2/\fP". The resulting file names must match exactly as strings with their occurrences in the JAR file. If file is a directory name, all files under that directory will be passed. -.LP -.LP -\f4\-Uaction \-\-unknown\-attribute=\fP\f2action\fP -.LP -.LP -Overrides the default behavior; i.e., the classfile containing the unknown attribute will be passed through with the specified action. The possible values for actions are: -.LP -.RS 3 -.TP 3 -error -The \f2pack200\fP operation as a whole will fail with a suitable explanation. -.TP 3 -strip -The attribute will be dropped. Note: Removing the required VM attributes may cause Class Loader failures. -.TP 3 -pass -Upon encountering this attribute, the entire class will be transmitted as though it is a resource. -.RE +.TP +-G, --strip-debug +.br +Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. +.TP +--keep-file-order +.br +Preserve the order of files in the input file\&. This is the default behavior\&. +.TP +-O, --no-keep-file-order +.br +The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. +.TP +-S\fIvalue\fR , --segment-limit=\fIvalue\fR +.br +The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. -.LP -.LP -\f4\-Cattribute\-name=\fP\f2layout\fP \f3\-\-class\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Fattribute\-name=\fP\f2layout\fP \f3\-\-field\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Mattribute\-name=\fP\f2layout\fP \f3\-\-method\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Dattribute\-name=\fP\f2layout\fP \f3\-\-code\-attribute=\fP\f2attribute\-name=action\fP -.LP -.LP -With the above four options, the attribute layout can be specified for a class entity, such as Class attribute, Field attribute, Method attribute, and Code attribute. The attribute\-name is the name of the attribute for which the layout or action is being defined. The possible values for action are: -.LP -.RS 3 -.TP 3 -some\-layout\-string -The layout language is defined in the JSR 200 specification. -.LP -Example: \f2\-\-class\-attribute=SourceFile=RUH\fP -.TP 3 -error -Upon encountering this attribute, the pack200 operation will fail with a suitable explanation. -.TP 3 -strip -Upon encountering this attribute, the attribute will be removed from the output. Note: removing VM\-required attributes may cause Class Loader failures. -.RE +The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. -.LP -.LP -Example: \f2\-\-class\-attribute=CompilationID=pass\fP will cause the class file containing this attribute to be passed through without further action by the packer. -.LP -.LP -\f4\-f\fP\f2 \fP\f2pack.properties\fP \f3\-\-config\-file=\fP\f2pack.properties\fP -.LP -.LP -A configuration file, containing Java properties to initialize the packer, may be specified on the command line. -.LP -.LP -\f2% pack200 \-f pack.properties myarchive.pack.gz myarchive.jar\fP +The default is -1, which means that the packer creates a single segment output file\&. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs\&. + +A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. +.TP +-E\fIvalue\fR , --effort=\fIvalue\fR .br -\f2% more pack.properties\fP +If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command to copy through the original JAR file directly with no compression\&. The JSR 200 standard requires any unpacker to understand this special case as a pass-through of the entire archive\&. + +The default is 5, to invest a modest amount of time to produce reasonable compression\&. +.TP +-H\fIvalue\fR , --deflate-hint=\fIvalue\fR .br -\f2# Generic properties for the packer.\fP +Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. + +If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. + +The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. +.TP +-m\fIvalue\fR , --modification-time=\fIvalue\fR .br -\f2modification.time=latest\fP +The possible values are \f3latest\fR and \f3keep\fR\&. + +If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. + +If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. +.TP +-P\fIfile\fR , --pass-file=\fIfile\fR .br -\f2deflate.hint=false\fP +Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. +.TP +-U\fIaction\fR , --unknown-attribute=\fIaction\fR .br -\f2keep.file.order=false\fP +Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. + +If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. + +If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +.nf +-C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR .br -\f2# This option will cause the files bearing new attributes to\fP -.br -\f2# be reported as an error rather than passed uncompressed.\fP -.br -\f2unknown.attribute=error\fP -.br -\f2# Change the segment limit to be unlimited.\fP -.br -\f2segment.limit=\-1\fP -.LP -.LP -\f4\-v \-\-verbose\fP -.LP -.LP -Outputs minimal messages. Multiple specification of this option will output more verbose messages. -.LP -.LP -\f4\-q \-\-quiet\fP -.LP -.LP -Specifies quiet operation with no messages. -.LP -.LP -\f4\-lfilename \-\-log\-file=\fP\f2filename\fP -.LP -.LP -Specifies a log file to output messages. -.LP -.LP -\f4\-? \-h \-\-help\fP -.LP -.LP -Prints help information about this command. -.LP -.LP -\f4\-V \-\-version\fP -.LP -.LP -Prints version information about this command. -.LP -.LP -\f4\-J\fP\f2option\fP -.LP -.LP -Passes \f2option\fP to the Java launcher called by \f2pack200\fP. For example, \f2\-J\-Xms48m\fP sets the startup memory to 48 megabytes. Although it does not begin with \f2\-X\fP, it is not a standard option of \f2pack200\fP. It is a common convention for \f2\-J\fP to pass options to the underlying VM executing applications written in Java. -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are returned: -.LP -.LP -\f2\ 0\fP for successful completion; -.LP -.LP -\f2>0\fP if an error occurs. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -unpack200(1) -.TP 2 -o -.na -\f2Java SE Documentation\fP @ .fi -http://download.oracle.com/javase/7/docs/index.html -.TP 2 -o -.na -\f2Java Deployment Guide \- Pack200\fP @ +See next option\&. +.TP +.nf +-F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR +.br .fi -http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html -.TP 2 -o -jar(1) \- Java Archive Tool -.TP 2 -o -jarsigner(1) \- JAR Signer tool -.TP 2 -o -\f2attributes(5)\fP man page -.RE +See next option\&. +.TP +.nf +-M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. -.LP -.SH "NOTES" -.LP -.LP -This command should not be confused with \f2pack(1)\fP. They are distinctly separate products. -.LP -.LP -The Java SE API Specification provided with the JDK is the superseding authority, in case of discrepancies. -.LP - +\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. + +If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. + +If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +-f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR +.br +A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. +.sp +.nf +\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3more pack\&.properties\fP +.fi +.nf +\f3# Generic properties for the packer\&.\fP +.fi +.nf +\f3modification\&.time=latest\fP +.fi +.nf +\f3deflate\&.hint=false\fP +.fi +.nf +\f3keep\&.file\&.order=false\fP +.fi +.nf +\f3# This option will cause the files bearing new attributes to\fP +.fi +.nf +\f3# be reported as an error rather than passed uncompressed\&.\fP +.fi +.nf +\f3unknown\&.attribute=error\fP +.fi +.nf +\f3# Change the segment limit to be unlimited\&.\fP +.fi +.nf +\f3segment\&.limit=\-1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-v, --verbose +.br +Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. +.TP +-q, --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-l\fIfilename\fR , --log-file=\fIfilename\fR +.br +Specifies a log file to output messages\&. +.TP +-?, -h, --help +.br +Prints help information about this command\&. +.TP +-V, --version +.br +Prints version information about this command\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. +.SH NOTES +This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +unpack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/policytool.1 b/jdk/src/linux/doc/man/policytool.1 index 8fd33bcdbf4..a82f7be956c 100644 --- a/jdk/src/linux/doc/man/policytool.1 +++ b/jdk/src/linux/doc/man/policytool.1 @@ -1,89 +1,115 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH policytool 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: policytool.1 +.\" +.if n .pl 99999 +.TH policytool 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -policytool \- PolicyTool Administration GUI Utility -.LP -\f3policytool\fP reads and writes a plain text policy file based on user input via the utility GUI. -.SH "SYNOPSIS" -.LP -.RS 3 -.TP 3 -\ -.TP 3 -Run the policytool Administrator's utility -\f4policytool\fP -.TP 3 -Run policytool and load the specified policy file -\f4policytool\fP\f2[\-file\ \fP\f2filename\fP\f2]\fP -.TP 3 -\ -.TP 3 -where: -.RS 3 -.TP 3 -file -directs \f2policytool\fP to load a local policy file -.TP 3 -filename -The file name -.RE -.SH "DESCRIPTION" -.LP -\f3policytool\fP is a GUI that allows users to create and manage policy files. For details, see -.na -\f2the Policytool Users Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html. -.SH "OPTIONS" -.RS 3 -.TP 3 -file -Loads \f2filename\fP. -.SH "SEE ALSO" -.na -\f2Default Policy Implementation and Syntax\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html -.br -.na -\f2Policy Tool Users' Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html -.br -.na -\f2Security Permissions\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/permissions.html -.br -.na -\f2Security Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/overview/jsoverview.html -.br -.RE -.RE +.SH NAME +policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. +.SH SYNOPSIS +.sp +.nf -.LP - +\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] +.fi +.sp +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.TP +\fIfilename\fR +The name of the file to be loaded\&. +.PP +\fIExamples\fR: +.PP +Run the policy tool administrator utility: +.sp +.nf +\f3policytool\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3policytool\fR command and load the specified file: +.sp +.nf +\f3policytool\-file mypolicyfile\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH DESCRIPTION +The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.SH OPTIONS +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.TP 0.2i +\(bu +Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html +.TP 0.2i +\(bu +Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html +.TP 0.2i +\(bu +Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html +.TP 0.2i +\(bu +Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/rmic.1 b/jdk/src/linux/doc/man/rmic.1 index 95f166206f2..9f7397edb54 100644 --- a/jdk/src/linux/doc/man/rmic.1 +++ b/jdk/src/linux/doc/man/rmic.1 @@ -1,227 +1,224 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmic 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmic.1 +.\" +.if n .pl 99999 +.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmic \- The Java RMI Compiler -.LP -.LP -\f3rmic\fP generates stub, skeleton, and tie classes for remote objects using either the JRMP or IIOP protocols. Also generates OMG IDL. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmic [ \fP\f3options\fP\f3 ] \fP\f4package\-qualified\-class\-name(s)\fP\f3 -.fl -\fP -.fi +.SH NAME +rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmic\fP compiler generates stub and skeleton class files (JRMP protocol) and stub and tie class files (IIOP protocol) for remote objects. These classes files are generated from compiled Java programming language classes that are remote object implementation classes. A remote implementation class is a class that implements the interface \f2java.rmi.Remote\fP. The class names in the \f3rmic\fP command must be for classes that have been compiled successfully with the \f3javac\fP command and must be fully package qualified. For example, running \f3rmic\fP on the class file name \f2HelloImpl\fP as shown here: -.LP -.nf -\f3 -.fl -rmic hello.HelloImpl -.fl -\fP -.fi +\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line \f3options\fR\&. See Options\&. +.TP +\fIpackage-qualified-class-names\fR +Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. +.SH DESCRIPTION +\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. +.PP +The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class files are generated from compiled Java programming language classes that are remote object implementation classes\&. A remote implementation class is a class that implements the interface \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): +.sp +.nf +\f3rmic hello\&.HelloImpl\fP +.fi +.nf +\f3\fP +.fi +.sp +A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. +.PP +A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. +.PP +A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. +.PP +By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. +.PP +A stub implements only the remote interfaces, and not any local interfaces that the remote object also implements\&. Because a JRMP stub implements the same set of remote interfaces as the remote object, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. +.SH OPTIONS +.TP +-bootclasspath \fIpath\fR +.br +Overrides the location of bootstrap class files\&. +.TP +-classpath path +.br +Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. +.TP +-d \fIdirectory\fR +.br +Specifies the root destination directory for the generated class hierarchy\&. You can use this option to specify a destination directory for the stub, skeleton, and tie files\&. For example, the following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. +.sp +.nf +\f3rmic \-d /java/classes exampleclass\&.MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -creates the \f2HelloImpl_Stub.class\fP file in the \f2hello\fP subdirectory (named for the class's package). -.LP -.LP -A \f2skeleton\fP for a remote object is a JRMP protocol server\-side entity that has a method that dispatches calls to the actual remote object implementation. -.LP -.LP -A \f2tie\fP for a remote object is a server\-side entity similar to a skeleton, but which communicates with the client using the IIOP protocol. -.LP -.LP -A \f2stub\fP is a client\-side proxy for a remote object which is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides. A client's reference to a remote object, therefore, is actually a reference to a local stub. -.LP -.LP -By default, \f3rmic\fP generates stub classes that use the 1.2 JRMP stub protocol version only, as if the \f2\-v1.2\fP option had been specified. (Note that the \f2\-vcompat\fP option was the default in releases prior to 5.0.) Use the \f2\-iiop\fP option to generate stub and tie classes for the IIOP protocol. -.LP -.LP -A stub implements only the remote interfaces, not any local interfaces that the remote object also implements. Because a JRMP stub implements the same set of remote interfaces as the remote object itself, a client can use the Java programming language's built\-in operators for casting and type checking. For IIOP, the \f2PortableRemoteObject.narrow\fP method must be used. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-bootclasspath path -Overrides location of bootstrap class files -.TP 3 -\-classpath path -Specifies the path \f3rmic\fP uses to look up classes. This option overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is: -.nf -\f3 -.fl -.:<your_path> -.fl -\fP -.fi -For example: -.nf -\f3 -.fl -.:/usr/local/java/classes -.fl -\fP -.fi -.TP 3 -\-d directory -Specifies the root destination directory for the generated class hierarchy. You can use this option to specify a destination directory for the stub, skeleton, and tie files. For example, the command -.nf -\f3 -.fl -% rmic \-d /java/classes foo.MyClass -.fl -\fP -.fi -would place the stub and skeleton classes derived from \f2MyClass\fP into the directory \f2/java/classes/foo\fP. If the \f2\-d\fP option is not specified, the default behavior is as if \f2"\-d\ ."\fP were specified: the package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it. (Note that in some previous versions of \f3rmic\fP, if \f2\-d\fP was not specified, then the package hierarchy was \f2not\fP created, and all of the output files were placed directly in the current directory.) -.br -\ -.TP 3 -\-extdirs path -Overrides location of installed extensions -.TP 3 -\-g -Enables generation of all debugging information, including local variables. By default, only line number information is generated. -.TP 3 -\-idl -Causes \f2rmic\fP to generate OMG IDL for the classes specified and any classes referenced. IDL provides a purely declarative, programming language\-independent way of specifying an object's API. The IDL is used as a specification for methods and data that can be written in and invoked from any language that provides CORBA bindings. This includes Java and C++ among others. See the -.na -\f2Java Language to IDL Mapping\fP @ -.fi -http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description. -.br -.br -When the \f2\-idl\fP option is used, other options also include: -.RS 3 -.TP 3 -\-always or \-alwaysgenerate -Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. -.TP 3 -\-factory -Uses factory keyword in generated IDL. -.TP 3 -\-idlModule\ fromJavaPackage[.class]\ toIDLModule -Specifies IDLEntity package mapping. For example:\ \f2\-idlModule foo.bar my::real::idlmod\fP. -.TP 3 -\-idlFile\ fromJavaPackage[.class]\ toIDLFile -Specifies IDLEntity file mapping. For example:\ \f2\-idlFile test.pkg.X TEST16.idl\fP.\ -.RE -.TP 3 -\-iiop -Causes \f2rmic\fP to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes. A stub class is a local proxy for a remote object and is used by clients to send calls to a server. Each remote interface requires a stub class, which implements that remote interface. A client's reference to a remote object is actually a reference to a stub. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class. Each implementation class requires a tie class. -.br -.br -Invoking \f2rmic\fP with the \f2\-iiop\fP generates stubs and ties that conform to this naming convention: -.nf -\f3 -.fl -_<implementationName>_stub.class -.fl -_<interfaceName>_tie.class -.fl -\fP -.fi -When the \f2\-iiop\fP option is used, other options also include: -.RS 3 -.TP 3 -\-always or \-alwaysgenerate -Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. -.TP 3 -\-nolocalstubs -Do not create stubs optimized for same\-process clients and servers. -.TP 3 -\-noValueMethods -Must be used with the \f2\-idl\fP option. Prevents addition of \f2valuetype\fP methods and initializers to emitted IDL. These methods and initializers are optional for \f2valuetype\fPs, and are generated unless the \f2\-noValueMethods\fP option is specified when using the \f2\-idl\fP option. -.TP 3 -\-poa -Changes the inheritance from \f2org.omg.CORBA_2_3.portable.ObjectImpl\fP to \f2org.omg.PortableServer.Servant\fP. The \f2PortableServer\fP module for the -.na -\f2Portable Object Adapter\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html (POA) defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2.3.1 ptc/00\-01\-08.pdf. -.RE -.TP 3 -\-J -Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter. -.TP 3 -\-keep or \-keepgenerated -Retains the generated \f2.java\fP source files for the stub, skeleton, and/or tie classes and writes them to the same directory as the \f2.class\fP files. -.TP 3 -\-nowarn -Turns off warnings. If used the compiler does not print out any warnings. -.TP 3 -\-nowrite -Does not write compiled classes to the file system. -.TP 3 -\-vcompat -Generates stub and skeleton classes compatible with both the 1.1 and 1.2 JRMP stub protocol versions. (This option was the default in releases prior to 5.0.) The generated stub classes will use the 1.1 stub protocol version when loaded in a JDK 1.1 virtual machine and will use the 1.2 stub protocol version when loaded into a 1.2 (or later) virtual machine. The generated skeleton classes will support both 1.1 and 1.2 stub protocol versions. The generated classes are relatively large in order to support both modes of operation. -.TP 3 -\-verbose -Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded. -.TP 3 -\-v1.1 -Generates stub and skeleton classes for the 1.1 JRMP stub protocol version only. Note that this option is only useful for generating stub classes that are serialization\-compatible with pre\-existing, statically\-deployed stub classes that were generated by the \f3rmic\fP tool from JDK 1.1 and that cannot be upgraded (and dynamic class loading is not being used). -.TP 3 -\-v1.2 -(default) Generates stub classes for the 1.2 JRMP stub protocol version only. No skeleton classes are generated with this option because skeleton classes are not used with the 1.2 stub protocol version. The generated stub classes will not work if they are loaded into a JDK 1.1 virtual machine. -.RE -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 -CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example, -.nf -\f3 -.fl -.:/usr/local/java/classes -.fl -\fP -.fi -.RE +If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. +.TP +-extdirs \fIpath\fR +.br +Overrides the location of installed extensions\&. +.TP +-g +.br +Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. +.TP +-idl +.br +Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html -.LP -.SH "SEE ALSO" -.LP -.LP -java(1), javac(1), -.na -\f2CLASSPATH\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath -.LP - +When the \f3-idl\fR option is used, other options also include: +.RS +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. +.TP 0.2i +\(bu +The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. +.TP 0.2i +\(bu +\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. +.RE + +.TP +-iiop +.br +Causes the \f3rmic\fR command to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes\&. A stub class is a local proxy for a remote object and is used by clients to send calls to a server\&. Each remote interface requires a stub class, which implements that remote interface\&. A client reference to a remote object is a reference to a stub\&. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class\&. Each implementation class requires a tie class\&. + +If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: +.sp +.nf +\f3_<implementationName>_stub\&.class\fP +.fi +.nf +\f3_<interfaceName>_tie\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.RS +.TP 0.2i +\(bu +When you use the \f3-iiop\fR option, other options also include: +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. +.TP 0.2i +\(bu +The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. +.TP 0.2i +\(bu +The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2\&.3\&.1 ptc/00-01-08\&.pdf\&..RE + +.TP +-J +.br +Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter +.TP +-keep or -keepgenerated +.br +Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. +.TP +-nowarn +.br +Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. +.TP +-nowrite +.br +Does not write compiled classes to the file system\&. +.TP +-vcompat (deprecated) +.br +Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. +.TP +-verbose +.br +Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. +.TP +-v1\&.1 (deprecated) +.br +Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. +.TP +-v1\&.2 (deprecated) +.br +(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/rmid.1 b/jdk/src/linux/doc/man/rmid.1 index 763ee378af9..0a01aa90827 100644 --- a/jdk/src/linux/doc/man/rmid.1 +++ b/jdk/src/linux/doc/man/rmid.1 @@ -1,328 +1,315 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmid 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmid.1 +.\" +.if n .pl 99999 +.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmid \- The Java RMI Activation System Daemon -.LP -.LP -\f3rmid\fP starts the activation system daemon that allows objects to be registered and activated in a virtual machine (VM). -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmid [options] -.fl -\fP -.fi +.SH NAME +rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmid\fP tool starts the activation system daemon. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a VM. See the -.na -\f2Java RMI Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/rmi/spec/rmiTOC.html and -.na -\f2Activation tutorials\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/rmi/activation/overview.html for details on how to write programs that use activatable remote objects. -.LP -.LP -The daemon can be started by executing the \f2rmid\fP command, and specifying a security policy file, as follows: -.LP -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy -.fl -\fP -.fi - -.LP -.LP -\f3Note:\fP When running Sun's implementation of \f2rmid\fP, by default you will need to specify a security policy file so that \f2rmid\fP can verify whether or not the information in each \f2ActivationGroupDesc\fP is allowed to be used to launch a VM for an activation group. Specifically, the command and options specified by the \f2CommandEnvironment\fP and any \f2Properties\fP passed to an \f2ActivationGroupDesc\fP's constructor must now be explicitly allowed in the security policy file for \f2rmid\fP. The value of the \f2sun.rmi.activation.execPolicy\fP property dictates the policy that \f2rmid\fP uses to determine whether or not the information in an \f2ActivationGroupDesc\fP may be used to launch a VM for an activation group. -.LP -.LP -Executing \f2rmid\fP by default -.LP -.RS 3 -.TP 2 -o -starts the Activator and an internal registry on the default port, 1098, and -.TP 2 -o -binds an \f2ActivationSystem\fP to the name \f2java.rmi.activation.ActivationSystem\fP in this internal registry. -.RE - -.LP -.LP -To specify an alternate port for the registry, you must specify the \f2\-port\fP option when starting up \f2rmid\fP. For example, -.LP -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy \-port 1099 -.fl -\fP -.fi - -.LP -.LP -starts the activation system daemon and a registry on the registry's default port, 1099. -.LP -.SS -Starting rmid from inetd/xinetd -.LP -.LP -An alternative to starting \f2rmid\fP from the command line is to configure \f2inetd\fP (Solaris) or \f2xinetd\fP (Linux) to start \f2rmid\fP on demand. -.LP -.LP -When \f2rmid\fP starts up, it attempts to obtain an inherited channel (inherited from \f2inetd\fP/\f2xinetd\fP) by invoking the \f2System.inheritedChannel\fP method. If the inherited channel is \f2null\fP or not an instance of \f2java.nio.channels.ServerSocketChannel\fP, then \f2rmid\fP assumes that it was not started by \f2inetd\fP/\f2xinetd\fP, and it starts up as described above. -.LP -.LP -If the inherited channel is a \f2ServerSocketChannel\fP instance, then \f2rmid\fP uses the \f2java.net.ServerSocket\fP obtained from the \f2ServerSocketChannel\fP as the server socket that accepts requests for the remote objects it exports, namely the registry in which the \f2java.rmi.activation.ActivationSystem\fP is bound and the \f2java.rmi.activation.Activator\fP remote object. In this mode, \f2rmid\fP behaves the same as when it is started from the command line, \f2except\fP: -.LP -.RS 3 -.TP 2 -o -Output printed to \f2System.err\fP is redirected to a file. This file is located in the directory specified by the \f2java.io.tmpdir\fP system property (typically \f2/var/tmp\fP or \f2/tmp\fP) with the prefix \f2"rmid\-err"\fP and the suffix \f2"tmp"\fP. -.TP 2 -o -The \f2\-port\fP option is disallowed. If this option is specified, \f2rmid\fP will exit with an error message. -.TP 2 -o -The \f2\-log\fP option is required. If this option is not specified, \f2rmid\fP will exit with an error message. -.RE - -.LP -.LP -See the man pages for \f2inetd\fP (Solaris) or \f2xinetd\fP (Linux) for details on how to configure services to be started on demand. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-C<someCommandLineOption> -Specifies an option that is passed as a command\-line argument to each child process (activation group) of \f2rmid\fP when that process is created. For example, you could pass a property to each virtual machine spawned by the activation system daemon: -.nf -\f3 -.fl - rmid \-C\-Dsome.property=value -.fl -\fP -.fi -This ability to pass command\-line arguments to child processes can be useful for debugging. For example, the following command: -.nf -\f3 -.fl - rmid \-C\-Djava.rmi.server.logCalls=true -.fl -\fP -.fi -will enable server\-call logging in all child VMs. -.LP -.TP 3 -\-J<someCommandLineOption> -Specifies an option that is passed to the \f2java\fP interpreter running \f2rmid\fP. For example, to specify that \f2rmid\fP use a policy file named \f2rmid.policy\fP, the \f2\-J\fP option can be used to define the \f2java.security.policy\fP property on \f2rmid\fP's command line, for example: -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy -.fl -\fP -.fi -.TP 3 -\-J\-Dsun.rmi.activation.execPolicy=<policy> -Specifies the policy that \f2rmid\fP employs to check commands and command\-line options used to launch the VM in which an activation group runs. Please note that this option exists only in Sun's implementation of the Java RMI activation daemon. If this property is not specified on the command line, the result is the same as if \f2\-J\-Dsun.rmi.activation.execPolicy=default\fP were specified. The possible values of \f2<policy>\fP can be \f2default\fP, \f2<policyClassName>\fP, or \f2none\fP: -.RS 3 -.TP 2 -o -\f3default (or if this property is \fP\f4unspecified\fP\f3)\fP -.LP -The default \f2execPolicy\fP allows \f2rmid\fP to execute commands with specific command\-line options only if \f2rmid\fP has been granted permission to execute those commands and options in the security policy file that \f2rmid\fP uses. Only the default activation group implementation can be used with the \f2default\fP execution policy. -.LP -\f2rmid\fP launches a VM for an activation group using the information in the group's registered activation group descriptor, an \f2ActivationGroupDesc\fP. The group descriptor specifies an optional \f2ActivationGroupDesc.CommandEnvironment\fP which includes the \f2command\fP to execute to start the activation group as well as any command line \f2options\fP to be added to the command line. By default, \f2rmid\fP uses the \f2java\fP command found in \f2java.home\fP. The group descriptor also contains \f2properties\fP overrides that are added to the command line as options defined as: -.nf -\f3 -.fl - \-D\fP\f4<property>\fP\f3=\fP\f4<value>\fP\f3 -.fl -\fP -.fi -.LP -The permission \f2com.sun.rmi.rmid.ExecPermission\fP is used to grant \f2rmid\fP permission to execute a command, specified in the group descriptor's \f2CommandEnvironment\fP to launch an activation group. The permission \f2com.sun.rmi.rmid.ExecOptionPermission\fP is used to allow \f2rmid\fP to use command\-line options, specified as properties overrides in the group descriptor or as options in the \f2CommandEnvironment\fP, when launching the activation group. -.LP -When granting \f2rmid\fP permission to execute various commands and options, the permissions \f2ExecPermission\fP and \f2ExecOptionPermission\fP need to be granted universally (i.e., granted to all code sources). -.RS 3 -.TP 3 -ExecPermission -The \f2ExecPermission\fP class represents permission for \f2rmid\fP to execute a specific \f2command\fP to launch an activation group. -.LP -\f3Syntax\fP +\fBrmid\fR [\fIoptions\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3rmid\fR command starts the activation system daemon\&. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html +.PP +Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. +.PP +Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. +.PP +To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH START\ RMID\ ON\ DEMAND +An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. +.PP +When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. +.PP +If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: +.TP 0.2i +\(bu +Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. +.TP 0.2i +\(bu +The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. +.TP 0.2i +\(bu +The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message +.PP +See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. +.SH OPTIONS +.TP +-C\fIoption\fR .br -The \f2name\fP of an \f2ExecPermission\fP is the path name of a command to grant \f2rmid\fP permission to execute. A path name that ends in "/*" indicates all the files contained in that directory (where "/" is the file\-separator character, \f2File.separatorChar\fP). A path name that ends with "/\-" indicates all files and subdirectories contained in that directory (recursively). A path name consisting of the special token "<<ALL FILES>>" matches \f3any\fP file. -.LP -\f3Note:\fP A path name consisting of a single "*" indicates all the files in the current directory, while a path name consisting of a single "\-" indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory. -.TP 3 -ExecOptionPermission -The \f2ExecOptionPermission\fP class represents permission for \f2rmid\fP to use a specific command\-line \f2option\fP when launching an activation group. The \f2name\fP of an \f2ExecOptionPermission\fP is the value of a command line option. -.LP -\f3Syntax\fP +Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: +.sp +.nf +\f3rmid \-C\-Dsome\&.property=value\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. +.sp +.nf +\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J\fIoption\fR .br -Options support a limited wildcard scheme. An asterisk signifies a wildcard match, and it may appear as the option name itself (i.e., it matches any option), or an asterisk may appear at the end of the option name only if the asterisk follows either a "." or "=". -.LP -For example: "*" or "\-Dfoo.*" or "\-Da.b.c=*" is valid, "*foo" or "\-Da*b" or "ab*" is not. -.TP 3 -Policy file for rmid -When granting \f2rmid\fP permission to execute various commands and options, the permissions \f2ExecPermission\fP and \f2ExecOptionPermission\fP need to be granted universally (i.e., granted to all code sources). It is safe to grant these permissions universally because only \f2rmid\fP checks these permissions. -.LP -An example policy file that grants various execute permissions to \f2rmid\fP is: -.nf -\f3 -.fl -grant { -.fl - permission com.sun.rmi.rmid.ExecPermission -.fl - "/files/apps/java/jdk1.7.0/solaris/bin/java"; -.fl +Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - permission com.sun.rmi.rmid.ExecPermission -.fl - "/files/apps/rmidcmds/*"; -.fl +.TP +-J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR +.br +Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. +.RS +.TP 0.2i +\(bu +default -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Djava.security.policy=/files/policies/group.policy"; -.fl +The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Djava.security.debug=*"; -.fl +The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Dsun.rmi.*"; -.fl -}; -.fl -\fP -.fi -The first permission granted allow \f2rmid\fP to execute the 1.7.0 version of the \f2java\fP command, specified by its explicit path name. Note that by default, the version of the \f2java\fP command found in \f2java.home\fP is used (the same one that \f2rmid\fP uses), and does not need to be specified in the policy file. The second permission allows \f2rmid\fP to execute any command in the directory \f2/files/apps/rmidcmds\fP. -.LP -The third permission granted, an \f2ExecOptionPermission\fP, allows \f2rmid\fP to launch an activation group that defines the security policy file to be \f2/files/policies/group.policy\fP. The next permission allows the \f2java.security.debug\fP property to be used by an activation group. The last permission allows any property in the \f2sun.rmi\fP property name hierarchy to be used by activation groups. -.LP -To start \f2rmid\fP with a policy file, the \f2java.security.policy\fP property needs to be specified on \f2rmid\fP's command line, for example: -.LP -\f2rmid \-J\-Djava.security.policy=rmid.policy\fP -.RE -.TP 2 -o -\f4<policyClassName>\fP -.LP -If the default behavior is not flexible enough, an administrator can provide, when starting \f2rmid\fP, the name of a class whose \f2checkExecCommand\fP method is executed in order to check commands to be executed by rmid. -.LP -The \f2policyClassName\fP specifies a public class with a public, no\-argument constructor and an implementation of the following \f2checkExecCommand\fP method: -.nf -\f3 -.fl - public void checkExecCommand(ActivationGroupDesc desc, -.fl - String[] command) -.fl - throws SecurityException; -.fl -\fP -.fi -Before launching an activation group, \f2rmid\fP calls the policy's \f2checkExecCommand\fP method, passing it the activation group descriptor and an array containing the complete command to launch the activation group. If the \f2checkExecCommand\fP throws a \f2SecurityException\fP, \f2rmid\fP will not launch the activation group and an \f2ActivationException\fP will be thrown to the caller attempting to activate the object. -.TP 2 -o -\f3none\fP -.LP -If the \f2sun.rmi.activation.execPolicy\fP property value is "none", then \f2rmid\fP will not perform any validation of commands to launch activation groups. -.RE -.LP -.TP 3 -\-log dir -Specifies the name of the directory the activation system daemon uses to write its database and associated information. The log directory defaults to creating a directory, \f2log\fP, in the directory in which the \f2rmid\fP command was executed. -.LP -.TP 3 -\-port port -Specifies the port \f2rmid\fP's registry uses. The activation system daemon binds the \f2ActivationSystem\fP, with the name \f2java.rmi.activation.ActivationSystem\fP, in this registry. Thus, the \f2ActivationSystem\fP on the local machine can be obtained using the following \f2Naming.lookup\fP method call: -.nf -\f3 -.fl - import java.rmi.*; -.fl - import java.rmi.activation.*; -.fl +\fIExecPermission\fR -.fl - ActivationSystem system; system = (ActivationSystem) -.fl - Naming.lookup("//:\fP\f4port\fP/java.rmi.activation.ActivationSystem"); -.fl -.fi -.TP 3 -\-stop -Stops the current invocation of \f2rmid\fP, for a port specified by the \f2\-port\fP option. If no port is specified, it will stop the \f2rmid\fP running on port 1098. -.RE +The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 -CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example: -.nf -\f3 -.fl - .:/usr/local/java/classes -.fl -\fP -.fi -.RE +\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. -.LP -.SH "SEE ALSO" -.LP -.LP -rmic(1), -.na -\f2CLASSPATH\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath, java(1) -.LP - +A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. + +\fIExecOptionPermission\fR + +The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. + +\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. + +For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. + +\fIPolicy file for rmid\fR + +When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. + +An example policy file that grants various execute permissions to the \f3rmid\fR command is: +.sp +.nf +\f3grant {\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/rmidcmds/*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.debug=*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Dsun\&.rmi\&.*";\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. + +The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. + +To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: + +\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. +.TP 0.2i +\(bu +<policyClassName> + +If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. + +The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: +.sp +.nf +\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP +.fi +.nf +\f3 throws SecurityException;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. +.TP 0.2i +\(bu +none + +If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. +.RE + +.TP +-log \fIdir\fR +.br +Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. +.TP +-port \fIport\fR +.br +Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: +.sp +.nf +\f3import java\&.rmi\&.*; \fP +.fi +.nf +\f3 import java\&.rmi\&.activation\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 ActivationSystem system; system = (ActivationSystem)\fP +.fi +.nf +\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stop +.br +Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/rmiregistry.1 b/jdk/src/linux/doc/man/rmiregistry.1 index c94d270d623..a05a5176e7d 100644 --- a/jdk/src/linux/doc/man/rmiregistry.1 +++ b/jdk/src/linux/doc/man/rmiregistry.1 @@ -1,83 +1,99 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmiregistry 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmiregistry.1 +.\" +.if n .pl 99999 +.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmiregistry \- The Java Remote Object Registry -.LP -.RS 3 -The \f3rmiregistry\fP command starts a remote object registry on the specified port on the current host. -.RE +.SH NAME +rmiregistry \- Starts a remote object registry on the specified port on the current host\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmiregistry [\fP\f4port\fP\f3] -.fl -\fP -.fi - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmiregistry\fP command creates and starts a remote object registry on the specified \f2port\fP on the current host. If \f2port\fP is omitted, the registry is started on port 1099. The \f3rmiregistry\fP command produces no output and is typically run in the background. For example: -.LP -.LP -\f2rmiregistry &\fP -.LP -.LP -A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names. Clients on local and remote hosts can then look up remote objects and make remote method invocations. -.LP -.LP -The registry is typically used to locate the first remote object on which an application needs to invoke methods. That object in turn will provide application\-specific support for finding other objects. -.LP -.LP -The methods of the \f2java.rmi.registry.LocateRegistry\fP class are used to get a registry operating on the local host or local host and port. -.LP -.LP -The URL\-based methods of the \f2java.rmi.Naming\fP class operate on a registry and can be used to look up a remote object on any host, and on the local host: bind a simple (string) name to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URLs bound in the registry. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-J -Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter. -.RE - -.LP -.SH "SEE ALSO" -.LP -java(1), -.na -\f2java.rmi.registry.LocateRegistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/rmi/registry/LocateRegistry.html and -.na -\f2java.rmi.Naming\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/rmi/Naming.html +\fBrmiregistry\fR [ \fIport\fR ] +.fi +.sp +.TP +\fIport\fR +The number of a \f3port\fR on the current host at which to start the remote object registry\&. +.SH DESCRIPTION +The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: +.sp +.nf +\f3rmiregistry &\fP +.fi +.nf +\f3\fP +.fi +.sp +A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. +.PP +The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. +.PP +The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. +.PP +The URL-based methods of the \f3java\&.rmi\&.Naming\fR class operate on a registry and can be used to look up a remote object on any host and on the local host\&. Bind a simple name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. +.SH OPTIONS +.TP +-J +.br +Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html +.TP 0.2i +\(bu +\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/schemagen.1 b/jdk/src/linux/doc/man/schemagen.1 index 59c4c97ea58..7c51558ba78 100644 --- a/jdk/src/linux/doc/man/schemagen.1 +++ b/jdk/src/linux/doc/man/schemagen.1 @@ -1,127 +1,122 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH schemagen 1 "10 May 2011" +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: schemagen.1 +.\" +.if n .pl 99999 +.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -schemagen \- Java(TM) Architecture for XML Binding Schema Generator -.LP -.LP -\f3Specification Version:\fP 2.1 +.SH NAME +schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIjava-files\fR +The Java class files to be processed\&. +.SH DESCRIPTION +The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.PP +Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. +.sp +.nf +\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP +.fi +.nf +\f3Note: Writing schema1\&.xsd\fP +.fi +.nf +\f3\fP +.fi +.sp +If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. +.SH OPTIONS +.TP +-d \fIpath\fR .br -\f3Implementation Version:\fP 2.1.3 -.LP -.SH "Launching schemagen" -.LP -.LP -The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform. -.LP -.LP -The current schema generator can process either Java source files or class files. -.LP -.LP -We also provide an Ant task to run the schema generator \- see the instructions for -.na -\f2using schemagen with Ant\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. -.LP -.nf -\f3 -.fl -% schemagen.sh Foo.java Bar.java ... -.fl -Note: Writing schema1.xsd -.fl -\fP -.fi - -.LP -.LP -If your java sources/classes reference other classes, they must be accessable on your system CLASSPATH environment variable, or they need to be given to the tool by using the \f2\-classpath\fP/\f2\-cp\fP options. Otherwise you will see errors when generating your schema. -.LP -.SS -Command Line Options -.LP -.nf -\f3 -.fl -Usage: schemagen [\-options ...] <java files> -.fl - -.fl -Options: -.fl - \-d <path> : specify where to place processor and javac generated class files -.fl - \-cp <path> : specify where to find user specified files -.fl - \-classpath <path> : specify where to find user specified files -.fl - \-encoding <encoding> : specify encoding to be used for apt/javac invocation -.fl - -.fl - \-episode <file> : generate episode file for separate compilation -.fl - \-version : display version information -.fl - \-help : display this usage message -.fl -\fP -.fi - -.LP -.SH "Generated Resource Files" -.LP -.LP -The current schema generator simply creates a schema file for each namespace referenced in your Java classes. There is no way to control the name of the generated schema files at this time. For that purpose, use -.na -\f2the schema generator ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. -.LP -.SH "Name" -See Also -.LP -.RS 3 -.TP 2 -o -Running the schema generator (schemagen): [ -.na -\f2command\-line instructions\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html, -.na -\f2using the SchemaGen Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html] -.TP 2 -o -.na -\f2Java Architecture for XML Binding (JAXB)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html -.RE - -.LP - +The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. +.TP +-cp \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-classpath \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. +.TP +-episode \fIfile\fR +.br +Generates an episode file for separate compilation\&. +.TP +-version +.br +Displays release information\&. +.TP +-help +.br +Displays a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/serialver.1 b/jdk/src/linux/doc/man/serialver.1 index cb653146ba7..ba1dfcbef84 100644 --- a/jdk/src/linux/doc/man/serialver.1 +++ b/jdk/src/linux/doc/man/serialver.1 @@ -1,97 +1,111 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH serialver 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: serialver.1 +.\" +.if n .pl 99999 +.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -serialver \- The Serial Version Command -.LP -.LP -The \f3serialver\fP command returns the \f2serialVersionUID\fP. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3serialver\fP [ options ] [ classnames ] -.fl -.fi +.SH NAME +serialver \- Returns the serial version UID for specified classes\&. +.SH SYNOPSIS +.sp +.nf -.LP -.RS 3 -.TP 3 -options -Command\-line options, as specified in this document. -.TP 3 -classnames -One or more class names -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3serialver\fP returns the \f2serialVersionUID\fP for one or more classes in a form suitable for copying into an evolving class. When invoked with no arguments it prints a usage line. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-classpath <directories and zip/jar files separated by :> -Set search path for application classes and resources. -.RE - -.LP -.RS 3 -.TP 3 -\-show -Displays a simple user interface. Enter the full class name and press either the Enter key or the Show button to display the serialVersionUID. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.SH "NOTES" -.LP -.LP -The \f3serialver\fP command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager. If \f3serialver\fP is to be run with untrusted classes, a security manager can be set with the following option: -.LP -.LP -\f2\-J\-Djava.security.manager\fP -.LP -.LP -and, if necessary, a security policy can be specified with the following option: -.LP -.LP -\f2\-J\-Djava.security.policy=<policy file>\fP -.LP -.SH "SEE ALSO" -.LP -.LP -.na -\f2java.io.ObjectStreamClass\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/io/ObjectStreamClass.html -.LP - +\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassnames\fR +The classes for which the \f3serialVersionUID\fR is to be returned\&. +.SH DESCRIPTION +The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. +.SH OPTIONS +.TP +-classpath \fIpath-files\fR +.br +Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. +.TP +-show +.br +Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.manager\fP +.fi +.nf +\f3\fP +.fi +.sp +When necessary, a security policy can be specified with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.policy=<policy file>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +policytool(1) +.TP 0.2i +\(bu +The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/servertool.1 b/jdk/src/linux/doc/man/servertool.1 index fbb0829a124..b48e407c6b3 100644 --- a/jdk/src/linux/doc/man/servertool.1 +++ b/jdk/src/linux/doc/man/servertool.1 @@ -1,113 +1,138 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH servertool 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: servertool.1 +.\" +.if n .pl 99999 +.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -servertool \- The Java(TM) IDL Server Tool -.LP -\f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -servertool \-ORBInitialPort \fP\f4nameserverport\fP\f3 \fP\f3options\fP\f3 [ \fP\f3commands\fP\f3 ] -.fl -\fP -.fi +.SH NAME +servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -If you did not enter a command when starting \f2servertool\fP, the command\-line tool displays with a \f2servertool >\fP prompt. Enter commands at the \f2servertool >\fP prompt. -.LP -.LP -If you enter a command when starting \f2servertool\fP, the Java IDL Server Tool starts, runs the command, and exits. -.LP -.LP -The \f2\-ORBInitialPort\fP \f2nameserverport\fP option is \f3required\fP. The value for \f2nameserverport\fP must specify the port on which \f2orbd\fP is running and listening for incoming requests. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024 for the \f2nameserverport\fP. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f2servertool\fP provides the command\-line interface for the application programmers to register, unregister, startup, and shutdown a persistent server. Other commands are provided to obtain various statistical information about the server. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-ORBInitialHost nameserverhost -Specifies the host machine on which the name server is running and listening for incoming requests. The \f2nameserverhost\fP defaults to \f2localhost\fP if this option is not specified. If \f2orbd\fP and \f2servertool\fP are running on different machines, you must specify the name or IP address of the host on which \f2orbd\fP is running. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.RE +\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +commands +The command-line commands\&. See Commands\&. +.SH DESCRIPTION +The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. +.SH OPTIONS +.TP +-ORBInitialHost \fInameserverhost\fR +.br +This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. -.LP -.SH "COMMANDS" -.LP -.RS 3 -.TP 3 -register \-server\ <server\ class\ name> \ \-classpath\ <classpath\ to\ server> [\ \-applicationName\ <application\ name> \-args\ <args\ to\ server> \-vmargs\ <flags\ to\ be\ passed\ to\ Java\ VM> \ ] -Register a new persistent server with the Object Request Broker Daemon (ORBD). If the server is not already registered, it is registered and activated. This command causes an install method to be invoked in the main class of the server identified by the \f2\-server\fP option. The install method must be \f2public static void install(org.omg.CORBA.ORB)\fP. The install method is optional and enables the developer to provide their own server installation behavior (for example, creating database schema). -.TP 3 -unregister \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Unregister a server from the ORBD by using either its server id or its application name. This command causes an uninstall method to be invoked in the main class of the server identified by the \f2\-server\fP option. The uninstall method must be \f2public static void uninstall(org.omg.CORBA.ORB)\fP. The uninstall method is optional and enables the developer to provide their own server uninstall behavior (for example, undoing the behavior of the install method). -.TP 3 -getserverid \-applicationName\ <application\ name> -Return the server id that corresponds with an application. -.TP 3 -list -List information about all persistent servers registered with the ORBD. -.TP 3 -listappnames -List the application names for all servers currently registered with the ORBD. -.TP 3 -listactive -List information about all persistent servers that have been launched by the ORBD and are currently running. -.TP 3 -locate \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-endpointType\ <endpointType>\ ] -Locate the endpoints (ports) of a specific type for all ORBs created by a registered server. If a server is not already running, it is activated. If an endpoint type is not specified, then the plain/non\-protected endpoint associated with each ORB in a server is returned. -.TP 3 -locateperorb \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-orbid\ <ORB\ name>\ ] -Locate all the endpoints (ports) registered by a specific ORB of registered server. If a server is not already running, then it is activated. If an \f2orbid\fP is not specified, the default value of "" is assigned to the \f2orbid\fP. If any ORBs are created with an \f2orbid\fP of empty string, all ports registered by it are returned. -.TP 3 -orblist \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Lists the ORBId of the ORBs defined on a server. An ORBId is the string name for the ORB created by the server. If the server is not already running, it is activated. -.TP 3 -shutdown \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Shutdown an active server that is registered with ORBD. During execution of this command, the \f2shutdown()\fP method defined in the class specified by either the \f2\-serverid\fP or \f2\-applicationName\fP parameter is also invoked to shutdown the server process appropriately. -.TP 3 -startup \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Startup or activate a server that is registered with ORBD. If the server is not running, this command launches the server. If the server is already running, an error message is returned to the user. -.TP 3 -help -List all the commands available to the server through the server tool. -.TP 3 -quit -Exit the server tool. -.RE - -.LP -.SH "SEE ALSO" -.LP -orbd(1) +\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH COMMANDS +You can start the \f3servertool\fR command with or without a command-line command\&. +.TP 0.2i +\(bu +If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. +.TP 0.2i +\(bu +If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. +.TP +.ll 180 +register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] +Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. +.TP +.ll 180 +unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. +.TP +getserverid -applicationName \fIapplication-name\fR +Returns the server ID that corresponds to the \f3application-name\fR value\&. +.TP +list +Lists information about all persistent servers registered with the ORBD\&. +.TP +listappnames +Lists the application names for all servers currently registered with the ORBD\&. +.TP +listactive +Lists information about all persistent servers that were started by the ORBD and are currently running\&. +.TP +.ll 180 +locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] +Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. +.TP +.ll 180 +locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] +Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. +.TP +orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. +.TP +shutdown -serverid \fIserver-id\fR | -applicationName application-name +Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. +.TP +startup -serverid \fIserver-id\fR | -applicationName application-name +Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. +.TP +help +Lists all the commands available to the server through the \f3servertool\fR command\&. +.TP +quit +Exits the \f3servertool\fR command\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/tnameserv.1 b/jdk/src/linux/doc/man/tnameserv.1 index 2279b17520e..e883ab6008a 100644 --- a/jdk/src/linux/doc/man/tnameserv.1 +++ b/jdk/src/linux/doc/man/tnameserv.1 @@ -1,494 +1,489 @@ -." Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH tnameserv 1 "10 May 2011" +'\" t +.\" Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: tnameserv.1 +.\" +.if n .pl 99999 +.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -Java IDL: Transient Naming Service \- \f2tnameserv\fP -.LP -.LP -This document discusses using the Java IDL Transient Naming Service, \f2tnameserv\fP. Java IDL also includes the Object Request Broker Daemon (ORBD). ORBD is a daemon process containing a Bootstrap Service, a Transient Naming Service, a \f3Persistent\fP Naming Service, and a Server Manager. The Java IDL tutorials all use ORBD, however, you can substitute \f2tnameserv\fP for \f2orbd\fP in any of the examples that use a Transient Naming Service. For documentation on the \f2orbd\fP tool, link to its orbd(1) or the -.na -\f2Java IDL Naming Service Included with ORBD\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html topic. -.LP -.LP -Topics in this section include: -.LP -.RS 3 -.TP 2 -o -Java\ IDL Transient Naming Service -.TP 2 -o -Starting the Java\ IDL Transient Naming Service -.TP 2 -o -Stopping the Java\ IDL Transient Naming Service -.TP 2 -o -Sample Client: Adding Objects to the Namespace -.TP 2 -o -Sample Client: Browsing the Namespace -.RE +.SH NAME +tnameserv \- Interface Definition Language (IDL)\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "Java\ IDL Transient Naming Service" -.LP -.LP -The CORBA COS (Common Object Services) Naming Service provides a tree\-like directory for object references much like a filesystem provides a directory structure for files. The Transient Naming Service provided with Java IDL, \f2tnameserv\fP, is a simple implementation of the COS Naming Service specification. -.LP -.LP -Object references are stored in the namespace by name and each object reference\-name pair is called a name \f2binding\fP. Name bindings may be organized under \f2naming contexts\fP. Naming contexts are themselves name bindings and serve the same organizational function as a file system subdirectory. All bindings are stored under the \f2initial naming context\fP. The initial naming context is the only persistent binding in the namespace; the rest of the namespace is lost if the Java IDL naming service process halts and restarts. -.LP -.LP -For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to a stringified initial naming context for that naming service. The naming service can either be the Java\ IDL naming service or another COS\-compliant naming service. -.LP -.SH "Starting the Java\ IDL Transient Naming Service" -.LP -.LP -You must start the Java\ IDL naming service before an application or applet that uses its naming service. Installation of the Java\ IDL product creates a script (Solaris: \f2tnameserv\fP) or executable file (Windows NT: \f2tnameserv.exe\fP) that starts the Java\ IDL naming service. Start the naming service so it runs in the background. -.LP -.LP -If you do not specify otherwise, the Java\ IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f2resolve_initial_references()\fP and \f2list_initial_references()\fP methods, as follows: -.LP -.nf -\f3 -.fl - tnameserv \-ORBInitialPort \fP\f4nameserverport\fP\f3& -.fl -\fP -.fi - -.LP -.LP -If you do not specify the name server port, port 900 is used by default. When running Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: -.LP -.nf -\f3 -.fl - tnameserv \-ORBInitialPort 1050& -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start tnameserv \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Clients of the name server must be made aware of the new port number. Do this by setting the \f2org.omg.CORBA.ORBInitialPort\fP property to the new port number when creating the ORB object. -.LP -.SS -Running the server and client on different hosts -.LP -.LP -In most of the Java IDL and RMI\-IIOP tutorials, the Naming Service, Server, and Client are all running on the development machine. In real world deployment, it is likely that the client and server will run on different host machines than the Naming Service. -.LP -.LP -For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running. Do this by setting the \f2org.omg.CORBA.ORBInitialPort\fP and \f2org.omg.CORBA.ORBInitialHost\fP properties in the client and server files to the machine name and port number on which the Naming Service is running. An example of this is shown in -.na -\f2The Hello World Example Using RMI\-IIOP\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/rmi\-iiop/rmiiiopexample.html. You could also use the command line options \f2\-ORBInitialPort\fP \f2nameserverport#\fP and \f2\-ORBInitialHost\fP \f2nameserverhostname\fP to tell the client and server where to find the Naming Service. -.na -\f2Java IDL: Running the Hello World Example on TWO Machines\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/tutorial/jidl2machines.html shows one way of doing this using the command line option. -.LP -.LP -For example, suppose the Transient Naming Service, \f2tnameserv\fP is running on port 1050 on host \f2nameserverhost\fP. The client is running on host \f2clienthost\fP and the server is running on host \f2serverhost\fP. -.LP -.RS 3 -.TP 2 -o -Start \f2tnameserv\fP on the host \f2nameserverhost\fP, as follows: -.nf -\f3 -.fl - tnameserv \-ORBInitialPort 1050 -.fl - -.fl -\fP -.fi -.TP 2 -o -Start the server on the \f2serverhost\fP, as follows: -.nf -\f3 -.fl - java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost -.fl -\fP -.fi -.TP 2 -o -Start the client on the \f2clienthost\fP, as follows: -.nf -\f3 -.fl - java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost -.fl -\fP -.fi -.RE - -.LP -.SS -The \-J option -.LP -This command\-line option is available for use with \f2tnameserve\fP: -.RS 3 -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.RE - -.LP -.SH "Stopping the Java\ IDL Transient Naming Service" -.LP -.LP -To stop the Java\ IDL naming service, use the relevant operating system command, such as \f2kill\fP for a Unix process, or \f2Ctrl\-C\fP for a Windows process. The naming service will continue to wait for invocations until it is explicitly shutdown. Note that names registered with the Java\ IDL naming service disappear when the service is terminated. -.LP -.SH "Sample Client: Adding Objects to the Namespace" -.LP -.LP -The following sample program illustrates how to add names to the namespace. It is a self\-contained Transient Naming Service client that creates the following simple tree. -.LP -.RS 3 -.TP 2 -o -\f4Initial Naming Context\fP -.RS 3 -.TP 2 -* -\f3plans\fP -.TP 2 -* -\f4Personal\fP -.RS 3 -.TP 2 -- -\f3calendar\fP -.TP 2 -- -\f3schedule\fP -.RE -.RE -.RE - -.LP -.LP -In this example, \f3plans\fP is an object reference and \f3Personal\fP is a naming context that contains two object references: \f3calendar\fP and \f3schedule\fP. -.LP -.nf -\f3 -.fl -import java.util.Properties; -.fl -import org.omg.CORBA.*; -.fl -import org.omg.CosNaming.*; -.fl - -.fl -public class NameClient -.fl -{ -.fl - public static void main(String args[]) -.fl - { -.fl - try { -.fl -\fP -.fi - -.LP -In the above section, Starting the Java IDL Transient Naming Service, the nameserver was started on port 1050. The following code ensures that the client program is aware of this port number. -.nf -\f3 -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - ORB orb = ORB.init(args, props); -.fl - -.fl -\fP -.fi - -.LP -This code obtains the initial naming context and assigns it to \f3ctx\fP. The second line copies \f3ctx\fP into a dummy object reference \f3objref\fP that we'll attach to various names and add into the namespace. -.nf -\f3 -.fl - NamingContext ctx = -.fl -NamingContextHelper.narrow(orb.resolve_initial_references("NameService")); -.fl - NamingContext objref = ctx; -.fl - -.fl -\fP -.fi - -.LP -This code creates a name "plans" of type "text" and binds it to our dummy object reference. "plans" is then added under the initial naming context using \f2rebind\fP. The \f2rebind\fP method allows us to run this program over and over again without getting the exceptions we'd get from using \f2bind\fP. -.nf -\f3 -.fl - NameComponent nc1 = new NameComponent("plans", "text"); -.fl - NameComponent[] name1 = {nc1}; -.fl - ctx.rebind(name1, objref); -.fl - System.out.println("plans rebind sucessful!"); -.fl - -.fl -\fP -.fi - -.LP -This code creates a naming context called "Personal" of type "directory". The resulting object reference, \f3ctx2\fP, is bound to the name and added under the initial naming context. -.nf -\f3 -.fl - NameComponent nc2 = new NameComponent("Personal", "directory"); -.fl - NameComponent[] name2 = {nc2}; -.fl - NamingContext ctx2 = ctx.bind_new_context(name2); -.fl - System.out.println("new naming context added.."); -.fl - -.fl -\fP -.fi - -.LP -The remainder of the code binds the dummy object reference using the names "schedule" and "calendar" under the "Personal" naming context (\f3ctx2\fP). -.nf -\f3 -.fl - NameComponent nc3 = new NameComponent("schedule", "text"); -.fl - NameComponent[] name3 = {nc3}; -.fl - ctx2.rebind(name3, objref); -.fl - System.out.println("schedule rebind sucessful!"); -.fl - -.fl - NameComponent nc4 = new NameComponent("calender", "text"); -.fl - NameComponent[] name4 = {nc4}; -.fl - ctx2.rebind(name4, objref); -.fl - System.out.println("calender rebind sucessful!"); -.fl - -.fl - -.fl - } catch (Exception e) { -.fl - e.printStackTrace(System.err); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi - -.LP -.SH "Sample Client: Browsing the Namespace" -.LP -.LP -The following sample program illustrates how to browse the namespace. -.LP -.nf -\f3 -.fl -import java.util.Properties; -.fl -import org.omg.CORBA.*; -.fl -import org.omg.CosNaming.*; -.fl - -.fl -public class NameClientList -.fl -{ -.fl - public static void main(String args[]) -.fl - { -.fl - try { -.fl -\fP -.fi - -.LP -In the above section, Starting the Java IDL Transient Naming Service, the nameserver was started on port 1050. The following code ensures that the client program is aware of this port number. -.nf -\f3 -.fl - -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - ORB orb = ORB.init(args, props); -.fl - -.fl - -.fl -\fP -.fi - -.LP -The following code obtains the intial naming context. -.nf -\f3 -.fl - NamingContext nc = -.fl -NamingContextHelper.narrow(orb.resolve_initial_references("NameService")); -.fl - -.fl -\fP -.fi - -.LP -The \f2list\fP method lists the bindings in the naming context. In this case, up to 1000 bindings from the initial naming context will be returned in the BindingListHolder; any remaining bindings are returned in the BindingIteratorHolder. -.nf -\f3 -.fl - BindingListHolder bl = new BindingListHolder(); -.fl - BindingIteratorHolder blIt= new BindingIteratorHolder(); -.fl - nc.list(1000, bl, blIt); -.fl - -.fl -\fP -.fi - -.LP -This code gets the array of bindings out of the returned BindingListHolder. If there are no bindings, the program ends. -.nf -\f3 -.fl - Binding bindings[] = bl.value; -.fl - if (bindings.length == 0) return; -.fl - -.fl -\fP -.fi - -.LP -The remainder of the code loops through the bindings and prints the names out. -.nf -\f3 -.fl - for (int i=0; i < bindings.length; i++) { -.fl - -.fl - // get the object reference for each binding -.fl - org.omg.CORBA.Object obj = nc.resolve(bindings[i].binding_name); -.fl - String objStr = orb.object_to_string(obj); -.fl - int lastIx = bindings[i].binding_name.length\-1; -.fl - -.fl - // check to see if this is a naming context -.fl - if (bindings[i].binding_type == BindingType.ncontext) { -.fl - System.out.println( "Context: " + -.fl -bindings[i].binding_name[lastIx].id); -.fl - } else { -.fl - System.out.println("Object: " + -.fl -bindings[i].binding_name[lastIx].id); -.fl - } -.fl - } -.fl - -.fl - } catch (Exception e) { -.fl - e.printStackTrace(System.err); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi - -.LP - +\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] +.fi +.sp +.TP +-ORBInitialPort \fInameserverport\fR +.br +The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. +.SH DESCRIPTION +Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. +.PP +See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.PP +The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. +.PP +Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. +.PP +For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. +.SS START\ THE\ NAMING\ SERVICE +You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. +.PP +If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: +.sp +.nf +\f3tnameserv \-ORBInitialPort nameserverport&\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. +.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS +In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. +.PP +For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html +.PP +You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html +.PP +For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. +.PP +Start \f3tnameserv\fR on the host \f3nameserverhost\fR: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the server on the \f3serverhost\fR: +.sp +.nf +\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the client on the \f3clienthost\fR: +.sp +.nf +\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ NAMING\ SERVICE +To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. +.SH OPTIONS +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH EXAMPLES +.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE +The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. +.sp +.nf +\f3Initial Naming Context\fP +.fi +.nf +\f3 plans\fP +.fi +.nf +\f3 Personal\fP +.fi +.nf +\f3 calendar\fP +.fi +.nf +\f3 schedule\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClient {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. +.sp +.nf +\f3 NamingContext ctx =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3 NamingContext objref = ctx;\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. +.sp +.nf +\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP +.fi +.nf +\f3 NameComponent[] name1 = {nc1};\fP +.fi +.nf +\f3 ctx\&.rebind(name1, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("plans rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. +.sp +.nf +\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP +.fi +.nf +\f3 NameComponent[] name2 = {nc2};\fP +.fi +.nf +\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP +.fi +.nf +\f3 System\&.out\&.println("new naming context added\&.\&.");\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. +.sp +.nf +\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP +.fi +.nf +\f3 NameComponent[] name3 = {nc3};\fP +.fi +.nf +\f3 ctx2\&.rebind(name3, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("schedule rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP +.fi +.nf +\f3 NameComponent[] name4 = {nc4};\fP +.fi +.nf +\f3 ctx2\&.rebind(name4, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("calender rebind successful!");\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS BROWSING\ THE\ NAME\ SPACE +The following sample program shoes how to browse the name space\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClientList {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +The following code obtains the initial naming context\&. +.sp +.nf +\f3 NamingContext nc =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. +.sp +.nf +\f3 BindingListHolder bl = new BindingListHolder();\fP +.fi +.nf +\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP +.fi +.nf +\f3 nc\&.list(1000, bl, blIt);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. +.sp +.nf +\f3 Binding bindings[] = bl\&.value;\fP +.fi +.nf +\f3 if (bindings\&.length == 0) return;\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code loops through the bindings and prints outs the names\&. +.sp +.nf +\f3 for (int i=0; i < bindings\&.length; i++) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // get the object reference for each binding\fP +.fi +.nf +\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP +.fi +.nf +\f3 String objStr = orb\&.object_to_string(obj);\fP +.fi +.nf +\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // check to see if this is a naming context\fP +.fi +.nf +\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP +.fi +.nf +\f3 System\&.out\&.println("Context: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 } else {\fP +.fi +.nf +\f3 System\&.out\&.println("Object: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err)\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/unpack200.1 b/jdk/src/linux/doc/man/unpack200.1 index ff6eb224090..2327bc02cac 100644 --- a/jdk/src/linux/doc/man/unpack200.1 +++ b/jdk/src/linux/doc/man/unpack200.1 @@ -1,156 +1,138 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH unpack200 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: unpack200.1 +.\" +.if n .pl 99999 +.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -unpack200 \- JAR Unpacking tool -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4unpack200\fP\f2 [ \fP\f2options\fP ] \f2input\-file\fP \f2JAR\-file\fP -.LP -.LP -Options may be in any order. The last option on the command line supersedes all previously specified options. -.LP -.RS 3 -.TP 3 -input\-file -Name of the input file, which can be a pack200 gzip file or a pack200 file. The input could also be JAR file produced by pack200(1) with an effort of 0. In this case the contents of the input file will be copied to the output JAR file with the Pack200 marker. -.TP 3 -JAR\-file -Name of the output JAR file. -.RE +.SH NAME +unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f2unpack200\fP is a native implementation that transforms a packed file produced by \f2pack200\fP(1) into a JAR file. Typical usage: -.LP -.LP -\f2% unpack200 myarchive.pack.gz myarchive.jar\fP -.LP -.LP -In this example, the \f2myarchive.jar\fP is produced from \f2myarchive.pack.gz\fP using the default \f2unpack200\fP settings. -.LP -.SH "OPTIONS" -.LP -.LP -\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP -.LP -.LP -Sets the deflation to be \f2true\fP, \f2false\fP, or \f2keep\fP on all entries within a JAR file. The default mode is \f2keep\fP. If \f2true\fP or \f2false\fP, overrides the default behavior and sets the deflation mode on all entries within the output JAR file. -.LP -.LP -\f4\-r \-\-remove\-pack\-file\fP -.LP -.LP -Removes the input packed file. -.LP -.LP -\f4\-v \-\-verbose\fP -.LP -.LP -Outputs minimal messages. Multiple specification of this option will output more verbose messages. -.LP -.LP -\f4\-q \-\-quiet\fP -.LP -.LP -Specifies quiet operation with no messages. -.LP -.LP -\f4\-lfilename \-\-log\-file=\fP\f2filename\fP -.LP -.LP -Specifies a log file to output messages. -.LP -.LP -\f4\-? \-h \-\-help\fP -.LP -.LP -Prints help information about this command. -.LP -.LP -\f4\-V \-\-version\fP -.LP -.LP -Prints version information about this command. -.LP -.LP -\f4\-J\fP\f2option\fP -.LP -.LP -Passes \f2option\fP to the Java launcher called by \f2unpack200\fP. -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are returned: -.LP -.LP -\f2\ 0\fP if successful completion; -.LP -.LP -\f2>0\fP if an error occurred. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -pack200(1) -.TP 2 -o -.na -\f2Java SE Documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/index.html -.TP 2 -o -.na -\f2Java Deployment Guide \- Pack200\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html -.TP 2 -o -jar(1) \- Java Archive Tool -.TP 2 -o -jarsigner(1) \- JAR Signer tool -.TP 2 -o -\f2attributes(5)\fP man page -.RE - -.LP -.SH "NOTES" -.LP -.LP -This command should not be confused with \f2unpack(1)\fP. They are distinctly separate products. -.LP -.LP -The Java SE API Specification provided with the JDK is the superseding authority, in case of discrepancies. -.LP - +\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIinput-file\fR +Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. +.TP +\fIJAR-file\fR +Name of the output JAR file\&. +.SH DESCRIPTION +The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. +.sp +.nf +\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-Hvalue --deflate-hint=\fIvalue\fR +.br +Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. +.TP +-r --remove-pack-file +.br +Removes the input pack file\&. +.TP +-v --verbose +.br +Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. +.TP +-q --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-lfilename --log-file=\fIfilename\fR +.br +Specifies a log file where output messages are logged\&. +.TP +-? -h --help +.br +Prints help information about the \f3unpack200\fR command\&. +.TP +-V --version +.br +Prints version information about the \f3unpack200\fR command\&. +.TP +-J\fIoption\fR +.br +Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html +.TP 0.2i +\(bu +The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/wsgen.1 b/jdk/src/linux/doc/man/wsgen.1 index b9f7d596a30..56776b59781 100644 --- a/jdk/src/linux/doc/man/wsgen.1 +++ b/jdk/src/linux/doc/man/wsgen.1 @@ -1,596 +1,176 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH wsgen 1 "10 May 2011" -.SH "Name" -wsgen \- Java(TM) API for XML Web Services (JAX\-WS) 2.0 -.LP -\f3Specification Version:\fP 2.1 -.br -\f3Implementation Version:\fP 2.1.1 -.LP -The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint implementation class (SEI) and generates all the required artifacts for web service deployment, and invocation -.SH "Overview" -.LP -The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment, and invocation. JAXWS 2.1.1 RI also provides a wsgen ant task, see -.na -\f2Wsgen ant task\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/wsgenant.html for details. -.LP -.SH "Launching wsgen" -.RS 3 -.TP 2 -o -\f3Solaris/Linux\fP -.RS 3 -.TP 2 -* -\f2export JAXWS_HOME=/pathto/jaxws\-ri\fP -.TP 2 -* -\f2$JAXWS_HOME/bin/wsgen.sh \-help\fP -.RE -.TP 2 -o -\f3Windows\fP -.RS 3 -.TP 2 -* -\f2set JAXWS_HOME=c:\\pathto\\jaxws\-ri\fP -.TP 2 -* -\f2%JAXWS_HOME%\\bin\\wsgen.bat \-help\fP -.RE -.RE +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsgen.1 +.\" +.if n .pl 99999 +.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Syntax" -.nf -\f3 -.fl -wsgen [options] <SEI>\fP -.br -\f3 -.fl -\fP -.fi -.LP -The following table lists the \f2wsgen\fP options. -.br -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to find input class files -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Same as \f2\-classpath <path>\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated output files -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -allow vendor extensions (functionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \-wsdl option. Specify where to place generated resource files such as WSDLs -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated source files -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Output messages about what the compiler is doing -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print version information. Use of this option will ONLY print version information. Normal processing will not occur. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -By default \f2wsgen\fP does not generate a WSDL file. This flag is optional and will cause \f2wsgen\fP to generate a WSDL file and is usually only used so that the developer can look at the WSDL before the endpoint is deploy. The \f2protocol\fP is optional and is used to specify what protocol should be used in the \f2wsdl:binding\fP. Valid protocols include: \f2soap1.1\fP and \f2Xsoap1.2\fP. The default is \f2soap1.1\fP. \f2Xsoap1.2\fP is not standard and can only be used in conjunction with the \f2\-extension\fP option. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particular \f2wsdl:service\fP name to be generated in the WSDL. Example, \f2\-servicename "{http://mynamespace/}MyService"\fP -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particular \f2wsdl:port\fP name to be generated in the WSDL. Example, \f2\-portname "{http://mynamespace/}MyPort"\fP -.br -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-classpath <path>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-cp <path>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-d <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-extension\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-help\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-keep\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-r <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-s <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-verbose\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-version\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-wsdl[:protocol]\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-servicename <name>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-portname <name>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wDisplay help -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wKeep generated files -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 133 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-classpath <path>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-cp <path>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-d <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-extension\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-help\fP\h'|\n(41u'Display help -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-keep\fP\h'|\n(41u'Keep generated files -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-r <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-s <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-verbose\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-version\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-wsdl[:protocol]\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-servicename <name>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-portname <name>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-53 +.SH NAME +wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "Example" -.nf -\f3 -.fl -\fP\f3wsgen \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -This will generate the wrapper classes needed for StockService annotated with @WebService annotation inside \f3stock\fPdirectory. -.nf -\f3 -.fl -\fP\f3wsgen \-wsdl \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -This will generate a SOAP 1.1 WSDL and schema for your Java class stock.StockService annotated with @WebService annotation. -.nf -\f3 -.fl -\fP\f3wsgen \-wsdl:Xsoap1.2 \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -Will generate a SOAP 1.2 WSDL. -.LP -Note that you do not have to generate WSDL at the development time as JAXWS runtime will automatically generate a WSDL for you when you deploy your service. +\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fISEI\fR +The web service endpoint implementation class (SEI) to be read\&. +.SH DESCRIPTION +The \f3wsgen\fR command generates JAX-WS portable artifacts used in JAX-WS web services\&. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment and invocation\&. JAXWS 2\&.1\&.1 RI also provides a \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.PP +To start the \f3wsgen\fR command, do the following: +.sp +.nf +\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP +.fi +.nf +\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +The location of the input class files\&. +.TP +-cp \fIpath\fR +.br +The location of the input class files\&. +.TP +-d \fIdirectory\fR +.br +The location for where to place generated output files\&. +.TP +-extension +.br +Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message about the \f3wsgen\fR command\&. +.TP +-keep +.br +Keeps the generated files\&. +.TP +-r \fIdirectory\fR +.br +Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. +.TP +-s \fIdirectory\fR +.br +The location for where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdl [ :protocol ] \fI\fR +.br +An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. + +By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. +.TP +-servicename \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. +.TP +-portname \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. +.SH EXAMPLES +The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. +.sp +.nf +\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. +.sp +.nf +\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.2 WSDL\&. +.sp +.nf +\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsimport(1) +.TP 0.2i +\(bu +\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/wsimport.1 b/jdk/src/linux/doc/man/wsimport.1 index 153b4986beb..edc3ef56d40 100644 --- a/jdk/src/linux/doc/man/wsimport.1 +++ b/jdk/src/linux/doc/man/wsimport.1 @@ -1,975 +1,217 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH wsimport 1 "10 May 2011" -.SH "Name" -wsimport \- Java(TM) API for XML Web Services (JAX\-WS) 2.0 -.LP -\f3Specification Version:\fP 2.1 -.br -\f3Implementation Version:\fP 2.1.1 -.br -.SH "Overview" -.LP -The \f2wsimport\fP tool generates JAX\-WS portable artifacts, such as: -.RS 3 -.TP 2 -o -Service Endpoint Interface (SEI) -.TP 2 -o -Service -.TP 2 -o -Exception class mapped from wsdl:fault (if any) -.TP 2 -o -Async Reponse Bean derived from response wsdl:message (if any) -.TP 2 -o -JAXB generated value types (mapped java classes from schema types) -.RE -.LP -These artifacts can be packaged in a WAR file with the WSDL and schema documents along with the endpoint implementation to be deployed. also provides wsimport ant task, see -.na -\f2Wsimport ant task\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/wsimportant.html. -.br +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsimport.1 +.\" +.if n .pl 99999 +.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Launching wsimport" -.RS 3 -.TP 2 -o -\f3Solaris/Linux\fP -.RS 3 -.TP 2 -* -\f2/bin/wsimport.sh \-help\fP -.RE -.TP 2 -o -\f3Windows\fP -.RS 3 -.TP 2 -* -\f2\\bin\\wsimport.bat \-help\fP -.RE -.RE +.SH NAME +wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "Syntax" -.nf -\f3 -.fl -wsimport [options] <wsdl> -.fl -\fP -.fi -.LP -The following table lists the \f2wsimport\fP options. -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIwsdl\fR +The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. +.SH DESCRIPTION +The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +Service Endpoint Interface (SEI) +.TP 0.2i +\(bu +Service +.TP 0.2i +\(bu +Exception class is mapped from \f3wsdl:fault\fR (if any) +.TP 0.2i +\(bu +Async Response Bean is derived from response \f3wsdl:message\fR (if any) +.TP 0.2i +\(bu +JAXB generated value types (mapped java classes from schema types) +.PP +To start the \f3wsgen\fR command, do the following: +.PP +\fIOracle Solaris/Linux\fR: +.sp +.nf +\f3/bin/wsimport\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +\fIWindows\fR: +.sp +.nf +\f3\ebin\ewsimport\&.bat \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-d \fIdirectory\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated output files +Specifies where to place generated output files\&. +.TP +-b \fIpath\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP +-B \fIjaxbOption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify external JAX\-WS or JAXB binding files (Each \f2<file>\fP must have its own \f2\-b\fP) +Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. +.TP +-catalog .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP +-extension .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Pass this option to JAXB schema compiler +Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 +Displays a help message for the \f3wsimport\fR command\&. +.TP +-httpproxy: \fIhost\fR:\fIport\fR .br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify catalog file to resolve external entity references, it supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the documentation of -.na -\f2catalog\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/catalog\-support.html and see \f3catalog\fP sample. +Specifies an HTTP proxy server\&. The default is 8080\&. +.TP +-keep .br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 +Keeps generated files\&. +.TP +-p \fIname\fR .br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Allow vendor extensions (functionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations +Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. +.TP +-s \fIdirectory\fR .br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 80 +Specifies where to place generated source files\&. +.TP +-verbose .br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-httpproxy:<host>:<port> \fP +Displays compiler messages\&. +.TP +-version .br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 +Prints release information\&. +.TP +-wsdllocation \fIlocation\fR .br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify an HTTP proxy server (port defaults to 8080) +Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. +.TP +-target .br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 +Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. +.TP +-quiet .br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specifying a target package via this command\-line option, overrides any wsdl and schema binding customization for package name and the default package name algorithm defined in the specification +Suppresses the \f3wsimport\fR command output\&. +.PP +Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html +.SH NONSTANDARD\ OPTIONS +.TP +-XadditionalHeaders .br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 +Maps headers not bound to a request or response message to Java method parameters\&. +.TP +-Xauthfile \fIfile\fR .br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated source files -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Output messages about what the compiler is doing -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print version information -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-wsdllocation <location>\fP -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@WebServiceClient.wsdlLocation\fP value -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Generate code as per the given JAX\-WS specification version. version 2.0 will generate compliant code for JAX\-WS 2.0 spec. -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-d <directory> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-b <path> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-B <jaxbOption>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-catalog\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-extension \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-help \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-keep \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-p \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-s <directory> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-verbose \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-version \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-target \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-quiet \fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(f- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(l- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wDisplay help -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wKeep generated files -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wSuppress wsimport output -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 157 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-d <directory> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-b <path> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-B <jaxbOption>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-catalog\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-extension \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-help \fP\h'|\n(41u'Display help -.ne \n(f|u+\n(.Vu -.ne \n(g|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-keep \fP\h'|\n(41u'Keep generated files -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-p \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-s <directory> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-verbose \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-version \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.ne \n(m|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-target \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-quiet \fP\h'|\n(41u'Suppress wsimport output -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-66 -.LP -Multiple JAX\-WS and JAXB binding files can be specified using \f2\-b\fP option and they can be used to customize various things like package names, bean names, etc. More information on JAX\-WS and JAXB binding files can be found in the -.na -\f2customization documentation\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/customizations.html. -.LP -The following table lists \f2wsimport\fP non\-standard options: -.LP -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Map headers not bound to request or response message to Java method parameters. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -WSDL URI that specifies the file that contains authorization information; this URI is in the following format: http://\f2<user name>\fP:\f2<password>\fP@\f2<host name>\fP/\f2<Web service name>\fP?wsdl -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print debugging information. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-Xno\-addressing\-databinding\fP -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Enable binding of W3C \f2EndpointReferenceType\fP to Java. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Do not compile generated Java files. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-XadditionalHeaders\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xauthfile <file>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xdebug\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xnocompile\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 193 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-XadditionalHeaders\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xauthfile <file>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xdebug\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xnocompile\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.if \n-(b.=0 .nr c. \n(.c-\n(d.-26 +The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: -.LP -.SH "Example" -.nf -\f3 -.fl -\fP\f3wsimport \-p stockquote http://stockquote.example.com/quote?wsdl\fP -.fl -.fi -.LP -This will generate the Java artifacts and compile them by importing the \f2http://stockquote.example.com/quote?wsdl\fP. +http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. +.TP +-Xdebug .br - +Prints debugging information\&. +.TP +-Xno-addressing-databinding +.br +Enables binding of W3C EndpointReferenceType to Java\&. +.TP +-Xnocompile +.br +Does not compile the generated Java files\&. +.SH EXAMPLE +The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR +.sp +.nf +\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsgen(1) +.TP 0.2i +\(bu +The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/linux/doc/man/xjc.1 b/jdk/src/linux/doc/man/xjc.1 index 0425ba6480c..3956ce8e8a6 100644 --- a/jdk/src/linux/doc/man/xjc.1 +++ b/jdk/src/linux/doc/man/xjc.1 @@ -1,297 +1,233 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH xjc 1 "10 May 2011" +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: xjc.1 +.\" +.if n .pl 99999 +.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -xjc \- Java(TM) Architecture for XML Binding +.SH NAME +xjc \- Compiles an XML schema file into fully annotated Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +schema \fIfile/URL/dir/jar \&.\&.\&.\fR +The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. +.TP +-b \fIbindinfo\fR .br -Binding Compiler -.LP -.LP -\f3Specification Version:\fP 2.1 +The location of the bindings files\&. +.SH DESCRIPTION +Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html +.SH OPTIONS +.TP 0.2i +\(bu +See also Nonstandard Options +.TP 0.2i +\(bu +See also Deprecated and Removed Options +.TP +-nv .br -\f3Reference Implementation (RI) Version:\fP 2.1.3 -.LP -.SH "Launching xjc" -.LP -.LP -The binding compiler can be launched using the appropriate \f2xjc\fP shell script in the \f2bin\fP directory for your platform. We also provide an Ant task to run the binding complier \- see the instructions for -.na -\f2using the XJC Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html. -.LP -.LP -\f2% xjc \-help\fP -.LP -.SS -Output -.LP -.nf -\f3 -.fl -Usage: xjc [\-options ...] <schema file/URL/dir/jar> ... [\-b <bindinfo>] ... -.fl -If dir is specified, all schema files in it will be compiled. -.fl -If jar is specified, /META\-INF/sun\-jaxb.episode binding file will be compiled. -.fl -Options: -.fl - \-nv : do not perform strict validation of the input schema(s) -.fl - \-extension : allow vendor extensions \- do not strictly follow the Compatibility Rules and App E.2 from the JAXB Spec -.fl - \-b <file/dir> : specify external bindings files (each <file> must have its own \-b); if a directory is given, **/*.xjb is searched -.fl - \-d <dir> : generated files will go into this directory -.fl - \-p <pkg> : specifies the target package -.fl - \-httpproxy <proxy> : set HTTP/HTTPS proxy; format is [user[:password]@]proxyHost:proxyPort -.fl - \-httpproxyfile <f> : works like \-httpproxy but takes the argument in a file to protect password -.fl - \-classpath <arg> : specify where to find user class files -.fl - \-catalog <file> : specify catalog files to resolve external entity references; support TR9401, XCatalog, and OASIS XML Catalog format -.fl - \-readOnly : generated files will be in read\-only mode -.fl - \-npa : suppress generation of package level annotations (**/package\-info.java) -.fl - \-no\-header : suppress generation of a file header with timestamp -.fl - \-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features -.fl - \-xmlschema : treat input as W3C XML Schema (default) -.fl - \-relaxng : treat input as RELAX NG (experimental,unsupported) -.fl - \-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported) -.fl - \-dtd : treat input as XML DTD (experimental,unsupported) -.fl - \-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported) -.fl - \-verbose : be extra verbose -.fl - \-quiet : suppress compiler output -.fl - \-help : display this help message -.fl - \-version : display version information -.fl - -.fl - -.fl -Extensions: -.fl - \-Xlocator : enable source location support for generated code -.fl - \-Xsync\-methods : generate accessor methods with the 'synchronized' keyword -.fl - \-mark\-generated : mark the generated code as @javax.annotation.Generated -.fl - \-episode <FILE> : generate the episode file for separate compilation -.fl -\fP -.fi - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-nv -By default, the XJC binding compiler performs strict validation of the source schema before processing it. Use this option to disable strict schema validation. This does not mean that the binding compiler will not perform any validation, it simply means that it will perform less\-strict validation. -.TP 3 -\-extension -By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification. Appendix E.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1.0. In some cases, you may be allowed to use them in the "\-extension" mode enabled by this switch. In the default (strict) mode, you are also limited to using only the binding customizations defined in the specification. By using the "\-extension" switch, you will be allowed to use the JAXB Vendor Extensions -.TP 3 -\-b <file> -Specify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files: \f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP +By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. +.TP +-extension .br -\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP In addition, the ordering of the schema files and binding files on the command line does not matter. -.TP 3 -\-d <dir> -By default, the XJC binding compiler will generate the Java content classes in the current directory. Use this option to specify an alternate output directory. The output directory must already exist, the XJC binding compiler will not create it for you. -.TP 3 -\-p <pkg> -Specifying a target package via this command\-line option overrides any binding customization for package name and the default package name algorithm defined in the specification. -.TP 3 -\-httpproxy <proxy> -Specify the HTTP/HTTPS proxy. The format is [user[:password]@]proxyHost[:proxyPort]. The old \f2\-host\fP and \f2\-port\fP are still supported by the RI for backwards compatibility, but they have been deprecated. Note that the password specified with this option is an argument that is visible to other users who use the \f2top\fP command, for example. For greater security, use \f2\-httpproxyfile\fP, below. -.TP 3 -\-httpproxyfile <file> -Specify the HTTP/HTTPS proxy using a file. Same format as above, but the password specified in the file is not visible to other users. -.TP 3 -\-classpath <arg> -Specify where to find client application class files used by the \f2<jxb:javaType>\fP and \f2<xjc:superClass>\fP customizations. -.TP 3 -\-catalog <file> -Specify catalog files to resolve external entity references. Supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the XML Entity and URI Resolvers document or the \f2catalog\-resolver\fP sample application. -.TP 3 -\-readOnly -By default, the XJC binding compiler does not write\-protect the Java source files it generates. Use this option to force the XJC binding compiler to mark the generated Java sources read\-only. -.TP 3 -\-npa -Supress the generation of package level annotations into **/package\-info.java. Using this switch causes the generated code to internalize those annotations into the other generated classes. -.TP 3 -\-no\-header -Supress the generation of a file header comment that includes some note and timestamp. Using this makes the generated code more diff\-friendly. -.TP 3 -\-target 2.0 -Avoid generating code that relies on any JAXB 2.1 features. This will allow the generated code to run with JAXB 2.0 runtime (such as JavaSE 6.) -.TP 3 -\-xmlschema -Treat input schemas as W3C XML Schema (default). If you do not specify this switch, your input schemas will be treated as W3C XML Schema. -.TP 3 -\-relaxng -Treat input schemas as RELAX NG (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-relaxng\-compact -Treat input schemas as RELAX NG compact syntax(experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-dtd -Treat input schemas as XML DTD (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-wsdl -Treat input as WSDL and compile schemas inside it (experimental,unsupported). -.TP 3 -\-quiet -Suppress compiler output, such as progress information and warnings. -.TP 3 -\-verbose -Be extra verbose, such as printing informational messages or displaying stack traces upon some errors. -.TP 3 -\-help -Display a brief summary of the compiler switches. -.TP 3 -\-version -Display the compiler version information. -.TP 3 -<schema file/URL/dir> -Specify one or more schema files to compile. If you specify a directory, then xjc will scan it for all schema files and compile them. -.RE - -.LP -.SS -Non\-Standard Command Line Options -.LP -.RS 3 -.TP 3 -\-Xlocator -Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling. -.TP 3 -\-Xsync\-methods -Causes all of the generated method signatures to include the \f2synchronized\fP keyword. -.TP 3 -\-mark\-generated -Mark the generated code with the annotation \f2@javax.annotation.Generated\fP. -.TP 3 -\-episode <file> -Generate the specified episode file for separate compilation. -.RE - -.LP -.SS -Deprecated and Removed Command Line Options -.LP -.RS 3 -.TP 3 -\-host & \-port -These options have been deprecated and replaced with the \f3\-httpproxy\fP option. For backwards compatibility, we will continue to support these options, but they will no longer be documented and may be removed from future releases. -.TP 3 -\-use\-runtime -Since the JAXB 2.0 specification has defined a portable runtime, it is no longer necessary for the JAXB RI to generate **/impl/runtime packages. Therefore, this switch is obsolete and has been removed. -.TP 3 -\-source -The \-source compatibility switch was introduced in the first JAXB 2.0 Early Access release. We have decided to remove this switch from future releases of JAXB 2.0. If you need to generate 1.0.x code, please use an installation of the 1.0.x codebase. -.RE - -.LP -.SS -Compiler Restrictions -.LP -.LP -In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches. -.LP -.LP -Please keep the following list of restrictions in mind when running xjc. Most of these issues only apply when compiling multiple schemas with multiple invocations of xjc. -.LP -.RS 3 -.TP 2 -o -To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: -.RS 3 -.TP 3 -1. -The "\f2\-p\fP" command line option takes the highest precedence. -.TP 3 -2. -<\f2jaxb:package\fP> customization -.TP 3 -3. -If \f2targetNamespace\fP is declared, apply \f2targetNamespace\fP \-> Java package name algorithm defined in the specification. -.TP 3 -4. -If no \f2targetNamespace\fP is declared, use a hardcoded package named "generated". -.RE -.TP 2 -o -It is not legal to have more than one <\f2jaxb:schemaBindings\fP> per namespace, so it is impossible to have two schemas in the same target namespace compiled into different Java packages. -.TP 2 -o -All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time \- they cannot be compiled independently and work as expected. -.TP 2 -o -Element substitution groups spread across multiple schema files must be compiled at the same time. -.RE - -.LP -.SH "See Also" -.LP -.RS 3 -.TP 2 -o -Running the binding compiler (XJC): [ -.na -\f2command\-line instructions\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjc.html, -.na -\f2using the XJC Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html] -.TP 2 -o -.na -\f2Java Architecture for XML Binding (JAXB)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html -.RE - -.LP - +By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification\&. Appendix E\&.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1\&.0\&. In some cases, you may be allowed to use them in the \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. +.TP +-b \fIfile\fR +.br +Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. +.TP +-d \fIdir\fR +.br +By default, the XJC binding compiler generates the Java content classes in the current directory\&. Use this option to specify an alternate output directory\&. The output directory must already exist\&. The XJC binding compiler does not create it for you\&. +.TP +-p \fIpkg\fR +.br +When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. +.TP +-httpproxy \fIproxy\fR +.br +Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. +.TP +-httpproxyfile file +.br +Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. +.TP +-classpath arg +.br +Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. +.TP +-catalog file +.br +Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html +.TP +-readOnly +.br +By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. +.TP +-npa +.br +Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. +.TP +-no-header +.br +Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. +.TP +-target 2\&.0 +.br +Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. +.TP +-xmlschema +.br +Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. +.TP +-relaxing +.br +Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-relaxing-compact +.br +Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-dtd +.br +Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-wsdl +.br +Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. +.TP +-quiet +.br +Suppress compiler output, such as progress information and warnings\&. +.TP +-verbose +.br +Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. +.TP +-help +.br +Displays a brief summary of the compiler switches\&. +.TP +-version +.br +Displays the compiler version information\&. +.TP +\fIschema file/URL/dir\fR +Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. +.SS NONSTANDARD\ OPTIONS +.TP +-XLocator +.br +Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. +.TP +-Xsync-methods +.br +Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. +.TP +-mark-generated +.br +Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. +.TP +-episode file +.br +Generates the specified episode file for separate compilation\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +.TP +-host & -port +.br +These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. +.TP +-use-runtime +.br +Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. +.TP +-source +.br +The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. +.SH COMPILER\ RESTRICTIONS +In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. +.PP +To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: +.TP 0.4i +1\&. +The \f3-p\fR option has the highest precedence\&. +.TP 0.4i +2\&. +\fIjaxb:package\fR customization\&. +.TP 0.4i +3\&. +If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. +.TP 0.4i +4\&. +If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. +.PP +You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. +.PP +All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. +.PP +Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/macosx/classes/com/apple/laf/AquaFileChooserUI.java b/jdk/src/macosx/classes/com/apple/laf/AquaFileChooserUI.java index be4b5b72a32..5669d10b1a4 100644 --- a/jdk/src/macosx/classes/com/apple/laf/AquaFileChooserUI.java +++ b/jdk/src/macosx/classes/com/apple/laf/AquaFileChooserUI.java @@ -227,7 +227,7 @@ public class AquaFileChooserUI extends FileChooserUI { // Exist in basic.properties (though we might want to override) fileDescriptionText = UIManager.getString("FileChooser.fileDescriptionText"); directoryDescriptionText = UIManager.getString("FileChooser.directoryDescriptionText"); - newFolderErrorText = getString("FileChooser.newFolderErrorText", "Error occured during folder creation"); + newFolderErrorText = getString("FileChooser.newFolderErrorText", "Error occurred during folder creation"); saveButtonText = UIManager.getString("FileChooser.saveButtonText"); openButtonText = UIManager.getString("FileChooser.openButtonText"); diff --git a/jdk/src/macosx/classes/com/apple/laf/resources/aqua.properties b/jdk/src/macosx/classes/com/apple/laf/resources/aqua.properties index 17f7a94584a..ac147020ce7 100644 --- a/jdk/src/macosx/classes/com/apple/laf/resources/aqua.properties +++ b/jdk/src/macosx/classes/com/apple/laf/resources/aqua.properties @@ -38,7 +38,7 @@ ############ FILE CHOOSER STRINGS ############# FileChooser.fileDescription.textAndMnemonic=Generic File FileChooser.directoryDescription.textAndMnemonic=Directory -FileChooser.newFolderError.textAndMnemonic=Error occured during folder creation +FileChooser.newFolderError.textAndMnemonic=Error occurred during folder creation FileChooser.newFolderErrorSeparator= : FileChooser.acceptAllFileFilter.textAndMnemonic=All Files FileChooser.cancelButton.textAndMnemonic=Cancel diff --git a/jdk/src/share/classes/com/sun/imageio/plugins/common/StandardMetadataFormatResources.java b/jdk/src/share/classes/com/sun/imageio/plugins/common/StandardMetadataFormatResources.java index 96f099cf222..00bf1ee323e 100644 --- a/jdk/src/share/classes/com/sun/imageio/plugins/common/StandardMetadataFormatResources.java +++ b/jdk/src/share/classes/com/sun/imageio/plugins/common/StandardMetadataFormatResources.java @@ -123,7 +123,7 @@ public class StandardMetadataFormatResources extends ListResourceBundle { "The vertical position, in millimeters, where the image should be rendered on media " }, { "HorizontalPixelOffset", - "The horizonal position, in pixels, where the image should be rendered onto a raster display" }, + "The horizontal position, in pixels, where the image should be rendered onto a raster display" }, { "VerticalPixelOffset", "The vertical position, in pixels, where the image should be rendered onto a raster display" }, diff --git a/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubBulkRequestHandler.java b/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubBulkRequestHandler.java index 6dc479f242c..aa349526456 100644 --- a/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubBulkRequestHandler.java +++ b/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubBulkRequestHandler.java @@ -111,7 +111,7 @@ class SnmpSubBulkRequestHandler extends SnmpSubRequestHandler { if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINEST)) { SNMP_ADAPTOR_LOGGER.logp(Level.FINEST, SnmpSubRequestHandler.class.getName(), "run", "[" + Thread.currentThread() + - "]:an Snmp error occured during the operation", x); + "]:an Snmp error occurred during the operation", x); } } catch(Exception x) { @@ -119,7 +119,7 @@ class SnmpSubBulkRequestHandler extends SnmpSubRequestHandler { if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINEST)) { SNMP_ADAPTOR_LOGGER.logp(Level.FINEST, SnmpSubRequestHandler.class.getName(), "run", "[" + Thread.currentThread() + - "]:a generic error occured during the operation", x); + "]:a generic error occurred during the operation", x); } } if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINER)) { diff --git a/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubNextRequestHandler.java b/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubNextRequestHandler.java index 3ff95f6a001..99eebaa8c22 100644 --- a/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubNextRequestHandler.java +++ b/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubNextRequestHandler.java @@ -127,7 +127,7 @@ class SnmpSubNextRequestHandler extends SnmpSubRequestHandler { if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINEST)) { SNMP_ADAPTOR_LOGGER.logp(Level.FINEST, SnmpSubRequestHandler.class.getName(), "run", "[" + Thread.currentThread() + - "]:an Snmp error occured during the operation", x); + "]:an Snmp error occurred during the operation", x); } } catch(Exception x) { @@ -135,7 +135,7 @@ class SnmpSubNextRequestHandler extends SnmpSubRequestHandler { if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINEST)) { SNMP_ADAPTOR_LOGGER.logp(Level.FINEST, SnmpSubRequestHandler.class.getName(), "run", "[" + Thread.currentThread() + - "]:a generic error occured during the operation", x); + "]:a generic error occurred during the operation", x); } } if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINER)) { diff --git a/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubRequestHandler.java b/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubRequestHandler.java index 0b981311358..391d528f876 100644 --- a/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubRequestHandler.java +++ b/jdk/src/share/classes/com/sun/jmx/snmp/daemon/SnmpSubRequestHandler.java @@ -231,7 +231,7 @@ class SnmpSubRequestHandler implements SnmpDefinitions, Runnable { if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINEST)) { SNMP_ADAPTOR_LOGGER.logp(Level.FINEST, SnmpSubRequestHandler.class.getName(), "run", "[" + Thread.currentThread() + - "]:an Snmp error occured during the operation", x); + "]:an Snmp error occurred during the operation", x); } } catch(Exception x) { @@ -239,7 +239,7 @@ class SnmpSubRequestHandler implements SnmpDefinitions, Runnable { if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINEST)) { SNMP_ADAPTOR_LOGGER.logp(Level.FINEST, SnmpSubRequestHandler.class.getName(), "run", "[" + Thread.currentThread() + - "]:a generic error occured during the operation", x); + "]:a generic error occurred during the operation", x); } } if (SNMP_ADAPTOR_LOGGER.isLoggable(Level.FINER)) { diff --git a/jdk/src/share/classes/com/sun/rowset/CachedRowSetImpl.java b/jdk/src/share/classes/com/sun/rowset/CachedRowSetImpl.java index 7a7f693022d..80109fd6421 100644 --- a/jdk/src/share/classes/com/sun/rowset/CachedRowSetImpl.java +++ b/jdk/src/share/classes/com/sun/rowset/CachedRowSetImpl.java @@ -541,7 +541,7 @@ public class CachedRowSetImpl extends BaseRowSet implements RowSet, RowSetIntern if (rowSetWriter != null) { Class<?> c = rowSetWriter.getClass(); if (c != null) { - Class[] theInterfaces = c.getInterfaces(); + Class<?>[] theInterfaces = c.getInterfaces(); for (int i = 0; i < theInterfaces.length; i++) { if ((theInterfaces[i].getName()).indexOf("TransactionalWriter") > 0) { tXWriter = true; diff --git a/jdk/src/share/classes/com/sun/rowset/internal/BaseRow.java b/jdk/src/share/classes/com/sun/rowset/internal/BaseRow.java index 814e7456f0d..dec4270e9ab 100644 --- a/jdk/src/share/classes/com/sun/rowset/internal/BaseRow.java +++ b/jdk/src/share/classes/com/sun/rowset/internal/BaseRow.java @@ -51,6 +51,11 @@ import java.util.Arrays; */ public abstract class BaseRow implements Serializable, Cloneable { +/** + * Specify the serialVersionUID + */ +private static final long serialVersionUID = 4152013523511412238L; + /** * The array containing the original values for this <code>BaseRow</code> * object. @@ -77,7 +82,7 @@ public abstract class BaseRow implements Serializable, Cloneable { * @param idx the index of the element to return * @return the <code>Object</code> value at the given index into this * row's array of original values - * @throws <code>SQLException</code> if there is an error + * @throws SQLException if there is an error */ public abstract Object getColumnObject(int idx) throws SQLException; @@ -90,7 +95,7 @@ public abstract class BaseRow implements Serializable, Cloneable { * @param idx the index of the element to be set * @param obj the <code>Object</code> to which the element at index * <code>idx</code> to be set - * @throws <code>SQLException</code> if there is an error + * @throws SQLException if there is an error */ public abstract void setColumnObject(int idx, Object obj) throws SQLException; } diff --git a/jdk/src/share/classes/com/sun/tools/example/debug/gui/CommandInterpreter.java b/jdk/src/share/classes/com/sun/tools/example/debug/gui/CommandInterpreter.java index b0494c282df..1b164209c82 100644 --- a/jdk/src/share/classes/com/sun/tools/example/debug/gui/CommandInterpreter.java +++ b/jdk/src/share/classes/com/sun/tools/example/debug/gui/CommandInterpreter.java @@ -377,7 +377,7 @@ public class CommandInterpreter { env.failure("Attempt to launch main class \"" + clname + "\" failed."); } } else { - env.failure("No main class specifed and no current default defined."); + env.failure("No main class specified and no current default defined."); } } else { clname = t.nextToken(); @@ -428,7 +428,7 @@ public class CommandInterpreter { env.failure("Attempt to attach to port \"" + portName + "\" failed."); } } else { - env.failure("No port specifed and no current default defined."); + env.failure("No port specified and no current default defined."); } } else { portName = t.nextToken(); diff --git a/jdk/src/share/classes/com/sun/tools/script/shell/init.js b/jdk/src/share/classes/com/sun/tools/script/shell/init.js index ae2cdc42d95..ced3ba06367 100644 --- a/jdk/src/share/classes/com/sun/tools/script/shell/init.js +++ b/jdk/src/share/classes/com/sun/tools/script/shell/init.js @@ -806,7 +806,7 @@ function XSLTransform(inp, style, out) { out = arguments[2]; break; default: - println("XSL tranform requires 2 or 3 arguments"); + println("XSL transform requires 2 or 3 arguments"); return; } diff --git a/jdk/src/share/classes/com/sun/tools/script/shell/messages.properties b/jdk/src/share/classes/com/sun/tools/script/shell/messages.properties index 9caf20efd41..4494f73b73b 100644 --- a/jdk/src/share/classes/com/sun/tools/script/shell/messages.properties +++ b/jdk/src/share/classes/com/sun/tools/script/shell/messages.properties @@ -36,7 +36,7 @@ engine.not.found=\ script engine for language {0} can not be found engine.info=\ - Language {0} {1} implemention "{2}" {3} + Language {0} {1} implementation "{2}" {3} encoding.unsupported=\ encoding {0} is not supported diff --git a/jdk/src/share/classes/java/awt/GraphicsDevice.java b/jdk/src/share/classes/java/awt/GraphicsDevice.java index 3c9d4178bd6..d55ccedca2c 100644 --- a/jdk/src/share/classes/java/awt/GraphicsDevice.java +++ b/jdk/src/share/classes/java/awt/GraphicsDevice.java @@ -341,12 +341,11 @@ public abstract class GraphicsDevice { } /** - * Returns the {@code Window} object representing the + * Returns the <code>Window</code> object representing the * full-screen window if the device is in full-screen mode. * - * @return the full-screen window, or {@code null} if the device is - * not in full-screen mode. The {@code Window} object can differ - * from the object previously set by {@code setFullScreenWindow}. + * @return the full-screen window, or <code>null</code> if the device is + * not in full-screen mode. * @see #setFullScreenWindow(Window) * @since 1.4 */ diff --git a/jdk/src/share/classes/java/awt/datatransfer/SystemFlavorMap.java b/jdk/src/share/classes/java/awt/datatransfer/SystemFlavorMap.java index 1258881c1e8..86713ad3c5a 100644 --- a/jdk/src/share/classes/java/awt/datatransfer/SystemFlavorMap.java +++ b/jdk/src/share/classes/java/awt/datatransfer/SystemFlavorMap.java @@ -40,7 +40,6 @@ import java.net.MalformedURLException; import java.util.ArrayList; import java.util.HashMap; import java.util.HashSet; -import java.util.Iterator; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; @@ -1321,16 +1320,16 @@ public final class SystemFlavorMap implements FlavorMap, FlavorTable { } private List<String> getAllNativesForType(String type) { - List<String> retval = null; + Set<String> retval = null; for (DataFlavor dataFlavor : convertMimeTypeToDataFlavors(type)) { List<String> natives = getFlavorToNative().get(dataFlavor); if (natives != null && !natives.isEmpty()) { if (retval == null) { - retval = new ArrayList<>(); + retval = new LinkedHashSet<>(); } retval.addAll(natives); } } - return retval; + return retval == null ? null : new ArrayList<>(retval); } } diff --git a/jdk/src/share/classes/java/beans/IndexedPropertyDescriptor.java b/jdk/src/share/classes/java/beans/IndexedPropertyDescriptor.java index 866d35ba56c..f38c35774fe 100644 --- a/jdk/src/share/classes/java/beans/IndexedPropertyDescriptor.java +++ b/jdk/src/share/classes/java/beans/IndexedPropertyDescriptor.java @@ -373,12 +373,13 @@ public class IndexedPropertyDescriptor extends PropertyDescriptor { if (params[0] != Integer.TYPE) { throw new IntrospectionException("non int index to indexed write method"); } - if (indexedPropertyType != null && indexedPropertyType != params[1]) { + if (indexedPropertyType == null || params[1].isAssignableFrom(indexedPropertyType)) { + indexedPropertyType = params[1]; + } else if (!indexedPropertyType.isAssignableFrom(params[1])) { throw new IntrospectionException( "type mismatch between indexed read and indexed write methods: " + getName()); } - indexedPropertyType = params[1]; } Class<?> propertyType = getPropertyType(); if (propertyType != null && (!propertyType.isArray() || diff --git a/jdk/src/share/classes/java/beans/Introspector.java b/jdk/src/share/classes/java/beans/Introspector.java index fc8b21856d6..61745dd9efa 100644 --- a/jdk/src/share/classes/java/beans/Introspector.java +++ b/jdk/src/share/classes/java/beans/Introspector.java @@ -684,8 +684,7 @@ public class Introspector { ipd = (IndexedPropertyDescriptor)pd; if (ipd.getIndexedWriteMethod() != null) { if (igpd != null) { - if (igpd.getIndexedPropertyType() - == ipd.getIndexedPropertyType()) { + if (isAssignable(igpd.getIndexedPropertyType(), ipd.getIndexedPropertyType())) { if (ispd != null) { ispd = new IndexedPropertyDescriptor(ispd, ipd); } else { @@ -703,7 +702,7 @@ public class Introspector { } else { if (pd.getWriteMethod() != null) { if (gpd != null) { - if (gpd.getPropertyType() == pd.getPropertyType()) { + if (isAssignable(gpd.getPropertyType(), pd.getPropertyType())) { if (spd != null) { spd = new PropertyDescriptor(spd, pd); } else { @@ -806,6 +805,10 @@ public class Introspector { } } + private static boolean isAssignable(Class<?> current, Class<?> candidate) { + return current == null ? candidate == null : current.isAssignableFrom(candidate); + } + /** * Adds the property descriptor to the indexedproperty descriptor only if the * types are the same. diff --git a/jdk/src/share/classes/java/io/DataInput.java b/jdk/src/share/classes/java/io/DataInput.java index c61aeb58eda..3e0f0ddbd22 100644 --- a/jdk/src/share/classes/java/io/DataInput.java +++ b/jdk/src/share/classes/java/io/DataInput.java @@ -444,7 +444,7 @@ interface DataInput { * a {@code double} value. It does this * by first constructing a {@code long} * value in exactly the manner - * of the {@code readlong} + * of the {@code readLong} * method, then converting this {@code long} * value to a {@code double} in exactly * the manner of the method {@code Double.longBitsToDouble}. diff --git a/jdk/src/share/classes/java/io/ObjectOutputStream.java b/jdk/src/share/classes/java/io/ObjectOutputStream.java index c851b3a641a..612bb4eb16b 100644 --- a/jdk/src/share/classes/java/io/ObjectOutputStream.java +++ b/jdk/src/share/classes/java/io/ObjectOutputStream.java @@ -1248,7 +1248,7 @@ public class ObjectOutputStream handles.assign(unshared ? null : desc); Class<?> cl = desc.forClass(); - Class[] ifaces = cl.getInterfaces(); + Class<?>[] ifaces = cl.getInterfaces(); bout.writeInt(ifaces.length); for (int i = 0; i < ifaces.length; i++) { bout.writeUTF(ifaces[i].getName()); diff --git a/jdk/src/share/classes/java/io/ObjectStreamClass.java b/jdk/src/share/classes/java/io/ObjectStreamClass.java index 04873c8a85d..5667690a749 100644 --- a/jdk/src/share/classes/java/io/ObjectStreamClass.java +++ b/jdk/src/share/classes/java/io/ObjectStreamClass.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1996, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -1746,7 +1746,7 @@ public class ObjectStreamClass implements Serializable { dout.writeUTF("()V"); } - Constructor[] cons = cl.getDeclaredConstructors(); + Constructor<?>[] cons = cl.getDeclaredConstructors(); MemberSignature[] consSigs = new MemberSignature[cons.length]; for (int i = 0; i < cons.length; i++) { consSigs[i] = new MemberSignature(cons[i]); diff --git a/jdk/src/share/classes/java/lang/String.java b/jdk/src/share/classes/java/lang/String.java index 9223c0ab54f..e0a73d55752 100644 --- a/jdk/src/share/classes/java/lang/String.java +++ b/jdk/src/share/classes/java/lang/String.java @@ -122,14 +122,9 @@ public final class String /** * Class String is special cased within the Serialization Stream Protocol. * - * A String instance is written initially into an ObjectOutputStream in the - * following format: - * <pre> - * {@code TC_STRING} (utf String) - * </pre> - * The String is written by method {@code DataOutput.writeUTF}. - * A new handle is generated to refer to all future references to the - * string instance within the stream. + * A String instance is written into an ObjectOutputStream according to + * <a href="{@docroot}../platform/serialization/spec/output.html"> + * Object Serialization Specification, Section 6.2, "Stream Elements"</a> */ private static final ObjectStreamField[] serialPersistentFields = new ObjectStreamField[0]; @@ -2242,6 +2237,11 @@ public final class String * expression does not match any part of the input then the resulting array * has just one element, namely this string. * + * <p> When there is a positive-width match at the beginning of this + * string then an empty leading substring is included at the beginning + * of the resulting array. A zero-width match at the beginning however + * never produces such empty leading substring. + * * <p> The {@code limit} parameter controls the number of times the * pattern is applied and therefore affects the length of the resulting * array. If the limit <i>n</i> is greater than zero then the pattern diff --git a/jdk/src/share/classes/java/lang/System.java b/jdk/src/share/classes/java/lang/System.java index f68a5401704..69d1d0fe1ef 100644 --- a/jdk/src/share/classes/java/lang/System.java +++ b/jdk/src/share/classes/java/lang/System.java @@ -1263,6 +1263,9 @@ public final class System { public Thread newThreadWithAcc(Runnable target, AccessControlContext acc) { return new Thread(target, acc); } + public void invokeFinalize(Object o) throws Throwable { + o.finalize(); + } }); } } diff --git a/jdk/src/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java b/jdk/src/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java index a85c505c0f8..2fc8618cbc5 100644 --- a/jdk/src/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java +++ b/jdk/src/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -51,7 +51,7 @@ import static jdk.internal.org.objectweb.asm.Opcodes.*; /* package */ final class InnerClassLambdaMetafactory extends AbstractValidatingLambdaMetafactory { private static final Unsafe UNSAFE = Unsafe.getUnsafe(); - private static final int CLASSFILE_VERSION = 51; + private static final int CLASSFILE_VERSION = 52; private static final String METHOD_DESCRIPTOR_VOID = Type.getMethodDescriptor(Type.VOID_TYPE); private static final String JAVA_LANG_OBJECT = "java/lang/Object"; private static final String NAME_CTOR = "<init>"; @@ -465,7 +465,9 @@ import static jdk.internal.org.objectweb.asm.Opcodes.*; convertArgumentTypes(methodType); // Invoke the method we want to forward to - visitMethodInsn(invocationOpcode(), implMethodClassName, implMethodName, implMethodDesc); + visitMethodInsn(invocationOpcode(), implMethodClassName, + implMethodName, implMethodDesc, + implDefiningClass.isInterface()); // Convert the return value (if any) and return it // Note: if adapting from non-void to void, the 'return' diff --git a/jdk/src/share/classes/java/lang/invoke/InvokerBytecodeGenerator.java b/jdk/src/share/classes/java/lang/invoke/InvokerBytecodeGenerator.java index 639b3628fa5..5a3ee424b1a 100644 --- a/jdk/src/share/classes/java/lang/invoke/InvokerBytecodeGenerator.java +++ b/jdk/src/share/classes/java/lang/invoke/InvokerBytecodeGenerator.java @@ -275,7 +275,7 @@ class InvokerBytecodeGenerator { */ private void classFilePrologue() { cw = new ClassWriter(ClassWriter.COMPUTE_MAXS + ClassWriter.COMPUTE_FRAMES); - cw.visit(Opcodes.V1_6, Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_SUPER, className, null, superName, null); + cw.visit(Opcodes.V1_8, Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_SUPER, className, null, superName, null); cw.visitSource(sourceFile, null); String invokerDesc = invokerType.toMethodDescriptorString(); @@ -646,7 +646,8 @@ class InvokerBytecodeGenerator { // invocation if (member.isMethod()) { mtype = member.getMethodType().toMethodDescriptorString(); - mv.visitMethodInsn(refKindOpcode(refKind), cname, mname, mtype); + mv.visitMethodInsn(refKindOpcode(refKind), cname, mname, mtype, + member.getDeclaringClass().isInterface()); } else { mtype = MethodType.toFieldDescriptorString(member.getFieldType()); mv.visitFieldInsn(refKindOpcode(refKind), cname, mname, mtype); diff --git a/jdk/src/share/classes/java/lang/invoke/MethodHandleImpl.java b/jdk/src/share/classes/java/lang/invoke/MethodHandleImpl.java index 0d6ed2da06a..eca236ce308 100644 --- a/jdk/src/share/classes/java/lang/invoke/MethodHandleImpl.java +++ b/jdk/src/share/classes/java/lang/invoke/MethodHandleImpl.java @@ -744,8 +744,11 @@ import static java.lang.invoke.MethodHandles.Lookup.IMPL_LOOKUP; MethodHandle ginvoker = GuardWithCatch.INVOKES[nargs].bindReceiver(gguard); return makePairwiseConvert(ginvoker, type, 2); } else { + target = target.asType(type.changeReturnType(Object.class)); MethodHandle gtarget = makeSpreadArguments(target, Object[].class, 0, nargs); - catcher = catcher.asType(ctype.changeParameterType(0, Throwable.class)); + MethodType catcherType = ctype.changeParameterType(0, Throwable.class) + .changeReturnType(Object.class); + catcher = catcher.asType(catcherType); MethodHandle gcatcher = makeSpreadArguments(catcher, Object[].class, 1, nargs); GuardWithCatch gguard = new GuardWithCatch(gtarget, exType, gcatcher); if (gtarget == null || gcatcher == null) throw new InternalError(); diff --git a/jdk/src/share/classes/java/lang/invoke/MethodType.java b/jdk/src/share/classes/java/lang/invoke/MethodType.java index cfef437cda6..214ca6ce48c 100644 --- a/jdk/src/share/classes/java/lang/invoke/MethodType.java +++ b/jdk/src/share/classes/java/lang/invoke/MethodType.java @@ -32,6 +32,7 @@ import java.lang.ref.ReferenceQueue; import java.util.Arrays; import java.util.Collections; import java.util.List; +import java.util.Objects; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.ConcurrentHashMap; import sun.invoke.util.BytecodeDescriptor; @@ -98,13 +99,25 @@ class MethodType implements java.io.Serializable { private @Stable MethodTypeForm form; // erased form, plus cached data about primitives private @Stable MethodType wrapAlt; // alternative wrapped/unwrapped version private @Stable Invokers invokers; // cache of handy higher-order adapters + private @Stable String methodDescriptor; // cache for toMethodDescriptorString /** * Check the given parameters for validity and store them into the final fields. */ - private MethodType(Class<?> rtype, Class<?>[] ptypes) { + private MethodType(Class<?> rtype, Class<?>[] ptypes, boolean trusted) { checkRtype(rtype); checkPtypes(ptypes); + this.rtype = rtype; + // defensively copy the array passed in by the user + this.ptypes = trusted ? ptypes : Arrays.copyOf(ptypes, ptypes.length); + } + + /** + * Construct a temporary unchecked instance of MethodType for use only as a key to the intern table. + * Does not check the given parameters for validity, and must be discarded after it is used as a searching key. + * The parameters are reversed for this constructor, so that is is not accidentally used. + */ + private MethodType(Class<?>[] ptypes, Class<?> rtype) { this.rtype = rtype; this.ptypes = ptypes; } @@ -146,20 +159,21 @@ class MethodType implements java.io.Serializable { /*non-public*/ static final int MAX_MH_INVOKER_ARITY = MAX_MH_ARITY-1; // deduct one more for invoker private static void checkRtype(Class<?> rtype) { - rtype.equals(rtype); // null check + Objects.requireNonNull(rtype); } - private static int checkPtype(Class<?> ptype) { - ptype.getClass(); //NPE + private static void checkPtype(Class<?> ptype) { + Objects.requireNonNull(ptype); if (ptype == void.class) throw newIllegalArgumentException("parameter type cannot be void"); - if (ptype == double.class || ptype == long.class) return 1; - return 0; } /** Return number of extra slots (count of long/double args). */ private static int checkPtypes(Class<?>[] ptypes) { int slots = 0; for (Class<?> ptype : ptypes) { - slots += checkPtype(ptype); + checkPtype(ptype); + if (ptype == double.class || ptype == long.class) { + slots++; + } } checkSlotCount(ptypes.length + slots); return slots; @@ -284,20 +298,16 @@ class MethodType implements java.io.Serializable { */ /*trusted*/ static MethodType makeImpl(Class<?> rtype, Class<?>[] ptypes, boolean trusted) { + MethodType mt = internTable.get(new MethodType(ptypes, rtype)); + if (mt != null) + return mt; if (ptypes.length == 0) { ptypes = NO_PTYPES; trusted = true; } - MethodType mt1 = new MethodType(rtype, ptypes); - MethodType mt0 = internTable.get(mt1); - if (mt0 != null) - return mt0; - if (!trusted) - // defensively copy the array passed in by the user - mt1 = new MethodType(rtype, ptypes.clone()); + mt = new MethodType(rtype, ptypes, trusted); // promote the object to the Real Thing, and reprobe - MethodTypeForm form = MethodTypeForm.findForm(mt1); - mt1.form = form; - return internTable.add(mt1); + mt.form = MethodTypeForm.findForm(mt); + return internTable.add(mt); } private static final MethodType[] objectOnlyTypes = new MethodType[20]; @@ -919,7 +929,12 @@ class MethodType implements java.io.Serializable { * @return the bytecode type descriptor representation */ public String toMethodDescriptorString() { - return BytecodeDescriptor.unparse(this); + String desc = methodDescriptor; + if (desc == null) { + desc = BytecodeDescriptor.unparse(this); + methodDescriptor = desc; + } + return desc; } /*non-public*/ static String toFieldDescriptorString(Class<?> cls) { diff --git a/jdk/src/share/classes/java/lang/invoke/TypeConvertingMethodAdapter.java b/jdk/src/share/classes/java/lang/invoke/TypeConvertingMethodAdapter.java index f65049df036..5d8e1bf82f5 100644 --- a/jdk/src/share/classes/java/lang/invoke/TypeConvertingMethodAdapter.java +++ b/jdk/src/share/classes/java/lang/invoke/TypeConvertingMethodAdapter.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -35,7 +35,7 @@ import static sun.invoke.util.Wrapper.*; class TypeConvertingMethodAdapter extends MethodVisitor { TypeConvertingMethodAdapter(MethodVisitor mv) { - super(Opcodes.ASM4, mv); + super(Opcodes.ASM5, mv); } private static final int NUM_WRAPPERS = Wrapper.values().length; diff --git a/jdk/src/share/classes/java/lang/ref/Finalizer.java b/jdk/src/share/classes/java/lang/ref/Finalizer.java index 2be6466931b..f37b3e79b9c 100644 --- a/jdk/src/share/classes/java/lang/ref/Finalizer.java +++ b/jdk/src/share/classes/java/lang/ref/Finalizer.java @@ -27,17 +27,14 @@ package java.lang.ref; import java.security.PrivilegedAction; import java.security.AccessController; - +import sun.misc.JavaLangAccess; +import sun.misc.SharedSecrets; +import sun.misc.VM; final class Finalizer extends FinalReference<Object> { /* Package-private; must be in same package as the Reference class */ - /* A native method that invokes an arbitrary object's finalize method is - required since the finalize method is protected - */ - static native void invokeFinalizeMethod(Object o) throws Throwable; - private static ReferenceQueue<Object> queue = new ReferenceQueue<>(); private static Finalizer unfinalized = null; private static final Object lock = new Object(); @@ -90,7 +87,7 @@ final class Finalizer extends FinalReference<Object> { /* Package-private; must new Finalizer(finalizee); } - private void runFinalizer() { + private void runFinalizer(JavaLangAccess jla) { synchronized (this) { if (hasBeenFinalized()) return; remove(); @@ -98,7 +95,8 @@ final class Finalizer extends FinalReference<Object> { /* Package-private; must try { Object finalizee = this.get(); if (finalizee != null && !(finalizee instanceof java.lang.Enum)) { - invokeFinalizeMethod(finalizee); + jla.invokeFinalize(finalizee); + /* Clear stack slot containing this variable, to decrease the chances of false retention with a conservative GC */ finalizee = null; @@ -141,16 +139,21 @@ final class Finalizer extends FinalReference<Object> { /* Package-private; must /* Called by Runtime.runFinalization() */ static void runFinalization() { + if (!VM.isBooted()) { + return; + } + forkSecondaryFinalizer(new Runnable() { private volatile boolean running; public void run() { if (running) return; + final JavaLangAccess jla = SharedSecrets.getJavaLangAccess(); running = true; for (;;) { Finalizer f = (Finalizer)queue.poll(); if (f == null) break; - f.runFinalizer(); + f.runFinalizer(jla); } } }); @@ -158,11 +161,16 @@ final class Finalizer extends FinalReference<Object> { /* Package-private; must /* Invoked by java.lang.Shutdown */ static void runAllFinalizers() { + if (!VM.isBooted()) { + return; + } + forkSecondaryFinalizer(new Runnable() { private volatile boolean running; public void run() { if (running) return; + final JavaLangAccess jla = SharedSecrets.getJavaLangAccess(); running = true; for (;;) { Finalizer f; @@ -171,7 +179,7 @@ final class Finalizer extends FinalReference<Object> { /* Package-private; must if (f == null) break; unfinalized = f.next; } - f.runFinalizer(); + f.runFinalizer(jla); }}}); } @@ -183,13 +191,25 @@ final class Finalizer extends FinalReference<Object> { /* Package-private; must public void run() { if (running) return; + + // Finalizer thread starts before System.initializeSystemClass + // is called. Wait until JavaLangAccess is available + while (!VM.isBooted()) { + // delay until VM completes initialization + try { + VM.awaitBooted(); + } catch (InterruptedException x) { + // ignore and continue + } + } + final JavaLangAccess jla = SharedSecrets.getJavaLangAccess(); running = true; for (;;) { try { Finalizer f = (Finalizer)queue.remove(); - f.runFinalizer(); + f.runFinalizer(jla); } catch (InterruptedException x) { - continue; + // ignore and continue } } } diff --git a/jdk/src/share/classes/java/lang/reflect/Executable.java b/jdk/src/share/classes/java/lang/reflect/Executable.java index d033e7e9300..95665706c2b 100644 --- a/jdk/src/share/classes/java/lang/reflect/Executable.java +++ b/jdk/src/share/classes/java/lang/reflect/Executable.java @@ -240,6 +240,7 @@ public abstract class Executable extends AccessibleObject * declared or implicitly declared or neither) for the executable * represented by this object. * + * @since 1.8 * @return The number of formal parameters for the executable this * object represents */ @@ -290,6 +291,7 @@ public abstract class Executable extends AccessibleObject * have unique names, or names that are legal identifiers in the * Java programming language (JLS 3.8). * + * @since 1.8 * @throws MalformedParametersException if the class file contains * a MethodParameters attribute that is improperly formatted. * @return an array of {@code Parameter} objects representing all diff --git a/jdk/src/share/classes/java/lang/reflect/Proxy.java b/jdk/src/share/classes/java/lang/reflect/Proxy.java index f2e4eda4e62..20e62b642ca 100644 --- a/jdk/src/share/classes/java/lang/reflect/Proxy.java +++ b/jdk/src/share/classes/java/lang/reflect/Proxy.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -494,9 +494,10 @@ public class Proxy implements java.io.Serializable { private final int hash; private final WeakReference<Class<?>>[] refs; + @SuppressWarnings("unchecked") KeyX(Class<?>[] interfaces) { hash = Arrays.hashCode(interfaces); - refs = new WeakReference[interfaces.length]; + refs = (WeakReference<Class<?>>[])new WeakReference<?>[interfaces.length]; for (int i = 0; i < interfaces.length; i++) { refs[i] = new WeakReference<>(interfaces[i]); } diff --git a/jdk/src/share/classes/java/net/HostPortrange.java b/jdk/src/share/classes/java/net/HostPortrange.java index fc5e3d98a20..3c924d8bfc0 100644 --- a/jdk/src/share/classes/java/net/HostPortrange.java +++ b/jdk/src/share/classes/java/net/HostPortrange.java @@ -114,7 +114,7 @@ class HostPortrange { if (hoststr.equals("*")) { hoststr = ""; } else if (hoststr.startsWith("*.")) { - hoststr = hoststr.substring(1).toLowerCase(); // leave the '.' ? + hoststr = toLowerCase(hoststr.substring(1)); } else { throw new IllegalArgumentException("invalid host wildcard specification"); } @@ -147,7 +147,7 @@ class HostPortrange { hoststr = sb.toString(); } else { // regular domain name - hoststr = hoststr.toLowerCase(); + hoststr = toLowerCase(hoststr); } } } @@ -161,6 +161,38 @@ class HostPortrange { } } + static final int CASE_DIFF = 'A' - 'a'; + + /** + * Convert to lower case, and check that all chars are ascii + * alphanumeric, '-' or '.' only. + */ + static String toLowerCase(String s) { + int len = s.length(); + StringBuilder sb = null; + + for (int i=0; i<len; i++) { + char c = s.charAt(i); + if ((c >= 'a' && c <= 'z') || (c == '.')) { + if (sb != null) + sb.append(c); + } else if ((c >= '0' && c <= '9') || (c == '-')) { + if (sb != null) + sb.append(c); + } else if (c >= 'A' && c <= 'Z') { + if (sb == null) { + sb = new StringBuilder(len); + sb.append(s, 0, i); + } + sb.append((char)(c - CASE_DIFF)); + } else { + throw new IllegalArgumentException("Invalid characters in hostname"); + } + } + return sb == null ? s : sb.toString(); + } + + public boolean literal() { return literal; } diff --git a/jdk/src/share/classes/java/net/InetAddress.java b/jdk/src/share/classes/java/net/InetAddress.java index 3bb7249d72a..99ec1acb97f 100644 --- a/jdk/src/share/classes/java/net/InetAddress.java +++ b/jdk/src/share/classes/java/net/InetAddress.java @@ -1135,7 +1135,7 @@ class InetAddress implements java.io.Serializable { // see if it is IPv4 address addr = IPAddressUtil.textToNumericFormatV4(host); if (addr == null) { - // see if it is IPv6 address + // This is supposed to be an IPv6 literal // Check if a numeric or string zone id is present int pos; if ((pos=host.indexOf ("%")) != -1) { @@ -1144,7 +1144,9 @@ class InetAddress implements java.io.Serializable { ifname = host.substring (pos+1); } } - addr = IPAddressUtil.textToNumericFormatV6(host); + if ((addr = IPAddressUtil.textToNumericFormatV6(host)) == null && host.contains(":")) { + throw new UnknownHostException(host + ": invalid IPv6 address"); + } } else if (ipv6Expected) { // Means an IPv4 litteral between brackets! throw new UnknownHostException("["+host+"]"); @@ -1162,10 +1164,10 @@ class InetAddress implements java.io.Serializable { } return ret; } - } else if (ipv6Expected) { - // We were expecting an IPv6 Litteral, but got something else - throw new UnknownHostException("["+host+"]"); - } + } else if (ipv6Expected) { + // We were expecting an IPv6 Litteral, but got something else + throw new UnknownHostException("["+host+"]"); + } return getAllByName0(host, reqAddr, true); } diff --git a/jdk/src/share/classes/java/net/URLPermission.java b/jdk/src/share/classes/java/net/URLPermission.java index 7ad56a1c20f..13472a9e5ab 100644 --- a/jdk/src/share/classes/java/net/URLPermission.java +++ b/jdk/src/share/classes/java/net/URLPermission.java @@ -426,7 +426,10 @@ public final class URLPermission extends Permission { this.ssp = url.substring(delim + 1); if (!ssp.startsWith("//")) { - this.authority = new Authority(scheme, ssp.toLowerCase()); + if (!ssp.equals("*")) { + throw new IllegalArgumentException("invalid URL string"); + } + this.authority = new Authority(scheme, "*"); return; } String authpath = ssp.substring(2); diff --git a/jdk/src/share/classes/java/nio/file/TempFileHelper.java b/jdk/src/share/classes/java/nio/file/TempFileHelper.java index 7c348d5c8dd..8d171dee269 100644 --- a/jdk/src/share/classes/java/nio/file/TempFileHelper.java +++ b/jdk/src/share/classes/java/nio/file/TempFileHelper.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -81,7 +81,7 @@ class TempFileHelper { String prefix, String suffix, boolean createDirectory, - FileAttribute[] attrs) + FileAttribute<?>[] attrs) throws IOException { if (prefix == null) @@ -155,7 +155,7 @@ class TempFileHelper { static Path createTempFile(Path dir, String prefix, String suffix, - FileAttribute[] attrs) + FileAttribute<?>[] attrs) throws IOException { return create(dir, prefix, suffix, false, attrs); @@ -167,7 +167,7 @@ class TempFileHelper { */ static Path createTempDirectory(Path dir, String prefix, - FileAttribute[] attrs) + FileAttribute<?>[] attrs) throws IOException { return create(dir, prefix, null, true, attrs); diff --git a/jdk/src/share/classes/java/time/format/DateTimeParseContext.java b/jdk/src/share/classes/java/time/format/DateTimeParseContext.java index 3157747a6f7..026a595896c 100644 --- a/jdk/src/share/classes/java/time/format/DateTimeParseContext.java +++ b/jdk/src/share/classes/java/time/format/DateTimeParseContext.java @@ -369,7 +369,8 @@ final class DateTimeParseContext { Objects.requireNonNull(chrono, "chrono"); currentParsed().chrono = chrono; if (chronoListeners != null && !chronoListeners.isEmpty()) { - Consumer[] tmp = new Consumer[1]; + @SuppressWarnings({"rawtypes", "unchecked"}) + Consumer<Chronology>[] tmp = new Consumer[1]; Consumer<Chronology>[] listeners = chronoListeners.toArray(tmp); chronoListeners.clear(); for (Consumer<Chronology> l : listeners) { diff --git a/jdk/src/share/classes/java/time/format/Parsed.java b/jdk/src/share/classes/java/time/format/Parsed.java index 38eda948f82..71961003e23 100644 --- a/jdk/src/share/classes/java/time/format/Parsed.java +++ b/jdk/src/share/classes/java/time/format/Parsed.java @@ -266,14 +266,14 @@ final class Parsed implements TemporalAccessor { TemporalAccessor resolvedObject = targetField.resolve(fieldValues, this, resolverStyle); if (resolvedObject != null) { if (resolvedObject instanceof ChronoZonedDateTime) { - ChronoZonedDateTime czdt = (ChronoZonedDateTime) resolvedObject; + ChronoZonedDateTime<?> czdt = (ChronoZonedDateTime) resolvedObject; if (zone.equals(czdt.getZone()) == false) { throw new DateTimeException("ChronoZonedDateTime must use the effective parsed zone: " + zone); } resolvedObject = czdt.toLocalDateTime(); } if (resolvedObject instanceof ChronoLocalDateTime) { - ChronoLocalDateTime cldt = (ChronoLocalDateTime) resolvedObject; + ChronoLocalDateTime<?> cldt = (ChronoLocalDateTime) resolvedObject; updateCheckConflict(cldt.toLocalTime(), Period.ZERO); updateCheckConflict(cldt.toLocalDate()); changedCount++; diff --git a/jdk/src/share/classes/java/util/Base64.java b/jdk/src/share/classes/java/util/Base64.java index db281388791..ac5a5d6be92 100644 --- a/jdk/src/share/classes/java/util/Base64.java +++ b/jdk/src/share/classes/java/util/Base64.java @@ -138,7 +138,7 @@ public class Base64 { if (lineLength <= 0) { return Encoder.RFC4648; } - return new Encoder(false, lineSeparator, lineLength >> 2 << 2); + return new Encoder(false, lineSeparator, lineLength >> 2 << 2, true); } /** @@ -192,11 +192,13 @@ public class Base64 { private final byte[] newline; private final int linemax; private final boolean isURL; + private final boolean doPadding; - private Encoder(boolean isURL, byte[] newline, int linemax) { + private Encoder(boolean isURL, byte[] newline, int linemax, boolean doPadding) { this.isURL = isURL; this.newline = newline; this.linemax = linemax; + this.doPadding = doPadding; } /** @@ -228,9 +230,22 @@ public class Base64 { private static final int MIMELINEMAX = 76; private static final byte[] CRLF = new byte[] {'\r', '\n'}; - static final Encoder RFC4648 = new Encoder(false, null, -1); - static final Encoder RFC4648_URLSAFE = new Encoder(true, null, -1); - static final Encoder RFC2045 = new Encoder(false, CRLF, MIMELINEMAX); + static final Encoder RFC4648 = new Encoder(false, null, -1, true); + static final Encoder RFC4648_URLSAFE = new Encoder(true, null, -1, true); + static final Encoder RFC2045 = new Encoder(false, CRLF, MIMELINEMAX, true); + + private final int outLength(int srclen) { + int len = 0; + if (doPadding) { + len = 4 * ((srclen + 2) / 3); + } else { + int n = srclen % 3; + len = 4 * (srclen / 3) + (n == 0 ? 0 : n + 1); + } + if (linemax > 0) // line separators + len += (len - 1) / linemax * newline.length; + return len; + } /** * Encodes all bytes from the specified byte array into a newly-allocated @@ -243,9 +258,7 @@ public class Base64 { * encoded bytes. */ public byte[] encode(byte[] src) { - int len = 4 * ((src.length + 2) / 3); // dst array size - if (linemax > 0) // line separators - len += (len - 1) / linemax * newline.length; + int len = outLength(src.length); // dst array size byte[] dst = new byte[len]; int ret = encode0(src, 0, src.length, dst); if (ret != dst.length) @@ -273,10 +286,7 @@ public class Base64 { * space for encoding all input bytes. */ public int encode(byte[] src, byte[] dst) { - int len = 4 * ((src.length + 2) / 3); // dst array size - if (linemax > 0) { - len += (len - 1) / linemax * newline.length; - } + int len = outLength(src.length); // dst array size if (dst.length < len) throw new IllegalArgumentException( "Output byte array is too small for encoding all input bytes"); @@ -321,9 +331,7 @@ public class Base64 { * @return A newly-allocated byte buffer containing the encoded bytes. */ public ByteBuffer encode(ByteBuffer buffer) { - int len = 4 * ((buffer.remaining() + 2) / 3); - if (linemax > 0) - len += (len - 1) / linemax * newline.length; + int len = outLength(buffer.remaining()); byte[] dst = new byte[len]; int ret = 0; if (buffer.hasArray()) { @@ -415,7 +423,25 @@ public class Base64 { public OutputStream wrap(OutputStream os) { Objects.requireNonNull(os); return new EncOutputStream(os, isURL ? toBase64URL : toBase64, - newline, linemax); + newline, linemax, doPadding); + } + + /** + * Returns an encoder instance that encodes equivalently to this one, + * but without adding any padding character at the end of the encoded + * byte data. + * + * <p> The encoding scheme of this encoder instance is unaffected by + * this invocation. The returned encoder instance should be used for + * non-padding encoding operation. + * + * @return an equivalent encoder that encodes without adding any + * padding character at the end + */ + public Encoder withoutPadding() { + if (!doPadding) + return this; + return new Encoder(isURL, newline, linemax, false); } private int encodeArray(ByteBuffer src, ByteBuffer dst, int bytesOut) { @@ -476,13 +502,17 @@ public class Base64 { da[dp++] = (byte)base64[b0 >> 2]; if (sp == sl) { da[dp++] = (byte)base64[(b0 << 4) & 0x3f]; - da[dp++] = '='; - da[dp++] = '='; + if (doPadding) { + da[dp++] = '='; + da[dp++] = '='; + } } else { int b1 = sa[sp++] & 0xff; da[dp++] = (byte)base64[(b0 << 4) & 0x3f | (b1 >> 4)]; da[dp++] = (byte)base64[(b1 << 2) & 0x3f]; - da[dp++] = '='; + if (doPadding) { + da[dp++] = '='; + } } } return dp - dp00 + bytesOut; @@ -548,13 +578,17 @@ public class Base64 { dst.put(dp++, (byte)base64[b0 >> 2]); if (sp == src.limit()) { dst.put(dp++, (byte)base64[(b0 << 4) & 0x3f]); - dst.put(dp++, (byte)'='); - dst.put(dp++, (byte)'='); + if (doPadding) { + dst.put(dp++, (byte)'='); + dst.put(dp++, (byte)'='); + } } else { int b1 = src.get(sp++) & 0xff; dst.put(dp++, (byte)base64[(b0 << 4) & 0x3f | (b1 >> 4)]); dst.put(dp++, (byte)base64[(b1 << 2) & 0x3f]); - dst.put(dp++, (byte)'='); + if (doPadding) { + dst.put(dp++, (byte)'='); + } } } return dp - dp00 + bytesOut; @@ -597,13 +631,17 @@ public class Base64 { dst[dp++] = (byte)base64[b0 >> 2]; if (sp == end) { dst[dp++] = (byte)base64[(b0 << 4) & 0x3f]; - dst[dp++] = '='; - dst[dp++] = '='; + if (doPadding) { + dst[dp++] = '='; + dst[dp++] = '='; + } } else { int b1 = src[sp++] & 0xff; dst[dp++] = (byte)base64[(b0 << 4) & 0x3f | (b1 >> 4)]; dst[dp++] = (byte)base64[(b1 << 2) & 0x3f]; - dst[dp++] = '='; + if (doPadding) { + dst[dp++] = '='; + } } } return dp; @@ -1149,14 +1187,16 @@ public class Base64 { private final char[] base64; // byte->base64 mapping private final byte[] newline; // line separator, if needed private final int linemax; + private final boolean doPadding;// whether or not to pad private int linepos = 0; - EncOutputStream(OutputStream os, - char[] base64, byte[] newline, int linemax) { + EncOutputStream(OutputStream os, char[] base64, + byte[] newline, int linemax, boolean doPadding) { super(os); this.base64 = base64; this.newline = newline; this.linemax = linemax; + this.doPadding = doPadding; } @Override @@ -1228,14 +1268,18 @@ public class Base64 { checkNewline(); out.write(base64[b0 >> 2]); out.write(base64[(b0 << 4) & 0x3f]); - out.write('='); - out.write('='); + if (doPadding) { + out.write('='); + out.write('='); + } } else if (leftover == 2) { checkNewline(); out.write(base64[b0 >> 2]); out.write(base64[(b0 << 4) & 0x3f | (b1 >> 4)]); out.write(base64[(b1 << 2) & 0x3f]); - out.write('='); + if (doPadding) { + out.write('='); + } } leftover = 0; out.close(); diff --git a/jdk/src/share/classes/java/util/IdentityHashMap.java b/jdk/src/share/classes/java/util/IdentityHashMap.java index 40808213894..3db40588d77 100644 --- a/jdk/src/share/classes/java/util/IdentityHashMap.java +++ b/jdk/src/share/classes/java/util/IdentityHashMap.java @@ -1243,7 +1243,7 @@ public class IdentityHashMap<K,V> if (ti >= size) { throw new ConcurrentModificationException(); } - a[ti++] = (T) new AbstractMap.SimpleEntry(unmaskNull(key), tab[si + 1]); + a[ti++] = (T) new AbstractMap.SimpleEntry<>(unmaskNull(key), tab[si + 1]); } } // fewer elements than expected or concurrent modification from other thread detected diff --git a/jdk/src/share/classes/java/util/concurrent/ForkJoinPool.java b/jdk/src/share/classes/java/util/concurrent/ForkJoinPool.java index 749f8b57361..edf17873b60 100644 --- a/jdk/src/share/classes/java/util/concurrent/ForkJoinPool.java +++ b/jdk/src/share/classes/java/util/concurrent/ForkJoinPool.java @@ -1820,7 +1820,7 @@ public class ForkJoinPool extends AbstractExecutorService { } } for (;;) { // help stealer or descend to its stealer - ForkJoinTask[] a; int b; + ForkJoinTask<?>[] a; int b; if (subtask.status < 0) // surround probes with continue restart; // consistency checks if ((b = v.base) - v.top < 0 && (a = v.array) != null) { diff --git a/jdk/src/share/classes/java/util/concurrent/ScheduledThreadPoolExecutor.java b/jdk/src/share/classes/java/util/concurrent/ScheduledThreadPoolExecutor.java index 458828c90ed..24ab59acd29 100644 --- a/jdk/src/share/classes/java/util/concurrent/ScheduledThreadPoolExecutor.java +++ b/jdk/src/share/classes/java/util/concurrent/ScheduledThreadPoolExecutor.java @@ -1253,11 +1253,11 @@ public class ScheduledThreadPoolExecutor * Snapshot iterator that works off copy of underlying q array. */ private class Itr implements Iterator<Runnable> { - final RunnableScheduledFuture[] array; + final RunnableScheduledFuture<?>[] array; int cursor = 0; // index of next element to return int lastRet = -1; // index of last element, or -1 if no such - Itr(RunnableScheduledFuture[] array) { + Itr(RunnableScheduledFuture<?>[] array) { this.array = array; } diff --git a/jdk/src/share/classes/java/util/logging/Logger.java b/jdk/src/share/classes/java/util/logging/Logger.java index efc18c520c0..1976512cac8 100644 --- a/jdk/src/share/classes/java/util/logging/Logger.java +++ b/jdk/src/share/classes/java/util/logging/Logger.java @@ -351,7 +351,7 @@ public class Logger { ? caller.getClassLoader() : null); if (callersClassLoader != null) { - this.callersClassLoaderRef = new WeakReference(callersClassLoader); + this.callersClassLoaderRef = new WeakReference<>(callersClassLoader); } } diff --git a/jdk/src/share/classes/java/util/logging/Logging.java b/jdk/src/share/classes/java/util/logging/Logging.java index e22a82e9d19..740a533063d 100644 --- a/jdk/src/share/classes/java/util/logging/Logging.java +++ b/jdk/src/share/classes/java/util/logging/Logging.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -55,11 +55,11 @@ class Logging implements LoggingMXBean { } public List<String> getLoggerNames() { - Enumeration loggers = logManager.getLoggerNames(); + Enumeration<String> loggers = logManager.getLoggerNames(); ArrayList<String> array = new ArrayList<>(); for (; loggers.hasMoreElements();) { - array.add((String) loggers.nextElement()); + array.add(loggers.nextElement()); } return array; } diff --git a/jdk/src/share/classes/java/util/regex/Pattern.java b/jdk/src/share/classes/java/util/regex/Pattern.java index e9a0c67f79d..b5578b6a918 100644 --- a/jdk/src/share/classes/java/util/regex/Pattern.java +++ b/jdk/src/share/classes/java/util/regex/Pattern.java @@ -1142,10 +1142,15 @@ public final class Pattern * input sequence that is terminated by another subsequence that matches * this pattern or is terminated by the end of the input sequence. The * substrings in the array are in the order in which they occur in the - * input. If this pattern does not match any subsequence of the input then + * input. If this pattern does not match any subsequence of the input then * the resulting array has just one element, namely the input sequence in * string form. * + * <p> When there is a positive-width match at the beginning of the input + * sequence then an empty leading substring is included at the beginning + * of the resulting array. A zero-width match at the beginning however + * never produces such empty leading substring. + * * <p> The <tt>limit</tt> parameter controls the number of times the * pattern is applied and therefore affects the length of the resulting * array. If the limit <i>n</i> is greater than zero then the pattern @@ -1185,7 +1190,6 @@ public final class Pattern * <td><tt>{ "b", "", ":and:f" }</tt></td></tr> * </table></blockquote> * - * * @param input * The character sequence to be split * @@ -1204,6 +1208,11 @@ public final class Pattern // Add segments before each match found while(m.find()) { if (!matchLimited || matchList.size() < limit - 1) { + if (index == 0 && index == m.start() && m.start() == m.end()) { + // no empty leading substring included for zero-width match + // at the beginning of the input char sequence. + continue; + } String match = input.subSequence(index, m.start()).toString(); matchList.add(match); index = m.end(); @@ -5755,13 +5764,18 @@ NEXT: while (i <= last) { * input sequence that is terminated by another subsequence that matches * this pattern or is terminated by the end of the input sequence. The * substrings in the stream are in the order in which they occur in the - * input. Trailing empty strings will be discarded and not encountered in + * input. Trailing empty strings will be discarded and not encountered in * the stream. * * <p> If this pattern does not match any subsequence of the input then * the resulting stream has just one element, namely the input sequence in * string form. * + * <p> When there is a positive-width match at the beginning of the input + * sequence then an empty leading substring is included at the beginning + * of the stream. A zero-width match at the beginning however never produces + * such empty leading substring. + * * <p> If the input sequence is mutable, it must remain constant during the * execution of the terminal stream operation. Otherwise, the result of the * terminal stream operation is undefined. @@ -5817,7 +5831,8 @@ NEXT: while (i <= last) { current = matcher.end(); if (!nextElement.isEmpty()) { return true; - } else { + } else if (current > 0) { // no empty leading substring for zero-width + // match at the beginning of the input emptyElementCount++; } } diff --git a/jdk/src/share/classes/javax/management/AttributeList.java b/jdk/src/share/classes/javax/management/AttributeList.java index 9825d93fc19..2fd3bdb6505 100644 --- a/jdk/src/share/classes/javax/management/AttributeList.java +++ b/jdk/src/share/classes/javax/management/AttributeList.java @@ -178,8 +178,8 @@ public class AttributeList extends ArrayList<Object> { /** * Inserts the attribute specified as an element at the position specified. * Elements with an index greater than or equal to the current position are - * shifted up. If the index is out of range (index < 0 || index > - * size()) a RuntimeOperationsException should be raised, wrapping the + * shifted up. If the index is out of range {@literal (index < 0 || index > + * size())} a RuntimeOperationsException should be raised, wrapping the * java.lang.IndexOutOfBoundsException thrown. * * @param object The <CODE>Attribute</CODE> object to be inserted. @@ -199,7 +199,7 @@ public class AttributeList extends ArrayList<Object> { /** * Sets the element at the position specified to be the attribute specified. * The previous element at that position is discarded. If the index is - * out of range (index < 0 || index > size() a RuntimeOperationsException + * out of range {@literal (index < 0 || index > size())} a RuntimeOperationsException * should be raised, wrapping the java.lang.IndexOutOfBoundsException thrown. * * @param object The value to which the attribute element should be set. @@ -234,7 +234,7 @@ public class AttributeList extends ArrayList<Object> { * Inserts all of the elements in the <CODE>AttributeList</CODE> specified * into this list, starting at the specified position, in the order in which * they are returned by the Iterator of the {@code AttributeList} specified. - * If the index is out of range (index < 0 || index > size() a + * If the index is out of range {@literal (index < 0 || index > size())} a * RuntimeOperationsException should be raised, wrapping the * java.lang.IndexOutOfBoundsException thrown. * diff --git a/jdk/src/share/classes/javax/management/BooleanValueExp.java b/jdk/src/share/classes/javax/management/BooleanValueExp.java index 8aa399a28df..23842612c2e 100644 --- a/jdk/src/share/classes/javax/management/BooleanValueExp.java +++ b/jdk/src/share/classes/javax/management/BooleanValueExp.java @@ -44,12 +44,12 @@ class BooleanValueExp extends QueryEval implements ValueExp { private boolean val = false; - /** Creates a new BooleanValueExp representing the boolean literal <val>.*/ + /** Creates a new BooleanValueExp representing the boolean literal {@code val}.*/ BooleanValueExp(boolean val) { this.val = val; } - /**Creates a new BooleanValueExp representing the Boolean object <val>.*/ + /**Creates a new BooleanValueExp representing the Boolean object {@code val}.*/ BooleanValueExp(Boolean val) { this.val = val.booleanValue(); } diff --git a/jdk/src/share/classes/javax/management/Descriptor.java b/jdk/src/share/classes/javax/management/Descriptor.java index b07447ad590..0cd325fc1cd 100644 --- a/jdk/src/share/classes/javax/management/Descriptor.java +++ b/jdk/src/share/classes/javax/management/Descriptor.java @@ -96,7 +96,7 @@ import javax.management.openmbean.OpenType; * of the mapped Java type, called <em>opendata</em>(J) in the <a * href="MXBean.html#mapping-rules">MXBean type mapping rules</a>.</p> * - * <table border="1" cellpadding="5"> + * <table border="1" cellpadding="5" summary="Descriptor Fields"> * * <tr><th>Name</th><th>Type</th><th>Used in</th><th>Meaning</th></tr> * @@ -330,7 +330,7 @@ import javax.management.openmbean.OpenType; * interest outside Model MBeans, for example. But only Model MBeans have * a predefined behavior for these fields.</p> * - * <table border="1" cellpadding="5"> + * <table border="1" cellpadding="5" summary="ModelMBean Fields"> * * <tr><th>Name</th><th>Type</th><th>Used in</th><th>Meaning</th></tr> * diff --git a/jdk/src/share/classes/javax/management/DescriptorKey.java b/jdk/src/share/classes/javax/management/DescriptorKey.java index 64224999731..5ca8ee9bd51 100644 --- a/jdk/src/share/classes/javax/management/DescriptorKey.java +++ b/jdk/src/share/classes/javax/management/DescriptorKey.java @@ -94,7 +94,7 @@ import java.lang.annotation.*; * <p>then the resulting {@code Descriptor} will contain the following * fields:</p> * - * <table border="2"> + * <table border="2" summary="Descriptor Fields"> * <tr><th>Name</th><th>Value</th></tr> * <tr><td>units</td><td>"bytes"</td></tr> * <tr><td>descriptionResourceKey</td><td>"bytes.key"</td></tr> @@ -143,7 +143,7 @@ import java.lang.annotation.*; * or an array of annotations. The value of the field is derived from * the value of the annotation element as follows:</p> * - * <table border="2"> + * <table border="2" summary="Descriptor Field Types"> * <tr><th>Annotation element</th><th>Descriptor field</th></tr> * <tr><td>Primitive value ({@code 5}, {@code false}, etc)</td> * <td>Wrapped value ({@code Integer.valueOf(5)}, diff --git a/jdk/src/share/classes/javax/management/ImmutableDescriptor.java b/jdk/src/share/classes/javax/management/ImmutableDescriptor.java index 3eff0c25e0b..b2af95e52e7 100644 --- a/jdk/src/share/classes/javax/management/ImmutableDescriptor.java +++ b/jdk/src/share/classes/javax/management/ImmutableDescriptor.java @@ -344,7 +344,7 @@ public class ImmutableDescriptor implements Descriptor { * the given object is also a Descriptor, and if the two Descriptors have * the same field names (possibly differing in case) and the same * associated values. The respective values for a field in the two - * Descriptors are equal if the following conditions hold:</p> + * Descriptors are equal if the following conditions hold: * * <ul> * <li>If one value is null then the other must be too.</li> diff --git a/jdk/src/share/classes/javax/management/JMX.java b/jdk/src/share/classes/javax/management/JMX.java index fe5d9093ac2..ffa53cfe2c9 100644 --- a/jdk/src/share/classes/javax/management/JMX.java +++ b/jdk/src/share/classes/javax/management/JMX.java @@ -217,8 +217,7 @@ public class JMX { } /** - * <p>Make a proxy for an MXBean in a local or remote - * MBean Server.</p> + * Make a proxy for an MXBean in a local or remote MBean Server. * * <p>If you have an MBean Server {@code mbs} containing an * MXBean with {@link ObjectName} {@code name}, and if the @@ -253,7 +252,7 @@ public class JMX { * <li><p>{@code proxy.setSimpleAttribute("whatever")} will result * in a call to {@code mbs.}{@link * MBeanServerConnection#setAttribute setAttribute}<code>(name, - * new Attribute("SimpleAttribute", "whatever"))</code>.<p> + * new Attribute("SimpleAttribute", "whatever"))</code>.</p> * * <p>Because {@code String} is a <em>simple type</em>, in the * sense of {@link javax.management.openmbean.SimpleType}, it diff --git a/jdk/src/share/classes/javax/management/MBeanFeatureInfo.java b/jdk/src/share/classes/javax/management/MBeanFeatureInfo.java index ec8e8b622b8..5acd054affe 100644 --- a/jdk/src/share/classes/javax/management/MBeanFeatureInfo.java +++ b/jdk/src/share/classes/javax/management/MBeanFeatureInfo.java @@ -162,7 +162,7 @@ public class MBeanFeatureInfo implements Serializable, DescriptorRead { * Serializes an {@link MBeanFeatureInfo} to an {@link ObjectOutputStream}. * @serialData * For compatibility reasons, an object of this class is serialized as follows. - * <ul> + * <p> * The method {@link ObjectOutputStream#defaultWriteObject defaultWriteObject()} * is called first to serialize the object except the field {@code descriptor} * which is declared as transient. The field {@code descriptor} is serialized @@ -180,7 +180,7 @@ public class MBeanFeatureInfo implements Serializable, DescriptorRead { * {@link ObjectOutputStream#writeObject writeObject(Object obj)} is called * to serialize directly the field {@code descriptor}. * </ul> - * </ul> + * * @since 1.6 */ private void writeObject(ObjectOutputStream out) throws IOException { @@ -206,7 +206,7 @@ public class MBeanFeatureInfo implements Serializable, DescriptorRead { * Deserializes an {@link MBeanFeatureInfo} from an {@link ObjectInputStream}. * @serialData * For compatibility reasons, an object of this class is deserialized as follows. - * <ul> + * <p> * The method {@link ObjectInputStream#defaultReadObject defaultReadObject()} * is called first to deserialize the object except the field * {@code descriptor}, which is not serialized in the default way. Then the method @@ -228,7 +228,7 @@ public class MBeanFeatureInfo implements Serializable, DescriptorRead { * to {@link ImmutableDescriptor#EMPTY_DESCRIPTOR EMPTY_DESCRIPTOR}</li> * <li>Any other value. A {@link StreamCorruptedException} is thrown.</li> * </ul> - * </ul> + * * @since 1.6 */ private void readObject(ObjectInputStream in) diff --git a/jdk/src/share/classes/javax/management/MBeanInfo.java b/jdk/src/share/classes/javax/management/MBeanInfo.java index f4a9581c520..d10dd1cca28 100644 --- a/jdk/src/share/classes/javax/management/MBeanInfo.java +++ b/jdk/src/share/classes/javax/management/MBeanInfo.java @@ -619,7 +619,7 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead { * Serializes an {@link MBeanInfo} to an {@link ObjectOutputStream}. * @serialData * For compatibility reasons, an object of this class is serialized as follows. - * <ul> + * <p> * The method {@link ObjectOutputStream#defaultWriteObject defaultWriteObject()} * is called first to serialize the object except the field {@code descriptor} * which is declared as transient. The field {@code descriptor} is serialized @@ -637,7 +637,7 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead { * {@link ObjectOutputStream#writeObject writeObject(Object obj)} is called * to serialize the field {@code descriptor} directly. * </ul> - * </ul> + * * @since 1.6 */ private void writeObject(ObjectOutputStream out) throws IOException { @@ -661,7 +661,7 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead { * Deserializes an {@link MBeanInfo} from an {@link ObjectInputStream}. * @serialData * For compatibility reasons, an object of this class is deserialized as follows. - * <ul> + * <p> * The method {@link ObjectInputStream#defaultReadObject defaultReadObject()} * is called first to deserialize the object except the field * {@code descriptor}, which is not serialized in the default way. Then the method @@ -683,7 +683,7 @@ public class MBeanInfo implements Cloneable, Serializable, DescriptorRead { * {@link ImmutableDescriptor#EMPTY_DESCRIPTOR EMPTY_DESCRIPTOR}.</li> * <li>Any other value. A {@link StreamCorruptedException} is thrown.</li> * </ul> - * </ul> + * * @since 1.6 */ diff --git a/jdk/src/share/classes/javax/management/MBeanServer.java b/jdk/src/share/classes/javax/management/MBeanServer.java index 901be1076e1..909e31da5f5 100644 --- a/jdk/src/share/classes/javax/management/MBeanServer.java +++ b/jdk/src/share/classes/javax/management/MBeanServer.java @@ -244,7 +244,6 @@ import javax.management.loading.ClassLoaderRepository; * the caller's permissions must imply {@link * MBeanPermission#MBeanPermission(String,String,ObjectName,String) * MBeanPermission(className, null, name, "unregisterMBean")}.</p> - * </p> * * </ul> * diff --git a/jdk/src/share/classes/javax/management/MBeanServerConnection.java b/jdk/src/share/classes/javax/management/MBeanServerConnection.java index dc3c3f4b35d..505a44e4a6e 100644 --- a/jdk/src/share/classes/javax/management/MBeanServerConnection.java +++ b/jdk/src/share/classes/javax/management/MBeanServerConnection.java @@ -627,7 +627,7 @@ public interface MBeanServerConnection { * for that attribute, although this is not guaranteed to work. (For * example, the values of two attributes may have been rejected because * they were inconsistent with each other. Setting one of them alone might - * be allowed.)<p> + * be allowed.) * * <p>Here is an example of calling this method and checking that it * succeeded in setting all the requested attributes:</p> diff --git a/jdk/src/share/classes/javax/management/MBeanServerNotification.java b/jdk/src/share/classes/javax/management/MBeanServerNotification.java index 61d57e6dc58..aec2f1870d5 100644 --- a/jdk/src/share/classes/javax/management/MBeanServerNotification.java +++ b/jdk/src/share/classes/javax/management/MBeanServerNotification.java @@ -86,7 +86,7 @@ package javax.management; * be set to an array of ObjectNames containing the names of all MBeans * being registered or unregistered.</li> * </ul> - * </p> + * * <p> * MBeans which emit these group registration/unregistration notifications will * declare them in their {@link MBeanInfo#getNotifications() diff --git a/jdk/src/share/classes/javax/management/MXBean.java b/jdk/src/share/classes/javax/management/MXBean.java index e4c920651bc..85db37b241a 100644 --- a/jdk/src/share/classes/javax/management/MXBean.java +++ b/jdk/src/share/classes/javax/management/MXBean.java @@ -79,7 +79,7 @@ import javax.management.openmbean.TabularType; public interface MisleadingMXBean {} </pre> - <h3 id="MXBean-spec">MXBean specification</a></h3> + <h3 id="MXBean-spec">MXBean specification</h3> <p>The MXBean concept provides a simple way to code an MBean that only references a predefined set of types, the ones defined @@ -93,7 +93,7 @@ import javax.management.openmbean.TabularType; Standard MBean concept. Here is how a managed object might be represented as a Standard MBean, and as an MXBean:</p> - <table border="1" cellpadding="5"> + <table border="1" cellpadding="5" summary="Standard Bean vs. MXBean"> <tr> <th>Standard MBean</th><th>MXBean</th> </tr> @@ -133,7 +133,7 @@ public interface MemoryPool<b>MXBean</b> { <p>So, we might define <code>MemoryUsage</code> like this:</p> - <table border="1" cellpadding="5"> + <table border="1" cellpadding="5" summary="Standard Bean vs. MXBean"> <tr> <th>Standard MBean</th><th>MXBean</th> </tr> @@ -195,7 +195,7 @@ public class MemoryUsage { <p>This becomes clearer if we compare what the clients of the two models might look like:</p> - <table border="1" cellpadding="5"> + <table border="1" cellpadding="5" summary="Standard Bean vs. MXBean"> <tr> <th>Standard MBean</th><th>MXBean</th> </tr> @@ -232,7 +232,7 @@ String name = (String) managed objects when you know the model beforehand, regardless of whether you are using Standard MBeans or MXBeans:</p> - <table border="1" cellpadding="5"> + <table border="1" cellpadding="5" summary="Standard Bean vs. MXBean"> <tr> <th>Standard MBean</th><th>MXBean</th> </tr> @@ -265,7 +265,7 @@ long used = usage.getUsed(); <p>Implementing the MemoryPool object works similarly for both Standard MBeans and MXBeans.</p> - <table border="1" cellpadding="5"> + <table border="1" cellpadding="5" summary="Standard Bean vs. MXBean"> <tr> <th>Standard MBean</th><th>MXBean</th> </tr> @@ -292,7 +292,7 @@ public class MemoryPool <p>Registering the MBean in the MBean Server works in the same way in both cases:</p> - <table border="1" cellpadding="5"> + <table border="1" cellpadding="5" summary="Standard Bean vs. MXBean"> <tr> <th>Standard MBean</th><th>MXBean</th> </tr> @@ -478,13 +478,13 @@ public class MemoryPool <p>The following table summarizes the type mapping rules.</p> - <table border="1" cellpadding="5"> + <table border="1" cellpadding="5" summary="Type Mapping Rules"> <tr> <th>Java type <em>J</em></th> <th><em>opentype(J)</em></th> <th><em>opendata(J)</em></th> </tr> - <tbody cellvalign="top"> + <tbody valign="top"> <tr> <td>{@code int}, {@code boolean}, etc<br> (the 8 primitive Java types)</td> @@ -785,7 +785,7 @@ public interface ModuleMXBean { </blockquote> then the item in the {@code CompositeType} is called {@code name} - and has type {@code SimpleType.BOOLEAN}.</p> + and has type {@code SimpleType.BOOLEAN}. <p>Notice that the first character (or code point) is converted to lower case. This follows the Java Beans convention, which for diff --git a/jdk/src/share/classes/javax/management/NumericValueExp.java b/jdk/src/share/classes/javax/management/NumericValueExp.java index 96090352231..2feb1f3467b 100644 --- a/jdk/src/share/classes/javax/management/NumericValueExp.java +++ b/jdk/src/share/classes/javax/management/NumericValueExp.java @@ -112,7 +112,7 @@ class NumericValueExp extends QueryEval implements ValueExp { public NumericValueExp() { } - /** Creates a new NumericValue representing the numeric literal <val>.*/ + /** Creates a new NumericValue representing the numeric literal @{code val}.*/ NumericValueExp(Number val) { this.val = val; diff --git a/jdk/src/share/classes/javax/management/ObjectName.java b/jdk/src/share/classes/javax/management/ObjectName.java index 32b06ccdb5e..c1942f0eba9 100644 --- a/jdk/src/share/classes/javax/management/ObjectName.java +++ b/jdk/src/share/classes/javax/management/ObjectName.java @@ -195,7 +195,7 @@ import java.util.Map; * represents an ObjectName with two keys. The name of each key * contains six characters, of which the first and last are spaces. * The value associated with the key <code>" key1 "</code> - * also begins and ends with a space.</p> + * also begins and ends with a space. * * <p>In addition to the restrictions on characters spelt out above, * no part of an ObjectName may contain a newline character @@ -665,7 +665,7 @@ public class ObjectName implements Comparable<ObjectName>, QueryExp { * Construct an ObjectName from a domain and a Hashtable. * * @param domain Domain of the ObjectName. - * @param props Map containing couples <i>key</i> -> <i>value</i>. + * @param props Map containing couples <i>key</i> {@literal ->} <i>value</i>. * * @exception MalformedObjectNameException The <code>domain</code> * contains an illegal character, or one of the keys or values in @@ -1549,7 +1549,7 @@ public class ObjectName implements Comparable<ObjectName>, QueryExp { * <li>a comma and an * asterisk (<code>,*</code>) for an ObjectName that is a property * list pattern with at least one key. - * </ul></p> + * </ul> * * @return The canonical form of the name. */ diff --git a/jdk/src/share/classes/javax/management/PersistentMBean.java b/jdk/src/share/classes/javax/management/PersistentMBean.java index 0f16202511f..63334096612 100644 --- a/jdk/src/share/classes/javax/management/PersistentMBean.java +++ b/jdk/src/share/classes/javax/management/PersistentMBean.java @@ -70,17 +70,19 @@ public interface PersistentMBean { * <P> * Persistence policy from the MBean and attribute descriptor is used to guide execution * of this method. The MBean should be stored if 'persistPolicy' field is: - * <PRE> != "never" + * <PRE>{@literal != "never" * = "always" * = "onTimer" and now > 'lastPersistTime' + 'persistPeriod' * = "NoMoreOftenThan" and now > 'lastPersistTime' + 'persistPeriod' * = "onUnregister" - * <P> + * }</PRE> + * <p> * Do not store the MBean if 'persistPolicy' field is: + * <PRE>{@literal * = "never" * = "onUpdate" * = "onTimer" && now < 'lastPersistTime' + 'persistPeriod' - * <P></PRE> + * }</PRE> * * @exception MBeanException Wraps another exception or persistence is not supported * @exception RuntimeOperationsException Wraps exceptions from the persistence mechanism diff --git a/jdk/src/share/classes/javax/management/Query.java b/jdk/src/share/classes/javax/management/Query.java index 267f6aa1dae..2a1b33e5868 100644 --- a/jdk/src/share/classes/javax/management/Query.java +++ b/jdk/src/share/classes/javax/management/Query.java @@ -127,9 +127,9 @@ package javax.management; * @param q2 Another query expression. * * @return The conjunction of the two arguments. The returned object - * will be serialized as an instance of the non-public class {@link + * will be serialized as an instance of the non-public class * <a href="../../serialized-form.html#javax.management.AndQueryExp"> - * javax.management.AndQueryExp</a>}. + * javax.management.AndQueryExp</a>. */ public static QueryExp and(QueryExp q1, QueryExp q2) { return new AndQueryExp(q1, q2); @@ -143,9 +143,9 @@ package javax.management; * @param q2 Another query expression. * * @return The disjunction of the two arguments. The returned object - * will be serialized as an instance of the non-public class {@link + * will be serialized as an instance of the non-public class * <a href="../../serialized-form.html#javax.management.OrQueryExp"> - * javax.management.OrQueryExp</a>}. + * javax.management.OrQueryExp</a>. */ public static QueryExp or(QueryExp q1, QueryExp q2) { return new OrQueryExp(q1, q2); @@ -160,9 +160,9 @@ package javax.management; * * @return A "greater than" constraint on the arguments. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> - * javax.management.BinaryRelQueryExp</a>} with a {@code relOp} equal + * non-public class + * <a href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> + * javax.management.BinaryRelQueryExp</a> with a {@code relOp} equal * to {@link #GT}. */ public static QueryExp gt(ValueExp v1, ValueExp v2) { @@ -178,9 +178,9 @@ package javax.management; * * @return A "greater than or equal to" constraint on the * arguments. The returned object will be serialized as an - * instance of the non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> - * javax.management.BinaryRelQueryExp</a>} with a {@code relOp} equal + * instance of the non-public class + * <a href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> + * javax.management.BinaryRelQueryExp</a> with a {@code relOp} equal * to {@link #GE}. */ public static QueryExp geq(ValueExp v1, ValueExp v2) { @@ -196,9 +196,9 @@ package javax.management; * * @return A "less than or equal to" constraint on the arguments. * The returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> - * javax.management.BinaryRelQueryExp</a>} with a {@code relOp} equal + * non-public class + * <a href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> + * javax.management.BinaryRelQueryExp</a> with a {@code relOp} equal * to {@link #LE}. */ public static QueryExp leq(ValueExp v1, ValueExp v2) { @@ -214,9 +214,9 @@ package javax.management; * * @return A "less than" constraint on the arguments. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> - * javax.management.BinaryRelQueryExp</a>} with a {@code relOp} equal + * non-public class + * <a href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> + * javax.management.BinaryRelQueryExp</a> with a {@code relOp} equal * to {@link #LT}. */ public static QueryExp lt(ValueExp v1, ValueExp v2) { @@ -232,9 +232,9 @@ package javax.management; * * @return A "equal to" constraint on the arguments. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> - * javax.management.BinaryRelQueryExp</a>} with a {@code relOp} equal + * non-public class + * <a href="../../serialized-form.html#javax.management.BinaryRelQueryExp"> + * javax.management.BinaryRelQueryExp</a> with a {@code relOp} equal * to {@link #EQ}. */ public static QueryExp eq(ValueExp v1, ValueExp v2) { @@ -251,9 +251,9 @@ package javax.management; * * @return The constraint that v1 lies between v2 and v3. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.BetweenQueryExp"> - * javax.management.BetweenQueryExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.BetweenQueryExp"> + * javax.management.BetweenQueryExp</a>. */ public static QueryExp between(ValueExp v1, ValueExp v2, ValueExp v3) { return new BetweenQueryExp(v1, v2, v3); @@ -279,9 +279,9 @@ package javax.management; * * @return A query expression that represents the matching * constraint on the string argument. The returned object will - * be serialized as an instance of the non-public class {@link <a - * href="../../serialized-form.html#javax.management.MatchQueryExp"> - * javax.management.MatchQueryExp</a>}. + * be serialized as an instance of the non-public class + * <a href="../../serialized-form.html#javax.management.MatchQueryExp"> + * javax.management.MatchQueryExp</a>. */ public static QueryExp match(AttributeValueExp a, StringValueExp s) { return new MatchQueryExp(a, s); @@ -319,9 +319,9 @@ package javax.management; * * @return An attribute expression for the attribute named name. * The returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.QualifiedAttributeValueExp"> - * javax.management.QualifiedAttributeValueExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.QualifiedAttributeValueExp"> + * javax.management.QualifiedAttributeValueExp</a>. */ public static AttributeValueExp attr(String className, String name) { return new QualifiedAttributeValueExp(className, name); @@ -338,9 +338,8 @@ package javax.management; * * @return A class attribute expression. The returned object * will be serialized as an instance of the non-public class - * {@link <a - * href="../../serialized-form.html#javax.management.ClassAttributeValueExp"> - * javax.management.ClassAttributeValueExp</a>}. + * <a href="../../serialized-form.html#javax.management.ClassAttributeValueExp"> + * javax.management.ClassAttributeValueExp</a>. */ public static AttributeValueExp classattr() { return new ClassAttributeValueExp(); @@ -352,9 +351,9 @@ package javax.management; * @param queryExp The constraint to negate. * * @return A negated constraint. The returned object will be - * serialized as an instance of the non-public class {@link <a - * href="../../serialized-form.html#javax.management.NotQueryExp"> - * javax.management.NotQueryExp</a>}. + * serialized as an instance of the non-public class + * <a href="../../serialized-form.html#javax.management.NotQueryExp"> + * javax.management.NotQueryExp</a>. */ public static QueryExp not(QueryExp queryExp) { return new NotQueryExp(queryExp); @@ -368,9 +367,9 @@ package javax.management; * * @return A QueryExp that represents the constraint. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.InQueryExp"> - * javax.management.InQueryExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.InQueryExp"> + * javax.management.InQueryExp</a>. */ public static QueryExp in(ValueExp val, ValueExp valueList[]) { return new InQueryExp(val, valueList); @@ -395,9 +394,9 @@ package javax.management; * * @return A ValueExp object containing the argument. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.NumericValueExp"> - * javax.management.NumericValueExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.NumericValueExp"> + * javax.management.NumericValueExp</a>. */ public static ValueExp value(Number val) { return new NumericValueExp(val); @@ -411,9 +410,9 @@ package javax.management; * * @return A ValueExp object containing the argument. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.NumericValueExp"> - * javax.management.NumericValueExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.NumericValueExp"> + * javax.management.NumericValueExp</a>. */ public static ValueExp value(int val) { return new NumericValueExp((long) val); @@ -427,9 +426,9 @@ package javax.management; * * @return A ValueExp object containing the argument. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.NumericValueExp"> - * javax.management.NumericValueExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.NumericValueExp"> + * javax.management.NumericValueExp</a>. */ public static ValueExp value(long val) { return new NumericValueExp(val); @@ -443,9 +442,9 @@ package javax.management; * * @return A ValueExp object containing the argument. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.NumericValueExp"> - * javax.management.NumericValueExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.NumericValueExp"> + * javax.management.NumericValueExp</a>. */ public static ValueExp value(float val) { return new NumericValueExp((double) val); @@ -459,9 +458,9 @@ package javax.management; * * @return A ValueExp object containing the argument. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.NumericValueExp"> - * javax.management.NumericValueExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.NumericValueExp"> + * javax.management.NumericValueExp</a>. */ public static ValueExp value(double val) { return new NumericValueExp(val); @@ -475,9 +474,9 @@ package javax.management; * * @return A ValueExp object containing the argument. The * returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.BooleanValueExp"> - * javax.management.BooleanValueExp</a>}. + * non-public class + * <a href="../../serialized-form.html#javax.management.BooleanValueExp"> + * javax.management.BooleanValueExp</a>. */ public static ValueExp value(boolean val) { return new BooleanValueExp(val); @@ -492,9 +491,9 @@ package javax.management; * * @return A ValueExp representing the sum or concatenation of * the two arguments. The returned object will be serialized as - * an instance of the non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryOpValueExp"> - * javax.management.BinaryOpValueExp</a>} with an {@code op} equal to + * an instance of the non-public class + * <a href="../../serialized-form.html#javax.management.BinaryOpValueExp"> + * javax.management.BinaryOpValueExp</a> with an {@code op} equal to * {@link #PLUS}. */ public static ValueExp plus(ValueExp value1, ValueExp value2) { @@ -510,9 +509,9 @@ package javax.management; * * @return A ValueExp representing the product. The returned * object will be serialized as an instance of the non-public - * class {@link <a - * href="../../serialized-form.html#javax.management.BinaryOpValueExp"> - * javax.management.BinaryOpValueExp</a>} with an {@code op} equal to + * class + * <a href="../../serialized-form.html#javax.management.BinaryOpValueExp"> + * javax.management.BinaryOpValueExp</a> with an {@code op} equal to * {@link #TIMES}. */ public static ValueExp times(ValueExp value1,ValueExp value2) { @@ -528,9 +527,9 @@ package javax.management; * * @return A ValueExp representing the difference between two * arguments. The returned object will be serialized as an - * instance of the non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryOpValueExp"> - * javax.management.BinaryOpValueExp</a>} with an {@code op} equal to + * instance of the non-public class + * <a href="../../serialized-form.html#javax.management.BinaryOpValueExp"> + * javax.management.BinaryOpValueExp</a> with an {@code op} equal to * {@link #MINUS}. */ public static ValueExp minus(ValueExp value1, ValueExp value2) { @@ -546,9 +545,9 @@ package javax.management; * * @return A ValueExp representing the quotient of two arguments. * The returned object will be serialized as an instance of the - * non-public class {@link <a - * href="../../serialized-form.html#javax.management.BinaryOpValueExp"> - * javax.management.BinaryOpValueExp</a>} with an {@code op} equal to + * non-public class + * <a href="../../serialized-form.html#javax.management.BinaryOpValueExp"> + * javax.management.BinaryOpValueExp</a> with an {@code op} equal to * {@link #DIV}. */ public static ValueExp div(ValueExp value1, ValueExp value2) { @@ -566,9 +565,9 @@ package javax.management; * * @return The constraint that a matches s. The returned object * will be serialized as an instance of the non-public class - * {@link <a - * href="../../serialized-form.html#javax.management.MatchQueryExp"> - * javax.management.MatchQueryExp</a>}. + * + * <a href="../../serialized-form.html#javax.management.MatchQueryExp"> + * javax.management.MatchQueryExp</a>. */ public static QueryExp initialSubString(AttributeValueExp a, StringValueExp s) { return new MatchQueryExp(a, @@ -585,9 +584,9 @@ package javax.management; * * @return The constraint that a matches s. The returned object * will be serialized as an instance of the non-public class - * {@link <a - * href="../../serialized-form.html#javax.management.MatchQueryExp"> - * javax.management.MatchQueryExp</a>}. + * + * <a href="../../serialized-form.html#javax.management.MatchQueryExp"> + * javax.management.MatchQueryExp</a>. */ public static QueryExp anySubString(AttributeValueExp a, StringValueExp s) { return new MatchQueryExp(a, @@ -605,9 +604,9 @@ package javax.management; * * @return The constraint that a matches s. The returned object * will be serialized as an instance of the non-public class - * {@link <a - * href="../../serialized-form.html#javax.management.MatchQueryExp"> - * javax.management.MatchQueryExp</a>}. + * + * <a href="../../serialized-form.html#javax.management.MatchQueryExp"> + * javax.management.MatchQueryExp</a>. */ public static QueryExp finalSubString(AttributeValueExp a, StringValueExp s) { return new MatchQueryExp(a, @@ -630,9 +629,9 @@ package javax.management; * of the class of which selected MBeans should be instances. * @return a query expression that represents an inheritance * constraint on an MBean class. The returned object will be - * serialized as an instance of the non-public class {@link <a - * href="../../serialized-form.html#javax.management.InstanceOfQueryExp"> - * javax.management.InstanceOfQueryExp</a>}. + * serialized as an instance of the non-public class + * <a href="../../serialized-form.html#javax.management.InstanceOfQueryExp"> + * javax.management.InstanceOfQueryExp</a>. * @since 1.6 */ public static QueryExp isInstanceOf(StringValueExp classNameValue) { diff --git a/jdk/src/share/classes/javax/management/loading/MLet.java b/jdk/src/share/classes/javax/management/loading/MLet.java index b1dc72aa64a..ab50507d6af 100644 --- a/jdk/src/share/classes/javax/management/loading/MLet.java +++ b/jdk/src/share/classes/javax/management/loading/MLet.java @@ -145,17 +145,17 @@ import javax.management.ServiceNotFoundException; * This optional attribute specifies a list of one or more parameters for the * MBean to be instantiated. This list describes the parameters to be passed the MBean's constructor. * Use the following syntax to specify each item in - * <VAR>arglist</VAR>:</DD> + * <VAR>arglist</VAR>: * <DL> - * <P> * <DT><<CODE>ARG TYPE=</CODE><VAR>argumentType</VAR> <CODE>VALUE=</CODE><VAR>value</VAR>></DT> - * <P> - * <DD>where:</DD> + * <DD>where: * <UL> * <LI><VAR>argumentType</VAR> is the type of the argument that will be passed as parameter to the MBean's constructor.</UL> + * </DD> * </DL> * <P>The arguments' type in the argument list should be a Java primitive type or a Java basic type * (<CODE>java.lang.Boolean, java.lang.Byte, java.lang.Short, java.lang.Long, java.lang.Integer, java.lang.Float, java.lang.Double, java.lang.String</CODE>). + * </DD> * </DL> * * When an m-let text file is loaded, an diff --git a/jdk/src/share/classes/javax/management/loading/MLetParser.java b/jdk/src/share/classes/javax/management/loading/MLetParser.java index 88fb37a3de4..bc3af8c9c25 100644 --- a/jdk/src/share/classes/javax/management/loading/MLetParser.java +++ b/jdk/src/share/classes/javax/management/loading/MLetParser.java @@ -149,7 +149,7 @@ class MLetParser { } /** - * Scan an html file for <mlet> tags + * Scan an html file for {@literal <mlet>} tags. */ public List<MLetContent> parse(URL url) throws IOException { String mth = "parse"; diff --git a/jdk/src/share/classes/javax/management/modelmbean/DescriptorSupport.java b/jdk/src/share/classes/javax/management/modelmbean/DescriptorSupport.java index 4ba4d4cdde2..1f7ad27e43d 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/DescriptorSupport.java +++ b/jdk/src/share/classes/javax/management/modelmbean/DescriptorSupport.java @@ -799,7 +799,7 @@ public class DescriptorSupport * the given object is also a Descriptor, and if the two Descriptors have * the same field names (possibly differing in case) and the same * associated values. The respective values for a field in the two - * Descriptors are equal if the following conditions hold:</p> + * Descriptors are equal if the following conditions hold: * * <ul> * <li>If one value is null then the other must be too.</li> @@ -871,7 +871,6 @@ public class DescriptorSupport * done on the <i>"export"</i> field. * <P> * Otherwise this implementation returns false if: - * <P> * <UL> * <LI> name and descriptorType fieldNames are not defined, or * null, or empty, or not String @@ -879,14 +878,14 @@ public class DescriptorSupport * are null or not String * <LI> persistPeriod, currencyTimeLimit, lastUpdatedTimeStamp, * lastReturnedTimeStamp if defined, are null, or not a Numeric - * String or not a Numeric Value >= -1 + * String or not a Numeric Value {@literal >= -1} * <LI> log fieldName, if defined, is null, or not a Boolean or * not a String with value "t", "f", "true", "false". These String * values must not be case sensitive. * <LI> visibility fieldName, if defined, is null, or not a - * Numeric String or a not Numeric Value >= 1 and <= 4 + * Numeric String or a not Numeric Value {@literal >= 1 and <= 4} * <LI> severity fieldName, if defined, is null, or not a Numeric - * String or not a Numeric Value >= 0 and <= 6<br> + * String or not a Numeric Value {@literal >= 0 and <= 6}<br> * <LI> persistPolicy fieldName, if defined, is null, or not one of * the following strings:<br> * "OnUpdate", "OnTimer", "NoMoreOftenThan", "OnUnregister", "Always", @@ -1270,8 +1269,8 @@ public class DescriptorSupport } /** - * Returns <pv>a human readable string representing the - * descriptor</pv>. The string will be in the format of + * Returns a human readable string representing the + * descriptor. The string will be in the format of * "fieldName=fieldValue,fieldName2=fieldValue2,..."<br> * * If there are no fields in the descriptor, then an empty String diff --git a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanAttributeInfo.java b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanAttributeInfo.java index 90d710a6c76..a4fd41245b5 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanAttributeInfo.java +++ b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanAttributeInfo.java @@ -57,7 +57,7 @@ import javax.management.RuntimeOperationsException; * Note that when the Type in this table is Number, a String that is the decimal * representation of a Long can also be used.</P> * - * <table border="1" cellpadding="5"> + * <table border="1" cellpadding="5" summary="ModelMBeanAttributeInfo Fields"> * <tr><th>Name</th><th>Type</th><th>Meaning</th></tr> * <tr><td>name</td><td>String</td> * <td>Attribute name.</td></tr> diff --git a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanConstructorInfo.java b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanConstructorInfo.java index 635553fc89c..1f308e53f11 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanConstructorInfo.java +++ b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanConstructorInfo.java @@ -58,7 +58,7 @@ import javax.management.RuntimeOperationsException; * Note that when the Type in this table is Number, a String that is the decimal * representation of a Long can also be used.</P> * - * <table border="1" cellpadding="5"> + * <table border="1" cellpadding="5" summary="ModelMBeanConstructorInfo Fields"> * <tr><th>Name</th><th>Type</th><th>Meaning</th></tr> * <tr><td>name</td><td>String</td> * <td>Constructor name.</td></tr> diff --git a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanInfo.java b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanInfo.java index 95ce0eb3721..5d9fb01edda 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanInfo.java +++ b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanInfo.java @@ -165,7 +165,7 @@ public interface ModelMBeanInfo * following. Note that when the Type in this table is Number, a String * that is the decimal representation of a Long can also be used.</P> * - * <table border="1" cellpadding="5"> + * <table border="1" cellpadding="5" summary="ModelMBean Fields"> * <tr><th>Name</th><th>Type</th><th>Meaning</th></tr> * <tr><td>name</td><td>String</td> * <td>MBean name.</td></tr> diff --git a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationBroadcaster.java b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationBroadcaster.java index 0dacebfddc7..0d1aa06b58c 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationBroadcaster.java +++ b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationBroadcaster.java @@ -127,7 +127,6 @@ public interface ModelMBeanNotificationBroadcaster extends NotificationBroadcast * <P> * @param oldValue The original value for the Attribute * @param newValue The current value for the Attribute - *<P> * <PRE> * The constructed attributeChangeNotification will be: * type "jmx.attribute.change" diff --git a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationInfo.java b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationInfo.java index 31d9199da18..538205a50ea 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationInfo.java +++ b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanNotificationInfo.java @@ -56,7 +56,7 @@ import javax.management.RuntimeOperationsException; * Note that when the Type in this table is Number, a String that is the decimal * representation of a Long can also be used.</P> * - * <table border="1" cellpadding="5"> + * <table border="1" cellpadding="5" summary="ModelMBeanNotificationInfo Fields"> * <tr><th>Name</th><th>Type</th><th>Meaning</th></tr> * <tr><td>name</td><td>String</td> * <td>Notification name.</td></tr> diff --git a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanOperationInfo.java b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanOperationInfo.java index 2d8e624ad84..08e5b24b4ea 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanOperationInfo.java +++ b/jdk/src/share/classes/javax/management/modelmbean/ModelMBeanOperationInfo.java @@ -59,7 +59,7 @@ import javax.management.RuntimeOperationsException; * Note that when the Type in this table is Number, a String that is the decimal * representation of a Long can also be used.</P> * - * <table border="1" cellpadding="5"> + * <table border="1" cellpadding="5" summary="ModelMBeanOperationInfo Fields"> * <tr><th>Name</th><th>Type</th><th>Meaning</th></tr> * <tr><td>name</td><td>String</td> * <td>Operation name.</td></tr> diff --git a/jdk/src/share/classes/javax/management/modelmbean/RequiredModelMBean.java b/jdk/src/share/classes/javax/management/modelmbean/RequiredModelMBean.java index 0afd70f9423..d19aa48fde6 100644 --- a/jdk/src/share/classes/javax/management/modelmbean/RequiredModelMBean.java +++ b/jdk/src/share/classes/javax/management/modelmbean/RequiredModelMBean.java @@ -360,7 +360,7 @@ public class RequiredModelMBean MODELMBEAN_LOGGER.logp(Level.FINER, RequiredModelMBean.class.getName(), "setManagedResource(Object,String)", - "Managed Resouce Type is not supported: " + mr_type); + "Managed Resource Type is not supported: " + mr_type); } throw new InvalidTargetObjectTypeException(mr_type); } @@ -369,7 +369,7 @@ public class RequiredModelMBean MODELMBEAN_LOGGER.logp(Level.FINER, RequiredModelMBean.class.getName(), "setManagedResource(Object,String)", - "Managed Resouce is valid"); + "Managed Resource is valid"); } managedResource = mr; @@ -421,19 +421,19 @@ public class RequiredModelMBean * is used to guide execution of this method. The MBean should be * stored if 'persistPolicy' field is:</p> * - * <PRE> != "never" + * <PRE>{@literal != "never" * = "always" * = "onTimer" and now > 'lastPersistTime' + 'persistPeriod' * = "NoMoreOftenThan" and now > 'lastPersistTime' + 'persistPeriod' * = "onUnregister" - * </PRE> + * }</PRE> * * <p>Do not store the MBean if 'persistPolicy' field is:</p> - * <PRE> + * <PRE>{@literal * = "never" * = "onUpdate" * = "onTimer" && now < 'lastPersistTime' + 'persistPeriod' - * </PRE> + * }</PRE> * * @exception MBeanException Wraps another exception, or * persistence is not supported @@ -469,11 +469,14 @@ public class RequiredModelMBean * <li><b>>0</b> Represents the number of seconds that the * 'value' field is valid. * The 'value' field is no longer valid when - * 'lastUpdatedTimeStamp' + 'currencyTimeLimit' > Now.</li> + * 'lastUpdatedTimeStamp' + 'currencyTimeLimit' > Now. + * <ul> + * <li>When 'value' is valid, 'valid' is returned.</li> + * <li>When 'value' is no longer valid then null is returned and + * 'value' and 'lastUpdatedTimeStamp' fields are cleared.</li> + * </ul> + * </li> * </ul> - * <li>When 'value' is valid, 'valid' is returned.</li> - * <li>When 'value' is no longer valid then null is returned and - * 'value' and 'lastUpdatedTimeStamp' fields are cleared.</li> * **/ private Object resolveForCacheValue(Descriptor descr) @@ -1842,17 +1845,17 @@ public class RequiredModelMBean * <Li> != "never"</Li> * <Li> = "always"</Li> * <Li> = "onUpdate"</Li> - * <Li> = "onTimer" and now > 'lastPersistTime' + 'persistPeriod'</Li> - * <Li> = "NoMoreOftenThan" and now > 'lastPersistTime' + - * 'persistPeriod'</Li> + * <Li> {@literal = "onTimer" and now > 'lastPersistTime' + 'persistPeriod'}</Li> + * <Li> {@literal = "NoMoreOftenThan" and now > 'lastPersistTime' + + * 'persistPeriod'}</Li> * </UL> * Do not store the MBean if 'persistPolicy' field is: * <UL> * <Li> = "never"</Li> - * <Li> = "onTimer" && now < 'lastPersistTime' + 'persistPeriod'</Li> + * <Li> = {@literal = "onTimer" && now < 'lastPersistTime' + 'persistPeriod'}</Li> * <Li> = "onUnregister"</Li> - * <Li> = "NoMoreOftenThan" and now < 'lastPersistTime' + - * 'persistPeriod'</Li> + * <Li> = {@literal = "NoMoreOftenThan" and now < 'lastPersistTime' + + * 'persistPeriod'}</Li> * </UL> * * <p>The ModelMBeanInfo of the Model MBean is stored in a file. diff --git a/jdk/src/share/classes/javax/management/monitor/Monitor.java b/jdk/src/share/classes/javax/management/monitor/Monitor.java index 2746f104463..f80b1f76b29 100644 --- a/jdk/src/share/classes/javax/management/monitor/Monitor.java +++ b/jdk/src/share/classes/javax/management/monitor/Monitor.java @@ -1609,7 +1609,7 @@ public abstract class Monitor * the thread instantiating this DaemonThreadFactory. Each new * thread is created as a daemon thread with priority * Thread.NORM_PRIORITY. New threads have names accessible via - * Thread.getName() of "JMX Monitor <pool-name> Pool [Thread-M]", + * Thread.getName() of "{@literal JMX Monitor <pool-name> Pool [Thread-M]}", * where M is the sequence number of the thread created by this * factory. */ diff --git a/jdk/src/share/classes/javax/management/openmbean/ArrayType.java b/jdk/src/share/classes/javax/management/openmbean/ArrayType.java index 55d173c2da9..afd2b6a24a9 100644 --- a/jdk/src/share/classes/javax/management/openmbean/ArrayType.java +++ b/jdk/src/share/classes/javax/management/openmbean/ArrayType.java @@ -33,7 +33,7 @@ import java.lang.reflect.Array; * all <i>open data</i> values which are n-dimensional arrays of <i>open data</i> values. * <p> * Examples of valid {@code ArrayType} instances are: - * <pre> + * <pre>{@code * // 2-dimension array of java.lang.String * ArrayType<String[][]> a1 = new ArrayType<String[][]>(2, SimpleType.STRING); * @@ -90,7 +90,7 @@ import java.lang.reflect.Array; * * // 3-dimension array of java.lang.String * ArrayType<String[][][]> a19 = new ArrayType<String[][][]>(1, a18); - * </pre> + * }</pre> * * * @since 1.5 @@ -241,23 +241,23 @@ public class ArrayType<T> extends OpenType<T> { * </ul> * <p> * As an example, the following piece of code: - * <pre> + * <pre>{@code * ArrayType<String[][][]> t = new ArrayType<String[][][]>(3, SimpleType.STRING); * System.out.println("array class name = " + t.getClassName()); * System.out.println("element class name = " + t.getElementOpenType().getClassName()); * System.out.println("array type name = " + t.getTypeName()); * System.out.println("array type description = " + t.getDescription()); - * </pre> + * }</pre> * would produce the following output: - * <pre> + * <pre>{@code * array class name = [[[Ljava.lang.String; * element class name = java.lang.String * array type name = [[[Ljava.lang.String; * array type description = 3-dimension array of java.lang.String - * </pre> + * }</pre> * And the following piece of code which is equivalent to the one listed * above would also produce the same output: - * <pre> + * <pre>{@code * ArrayType<String[]> t1 = new ArrayType<String[]>(1, SimpleType.STRING); * ArrayType<String[][]> t2 = new ArrayType<String[][]>(1, t1); * ArrayType<String[][][]> t3 = new ArrayType<String[][][]>(1, t2); @@ -265,7 +265,7 @@ public class ArrayType<T> extends OpenType<T> { * System.out.println("element class name = " + t3.getElementOpenType().getClassName()); * System.out.println("array type name = " + t3.getTypeName()); * System.out.println("array type description = " + t3.getDescription()); - * </pre> + * }</pre> * * @param dimension the dimension of arrays described by this <tt>ArrayType</tt> instance; * must be greater than or equal to 1. @@ -334,20 +334,20 @@ public class ArrayType<T> extends OpenType<T> { * </ul> * <p> * As an example, the following piece of code: - * <pre> + * <pre>{@code * ArrayType<int[]> t = new ArrayType<int[]>(SimpleType.INTEGER, true); * System.out.println("array class name = " + t.getClassName()); * System.out.println("element class name = " + t.getElementOpenType().getClassName()); * System.out.println("array type name = " + t.getTypeName()); * System.out.println("array type description = " + t.getDescription()); - * </pre> + * }</pre> * would produce the following output: - * <pre> + * <pre>{@code * array class name = [I * element class name = java.lang.Integer * array type name = [I * array type description = 1-dimension array of int - * </pre> + * }</pre> * * @param elementType the {@code SimpleType} of the element values * contained in the arrays described by this @@ -533,7 +533,7 @@ public class ArrayType<T> extends OpenType<T> { * <li>if this <code>ArrayType</code> instance describes an array of * classes implementing the {@code TabularData} interface or the * {@code CompositeData} interface, <var>obj</var> is assignable to - * such a declared array, and each element contained in <var>obj</var> + * such a declared array, and each element contained in {<var>obj</var> * is either null or a valid value for the element's open type specified * by this <code>ArrayType</code> instance.</li> * </ul> @@ -776,7 +776,7 @@ public class ArrayType<T> extends OpenType<T> { * object or two equal but not identical objects. * <p> * As an example, the following piece of code: - * <pre> + * <pre>{@code * ArrayType<String[]> t1 = ArrayType.getArrayType(SimpleType.STRING); * ArrayType<String[][]> t2 = ArrayType.getArrayType(t1); * ArrayType<String[][][]> t3 = ArrayType.getArrayType(t2); @@ -784,14 +784,14 @@ public class ArrayType<T> extends OpenType<T> { * System.out.println("element class name = " + t3.getElementOpenType().getClassName()); * System.out.println("array type name = " + t3.getTypeName()); * System.out.println("array type description = " + t3.getDescription()); - * </pre> + * }</pre> * would produce the following output: - * <pre> + * <pre>{@code * array class name = [[[Ljava.lang.String; * element class name = java.lang.String * array type name = [[[Ljava.lang.String; * array type description = 3-dimension array of java.lang.String - * </pre> + * }</pre> * * @param elementType the <i>open type</i> of element values contained * in the arrays described by this <tt>ArrayType</tt> @@ -819,20 +819,20 @@ public class ArrayType<T> extends OpenType<T> { * same object or two equal but not identical objects. * <p> * As an example, the following piece of code: - * <pre> + * <pre>{@code * ArrayType<int[][][]> t = ArrayType.getPrimitiveArrayType(int[][][].class); * System.out.println("array class name = " + t.getClassName()); * System.out.println("element class name = " + t.getElementOpenType().getClassName()); * System.out.println("array type name = " + t.getTypeName()); * System.out.println("array type description = " + t.getDescription()); - * </pre> + * }</pre> * would produce the following output: - * <pre> + * <pre>{@code * array class name = [[[I * element class name = java.lang.Integer * array type name = [[[I * array type description = 3-dimension array of int - * </pre> + * }</pre> * * @param arrayClass a primitive array class such as {@code int[].class}, * {@code boolean[][].class}, etc. The {@link diff --git a/jdk/src/share/classes/javax/management/openmbean/CompositeDataInvocationHandler.java b/jdk/src/share/classes/javax/management/openmbean/CompositeDataInvocationHandler.java index 6b420500552..2d9e23884ec 100644 --- a/jdk/src/share/classes/javax/management/openmbean/CompositeDataInvocationHandler.java +++ b/jdk/src/share/classes/javax/management/openmbean/CompositeDataInvocationHandler.java @@ -80,7 +80,7 @@ import java.lang.reflect.Proxy; </pre> </blockquote> - A call to {@code nn.getNumber()} will then return <b>5</b>.</p> + A call to {@code nn.getNumber()} will then return <b>5</b>. <p>If the first letter of the property defined by a getter is a capital, then this handler will look first for an item in the diff --git a/jdk/src/share/classes/javax/management/openmbean/CompositeType.java b/jdk/src/share/classes/javax/management/openmbean/CompositeType.java index 74e58fa39aa..93540af6109 100644 --- a/jdk/src/share/classes/javax/management/openmbean/CompositeType.java +++ b/jdk/src/share/classes/javax/management/openmbean/CompositeType.java @@ -40,7 +40,7 @@ import java.util.Iterator; /** * The <code>CompositeType</code> class is the <i>open type</i> class - * whose instances describe the types of {@link CompositeData <code>CompositeData</code>} values. + * whose instances describe the types of {@link CompositeData CompositeData} values. * * * @since 1.5 diff --git a/jdk/src/share/classes/javax/management/openmbean/OpenMBeanAttributeInfoSupport.java b/jdk/src/share/classes/javax/management/openmbean/OpenMBeanAttributeInfoSupport.java index 116ca6d9eca..550a50715c2 100644 --- a/jdk/src/share/classes/javax/management/openmbean/OpenMBeanAttributeInfoSupport.java +++ b/jdk/src/share/classes/javax/management/openmbean/OpenMBeanAttributeInfoSupport.java @@ -138,8 +138,8 @@ public class OpenMBeanAttributeInfoSupport * * <p>The {@code descriptor} can contain entries that will define * the values returned by certain methods of this class, as - * explained in the {@link <a href="package-summary.html#constraints"> - * package description</a>}. + * explained in the <a href="package-summary.html#constraints"> + * package description</a>. * * @param name cannot be a null or empty string. * @@ -162,8 +162,7 @@ public class OpenMBeanAttributeInfoSupport * @throws IllegalArgumentException if {@code name} or {@code * description} are null or empty string, or {@code openType} is * null, or the descriptor entries are invalid as described in the - * {@link <a href="package-summary.html#constraints">package - * description</a>}. + * <a href="package-summary.html#constraints">package description</a>. * * @since 1.6 */ diff --git a/jdk/src/share/classes/javax/management/openmbean/OpenMBeanParameterInfoSupport.java b/jdk/src/share/classes/javax/management/openmbean/OpenMBeanParameterInfoSupport.java index 4ef8f75b56b..56ad0cf3ae6 100644 --- a/jdk/src/share/classes/javax/management/openmbean/OpenMBeanParameterInfoSupport.java +++ b/jdk/src/share/classes/javax/management/openmbean/OpenMBeanParameterInfoSupport.java @@ -111,16 +111,16 @@ public class OpenMBeanParameterInfoSupport } /** - * <p>Constructs an {@code OpenMBeanParameterInfoSupport} instance, + * Constructs an {@code OpenMBeanParameterInfoSupport} instance, * which describes the parameter used in one or more operations or * constructors of a class of open MBeans, with the specified * {@code name}, {@code openType}, {@code description}, - * and {@code descriptor}.</p> + * and {@code descriptor}. * * <p>The {@code descriptor} can contain entries that will define * the values returned by certain methods of this class, as - * explained in the {@link <a href="package-summary.html#constraints"> - * package description</a>}. + * explained in the <a href="package-summary.html#constraints"> + * package description</a>. * * @param name cannot be a null or empty string. * @@ -134,8 +134,8 @@ public class OpenMBeanParameterInfoSupport * @throws IllegalArgumentException if {@code name} or {@code * description} are null or empty string, or {@code openType} is * null, or the descriptor entries are invalid as described in the - * {@link <a href="package-summary.html#constraints">package - * description</a>}. + * <a href="package-summary.html#constraints">package + * description</a>. * * @since 1.6 */ diff --git a/jdk/src/share/classes/javax/management/openmbean/SimpleType.java b/jdk/src/share/classes/javax/management/openmbean/SimpleType.java index 8672426c5a9..ea26ae56267 100644 --- a/jdk/src/share/classes/javax/management/openmbean/SimpleType.java +++ b/jdk/src/share/classes/javax/management/openmbean/SimpleType.java @@ -45,8 +45,8 @@ import javax.management.ObjectName; /** * The <code>SimpleType</code> class is the <i>open type</i> class whose instances describe * all <i>open data</i> values which are neither arrays, - * nor {@link CompositeData <code>CompositeData</code>} values, - * nor {@link TabularData <code>TabularData</code>} values. + * nor {@link CompositeData CompositeData} values, + * nor {@link TabularData TabularData} values. * It predefines all its possible instances as static fields, and has no public constructor. * <p> * Given a <code>SimpleType</code> instance describing values whose Java class name is <i>className</i>, diff --git a/jdk/src/share/classes/javax/management/openmbean/TabularType.java b/jdk/src/share/classes/javax/management/openmbean/TabularType.java index a1bcc71295d..9eca49196bc 100644 --- a/jdk/src/share/classes/javax/management/openmbean/TabularType.java +++ b/jdk/src/share/classes/javax/management/openmbean/TabularType.java @@ -40,7 +40,7 @@ import java.util.List; /** * The <code>TabularType</code> class is the <i> open type</i> class - * whose instances describe the types of {@link TabularData <code>TabularData</code>} values. + * whose instances describe the types of {@link TabularData TabularData} values. * * @since 1.5 */ @@ -89,8 +89,8 @@ public class TabularType extends OpenType<TabularData> { * cannot be null or empty. Each element should be an item name defined in <var>rowType</var> * (no null or empty string allowed). * It is important to note that the <b>order</b> of the item names in <var>indexNames</var> - * is used by the methods {@link TabularData#get(java.lang.Object[]) <code>get</code>} and - * {@link TabularData#remove(java.lang.Object[]) <code>remove</code>} of class + * is used by the methods {@link TabularData#get(java.lang.Object[]) get} and + * {@link TabularData#remove(java.lang.Object[]) remove} of class * <code>TabularData</code> to match their array of values parameter to items. * <br>  * @throws IllegalArgumentException if <var>rowType</var> is null, diff --git a/jdk/src/share/classes/javax/management/relation/Relation.java b/jdk/src/share/classes/javax/management/relation/Relation.java index 7a77f7bccb0..3ef3ce777b6 100644 --- a/jdk/src/share/classes/javax/management/relation/Relation.java +++ b/jdk/src/share/classes/javax/management/relation/Relation.java @@ -236,7 +236,7 @@ public interface Relation { * Retrieves MBeans referenced in the various roles of the relation. * * @return a HashMap mapping: - * <P> ObjectName -> ArrayList of String (role names) + * <P> ObjectName {@literal ->} ArrayList of String (role names) */ public Map<ObjectName,List<String>> getReferencedMBeans(); diff --git a/jdk/src/share/classes/javax/management/relation/RelationService.java b/jdk/src/share/classes/javax/management/relation/RelationService.java index 6ea329a6d13..2585d11d0be 100644 --- a/jdk/src/share/classes/javax/management/relation/RelationService.java +++ b/jdk/src/share/classes/javax/management/relation/RelationService.java @@ -2306,8 +2306,7 @@ public class RelationService extends NotificationBroadcasterSupport * @param relationId relation id * * @return a HashMap mapping: - * <P> ObjectName -> ArrayList of String (role - * names) + * <P> ObjectName {@literal ->} ArrayList of String (role names) * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException if no relation for given diff --git a/jdk/src/share/classes/javax/management/relation/RelationServiceMBean.java b/jdk/src/share/classes/javax/management/relation/RelationServiceMBean.java index 48dde4be3f4..a8753042d3e 100644 --- a/jdk/src/share/classes/javax/management/relation/RelationServiceMBean.java +++ b/jdk/src/share/classes/javax/management/relation/RelationServiceMBean.java @@ -770,7 +770,7 @@ public interface RelationServiceMBean { * @param relationId relation id * * @return a HashMap mapping: - * <P> ObjectName -> ArrayList of String (role + * <P> ObjectName {@literal ->} ArrayList of String (role * names) * * @exception IllegalArgumentException if null parameter diff --git a/jdk/src/share/classes/javax/management/relation/RelationSupport.java b/jdk/src/share/classes/javax/management/relation/RelationSupport.java index c5ebd4e8272..be18fd2312c 100644 --- a/jdk/src/share/classes/javax/management/relation/RelationSupport.java +++ b/jdk/src/share/classes/javax/management/relation/RelationSupport.java @@ -590,7 +590,7 @@ public class RelationSupport * Retrieves MBeans referenced in the various roles of the relation. * * @return a HashMap mapping: - * <P> ObjectName -> ArrayList of String (role names) + * <P> ObjectName {@literal ->} ArrayList of String (role names) */ public Map<ObjectName,List<String>> getReferencedMBeans() { diff --git a/jdk/src/share/classes/javax/management/remote/JMXConnectionNotification.java b/jdk/src/share/classes/javax/management/remote/JMXConnectionNotification.java index fa0fb0e6809..401d592ddbb 100644 --- a/jdk/src/share/classes/javax/management/remote/JMXConnectionNotification.java +++ b/jdk/src/share/classes/javax/management/remote/JMXConnectionNotification.java @@ -40,7 +40,7 @@ import javax.management.ObjectName; * * <p>The notification type is one of the following:</p> * - * <table> + * <table summary="JMXConnectionNotification Types"> * * <tr> * <th align=left>Type</th> diff --git a/jdk/src/share/classes/javax/management/remote/JMXConnector.java b/jdk/src/share/classes/javax/management/remote/JMXConnector.java index c036640bec3..81502d8a29a 100644 --- a/jdk/src/share/classes/javax/management/remote/JMXConnector.java +++ b/jdk/src/share/classes/javax/management/remote/JMXConnector.java @@ -76,7 +76,7 @@ public interface JMXConnector extends Closeable { * <p>If <code>connect</code> has already been called successfully * on this object, calling it again has no effect. If, however, * {@link #close} was called after <code>connect</code>, the new - * <code>connect</code> will throw an <code>IOException</code>.<p> + * <code>connect</code> will throw an <code>IOException</code>. * * <p>Otherwise, either <code>connect</code> has never been called * on this object, or it has been called but produced an diff --git a/jdk/src/share/classes/javax/management/remote/JMXConnectorProvider.java b/jdk/src/share/classes/javax/management/remote/JMXConnectorProvider.java index 18d74c27186..4d982aa671c 100644 --- a/jdk/src/share/classes/javax/management/remote/JMXConnectorProvider.java +++ b/jdk/src/share/classes/javax/management/remote/JMXConnectorProvider.java @@ -50,7 +50,7 @@ public interface JMXConnectorProvider { * @param environment a read-only Map containing named attributes * to determine how the connection is made. Keys in this map must * be Strings. The appropriate type of each associated value - * depends on the attribute.</p> + * depends on the attribute. * * @return a <code>JMXConnector</code> representing the new * connector client. Each successful call to this method produces diff --git a/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectionImpl.java b/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectionImpl.java index 294308d64a3..4d0a3d428e3 100644 --- a/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectionImpl.java +++ b/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectionImpl.java @@ -1613,7 +1613,7 @@ public class RMIConnectionImpl implements RMIConnection, Unreferenced { /** * Construct a new IOException with a nested exception. - * The nested exception is set only if JDK >= 1.4 + * The nested exception is set only if JDK {@literal >= 1.4} */ private static IOException newIOException(String message, Throwable cause) { diff --git a/jdk/src/share/classes/javax/management/remote/rmi/RMIConnector.java b/jdk/src/share/classes/javax/management/remote/rmi/RMIConnector.java index a3365662bf1..9d71ed9e63b 100644 --- a/jdk/src/share/classes/javax/management/remote/rmi/RMIConnector.java +++ b/jdk/src/share/classes/javax/management/remote/rmi/RMIConnector.java @@ -1688,17 +1688,17 @@ public class RMIConnector implements JMXConnector, Serializable, JMXAddressable * this method will attempt to connect the stub to an ORB as * follows: * <ul> - * <p>This method looks in the provided <var>environment</var> for + * <li>This method looks in the provided <var>environment</var> for * the "java.naming.corba.orb" property. If it is found, the * referenced object (an {@link org.omg.CORBA.ORB ORB}) is used to * connect the stub. Otherwise, a new org.omg.CORBA.ORB is created * by calling {@link * org.omg.CORBA.ORB#init(String[], Properties) - * org.omg.CORBA.ORB.init((String[])null,(Properties)null)} - * <p>The new created ORB is kept in a static + * org.omg.CORBA.ORB.init((String[])null,(Properties)null)}</li> + * <li>The new created ORB is kept in a static * {@link WeakReference} and can be reused for connecting other * stubs. However, no reference is ever kept on the ORB provided - * in the <var>environment</var> map, if any. + * in the <var>environment</var> map, if any.</li> * </ul> * @param rmiServer A RMI Server Stub. * @param environment An environment map, possibly containing an ORB. diff --git a/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectorServer.java b/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectorServer.java index faa949cca38..9db8bd9b467 100644 --- a/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectorServer.java +++ b/jdk/src/share/classes/javax/management/remote/rmi/RMIConnectorServer.java @@ -820,7 +820,7 @@ public class RMIConnectorServer extends JMXConnectorServer { /** * Construct a new IOException with a nested exception. - * The nested exception is set only if JDK >= 1.4 + * The nested exception is set only if JDK {@literal >= 1.4} */ private static IOException newIOException(String message, Throwable cause) { diff --git a/jdk/src/share/classes/javax/management/remote/rmi/RMIServerImpl.java b/jdk/src/share/classes/javax/management/remote/rmi/RMIServerImpl.java index 2226f6c8162..e3e10d4ea2f 100644 --- a/jdk/src/share/classes/javax/management/remote/rmi/RMIServerImpl.java +++ b/jdk/src/share/classes/javax/management/remote/rmi/RMIServerImpl.java @@ -117,7 +117,7 @@ public abstract class RMIServerImpl implements Closeable, RMIServer { * server.</p> * * @return the default <code>ClassLoader</code> used by this - * connector server.</p> + * connector server. * * @see #setDefaultClassLoader */ diff --git a/jdk/src/share/classes/javax/swing/AbstractButton.java b/jdk/src/share/classes/javax/swing/AbstractButton.java index 5157b16ee71..6f75be948e9 100644 --- a/jdk/src/share/classes/javax/swing/AbstractButton.java +++ b/jdk/src/share/classes/javax/swing/AbstractButton.java @@ -1381,7 +1381,7 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl * If <code>true</code> and the button has a border, * the border is painted. The default value for the * <code>borderPainted</code> property is <code>true</code>. - * <p/> + * <p> * Some look and feels might not support * the <code>borderPainted</code> property, * in which case they ignore this. @@ -1476,7 +1476,7 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl * This function may cause the component's opaque property to change. * <p> * The exact behavior of calling this function varies on a - * component-by-component and L&F-by-L&F basis. + * component-by-component and L&F-by-L&F basis. * * @param b if true, the content should be filled; if false * the content area is not filled @@ -1702,7 +1702,7 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl * @see #getMultiClickThreshhold * @param threshhold the amount of time required between mouse * press events to generate corresponding action events - * @exception IllegalArgumentException if threshhold < 0 + * @exception IllegalArgumentException if threshhold < 0 * @since 1.4 */ public void setMultiClickThreshhold(long threshhold) { @@ -1787,7 +1787,7 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl /** - * Returns the L&F object that renders this component. + * Returns the L&F object that renders this component. * @return the ButtonUI object * @see #setUI */ @@ -1797,8 +1797,8 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl /** - * Sets the L&F object that renders this component. - * @param ui the <code>ButtonUI</code> L&F object + * Sets the L&F object that renders this component. + * @param ui the <code>ButtonUI</code> L&F object * @see #getUI * @beaninfo * bound: true @@ -2722,7 +2722,7 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, * null for an invalid index or part * @since 1.3 @@ -2769,7 +2769,7 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, null for an invalid * index or part * @since 1.3 @@ -2833,7 +2833,7 @@ public abstract class AbstractButton extends JComponent implements ItemSelectabl * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, null for an invalid index * or part * @since 1.3 diff --git a/jdk/src/share/classes/javax/swing/Action.java b/jdk/src/share/classes/javax/swing/Action.java index 307f40a74db..7223d819681 100644 --- a/jdk/src/share/classes/javax/swing/Action.java +++ b/jdk/src/share/classes/javax/swing/Action.java @@ -69,7 +69,7 @@ import java.beans.*; * are desired, and use simple <code>ActionListener</code>s elsewhere. * <p> * - * <h4><a name="buttonActions"></a>Swing Components Supporting <code>Action</code></h4> + * <h3><a name="buttonActions"></a>Swing Components Supporting <code>Action</code></h3> * <p> * Many of Swing's components have an <code>Action</code> property. When * an <code>Action</code> is set on a component, the following things @@ -95,8 +95,7 @@ import java.beans.*; * button's corresponding property being set to <code>null</code>. * <p> * <table border="1" cellpadding="1" cellspacing="0" - * summary="Supported Action properties" - * valign="top" > + * summary="Supported Action properties"> * <tr valign="top" align="left"> * <th style="background-color:#CCCCFF" align="left">Component Property * <th style="background-color:#CCCCFF" align="left">Components diff --git a/jdk/src/share/classes/javax/swing/Box.java b/jdk/src/share/classes/javax/swing/Box.java index 2f4c6e4c76f..1a3ace74129 100644 --- a/jdk/src/share/classes/javax/swing/Box.java +++ b/jdk/src/share/classes/javax/swing/Box.java @@ -155,7 +155,7 @@ public class Box extends JComponent implements Accessible { * in which case it takes its share of available space, * just like any other component that has no maximum height. * - * @param width the width of the invisible component, in pixels >= 0 + * @param width the width of the invisible component, in pixels >= 0 * @return the component * @see #createVerticalStrut * @see #createGlue @@ -179,7 +179,7 @@ public class Box extends JComponent implements Accessible { * in which case it takes its share of available space, * just like any other component that has no maximum width. * - * @param height the height of the invisible component, in pixels >= 0 + * @param height the height of the invisible component, in pixels >= 0 * @return the component * @see #createHorizontalStrut * @see #createGlue diff --git a/jdk/src/share/classes/javax/swing/BoxLayout.java b/jdk/src/share/classes/javax/swing/BoxLayout.java index f510553063e..09968fb0b35 100644 --- a/jdk/src/share/classes/javax/swing/BoxLayout.java +++ b/jdk/src/share/classes/javax/swing/BoxLayout.java @@ -287,7 +287,7 @@ public class BoxLayout implements LayoutManager2, Serializable { * in the specified target container. * * @param target the container that needs to be laid out - * @return the dimensions >= 0 && <= Integer.MAX_VALUE + * @return the dimensions >= 0 && <= Integer.MAX_VALUE * @exception AWTError if the target isn't the container specified to the * BoxLayout constructor * @see Container @@ -313,7 +313,7 @@ public class BoxLayout implements LayoutManager2, Serializable { * contained in the specified target container. * * @param target the container that needs to be laid out - * @return the dimensions >= 0 && <= Integer.MAX_VALUE + * @return the dimensions >= 0 && <= Integer.MAX_VALUE * @exception AWTError if the target isn't the container specified to the * BoxLayout constructor * @see #preferredLayoutSize @@ -338,7 +338,7 @@ public class BoxLayout implements LayoutManager2, Serializable { * to lay out the components it contains. * * @param target the container that needs to be laid out - * @return the dimensions >= 0 && <= Integer.MAX_VALUE + * @return the dimensions >= 0 && <= Integer.MAX_VALUE * @exception AWTError if the target isn't the container specified to the * BoxLayout constructor * @see #preferredLayoutSize @@ -365,7 +365,7 @@ public class BoxLayout implements LayoutManager2, Serializable { * to place the children along the X axis will be returned. * * @param target the container - * @return the alignment >= 0.0f && <= 1.0f + * @return the alignment >= 0.0f && <= 1.0f * @exception AWTError if the target isn't the container specified to the * BoxLayout constructor */ @@ -382,7 +382,7 @@ public class BoxLayout implements LayoutManager2, Serializable { * to place the children along the Y axis will be returned. * * @param target the container - * @return the alignment >= 0.0f && <= 1.0f + * @return the alignment >= 0.0f && <= 1.0f * @exception AWTError if the target isn't the container specified to the * BoxLayout constructor */ diff --git a/jdk/src/share/classes/javax/swing/CellRendererPane.java b/jdk/src/share/classes/javax/swing/CellRendererPane.java index 6a9f17b058a..3e43b80d9ea 100644 --- a/jdk/src/share/classes/javax/swing/CellRendererPane.java +++ b/jdk/src/share/classes/javax/swing/CellRendererPane.java @@ -96,7 +96,7 @@ public class CellRendererPane extends Container implements Accessible /** * If the specified component is already a child of this then we don't * bother doing anything - stacking order doesn't matter for cell - * renderer components (CellRendererPane doesn't paint anyway).< + * renderer components (CellRendererPane doesn't paint anyway). */ protected void addImpl(Component x, Object constraints, int index) { if (x.getParent() == this) { diff --git a/jdk/src/share/classes/javax/swing/DefaultListSelectionModel.java b/jdk/src/share/classes/javax/swing/DefaultListSelectionModel.java index 26f06c63a2c..388a5a59a81 100644 --- a/jdk/src/share/classes/javax/swing/DefaultListSelectionModel.java +++ b/jdk/src/share/classes/javax/swing/DefaultListSelectionModel.java @@ -637,7 +637,7 @@ public class DefaultListSelectionModel implements ListSelectionModel, Cloneable, * Remove the indices in the interval index0,index1 (inclusive) from * the selection model. This is typically called to sync the selection * model width a corresponding change in the data model. Note - * that (as always) index0 need not be <= index1. + * that (as always) index0 need not be <= index1. */ public void removeIndexInterval(int index0, int index1) { diff --git a/jdk/src/share/classes/javax/swing/DesktopManager.java b/jdk/src/share/classes/javax/swing/DesktopManager.java index 2f141e49350..e0a2a434a45 100644 --- a/jdk/src/share/classes/javax/swing/DesktopManager.java +++ b/jdk/src/share/classes/javax/swing/DesktopManager.java @@ -26,13 +26,13 @@ package javax.swing; /** DesktopManager objects are owned by a JDesktopPane object. They are responsible - * for implementing L&F specific behaviors for the JDesktopPane. JInternalFrame + * for implementing L&F specific behaviors for the JDesktopPane. JInternalFrame * implementations should delegate specific behaviors to the DesktopManager. For * instance, if a JInternalFrame was asked to iconify, it should try: * <PRE> * getDesktopPane().getDesktopManager().iconifyFrame(frame); * </PRE> - * This delegation allows each L&F to provide custom behaviors for desktop-specific + * This delegation allows each L&F to provide custom behaviors for desktop-specific * actions. (For example, how and where the internal frame's icon would appear.) * <p>This class provides a policy for the various JInternalFrame methods, it is not * meant to be called directly rather the various JInternalFrame methods will call diff --git a/jdk/src/share/classes/javax/swing/GroupLayout.java b/jdk/src/share/classes/javax/swing/GroupLayout.java index 9b0d4df485b..e3be1ddfdd5 100644 --- a/jdk/src/share/classes/javax/swing/GroupLayout.java +++ b/jdk/src/share/classes/javax/swing/GroupLayout.java @@ -80,7 +80,7 @@ import static javax.swing.SwingConstants.VERTICAL; * axis. The sequential group contains three components. A parallel group * was used along the vertical axis. * <p style="text-align:center"> - * <img src="doc-files/groupLayout.1.gif"> + * <img src="doc-files/groupLayout.1.gif" alt="Sequential group along the horizontal axis in three components"> * <p> * To reinforce that each axis is treated independently the diagram shows * the range of each group and element along each axis. The @@ -102,7 +102,7 @@ import static javax.swing.SwingConstants.VERTICAL; * the vertical axis. * <p> * <p style="text-align:center"> - * <img src="doc-files/groupLayout.2.gif"> + * <img src="doc-files/groupLayout.2.gif" alt="Sequential group along the vertical axis in three components"> * <p> * As {@code c1} is the largest of the three components, the parallel * group is sized to {@code c1}. As {@code c2} and {@code c3} are smaller @@ -116,7 +116,7 @@ import static javax.swing.SwingConstants.VERTICAL; * The following diagram shows a sequential group along both the horizontal * and vertical axis. * <p style="text-align:center"> - * <img src="doc-files/groupLayout.3.gif"> + * <img src="doc-files/groupLayout.3.gif" alt="Sequential group along both the horizontal and vertical axis in three components"> * <p> * {@code GroupLayout} provides the ability to insert gaps between * {@code Component}s. The size of the gap is determined by an @@ -173,7 +173,7 @@ import static javax.swing.SwingConstants.VERTICAL; * <p> * When run the following is produced. * <p style="text-align:center"> - * <img src="doc-files/groupLayout.example.png"> + * <img src="doc-files/groupLayout.example.png" alt="Produced horizontal/vertical form"> * <p> * This layout consists of the following. * <ul><li>The horizontal axis consists of a sequential group containing two diff --git a/jdk/src/share/classes/javax/swing/JComponent.java b/jdk/src/share/classes/javax/swing/JComponent.java index 598916da412..3f4d3f25606 100644 --- a/jdk/src/share/classes/javax/swing/JComponent.java +++ b/jdk/src/share/classes/javax/swing/JComponent.java @@ -4906,12 +4906,12 @@ public abstract class JComponent extends Container implements Serializable, /** * Returns {@code true} if a paint triggered on a child component should cause * painting to originate from this Component, or one of its ancestors. - * <p/> + * <p> * Calling {@link #repaint} or {@link #paintImmediately(int, int, int, int)} * on a Swing component will result in calling * the {@link JComponent#paintImmediately(int, int, int, int)} method of * the first ancestor which {@code isPaintingOrigin()} returns {@code true}, if there are any. - * <p/> + * <p> * {@code JComponent} subclasses that need to be painted when any of their * children are repainted should override this method to return {@code true}. * diff --git a/jdk/src/share/classes/javax/swing/JEditorPane.java b/jdk/src/share/classes/javax/swing/JEditorPane.java index f4c5893068c..a104d1c0858 100644 --- a/jdk/src/share/classes/javax/swing/JEditorPane.java +++ b/jdk/src/share/classes/javax/swing/JEditorPane.java @@ -103,7 +103,7 @@ import javax.accessibility.*; * fragment is a possible hyperlink listener implementation, that treats * HTML frame events specially, and simply displays any other activated * hyperlinks. - * <code><pre> + * <pre>   class Hyperactive implements HyperlinkListener {   @@ -125,7 +125,7 @@ import javax.accessibility.*;   }   } - * </pre></code> + * </pre> * <p> * For information on customizing how <b>text/html</b> is rendered please see * {@link #W3C_LENGTH_UNITS} and {@link #HONOR_DISPLAY_PROPERTIES} diff --git a/jdk/src/share/classes/javax/swing/JFileChooser.java b/jdk/src/share/classes/javax/swing/JFileChooser.java index 218f6ae7310..012c6753300 100644 --- a/jdk/src/share/classes/javax/swing/JFileChooser.java +++ b/jdk/src/share/classes/javax/swing/JFileChooser.java @@ -67,7 +67,7 @@ import java.lang.ref.WeakReference; * <pre> * JFileChooser chooser = new JFileChooser(); * FileNameExtensionFilter filter = new FileNameExtensionFilter( - * "JPG & GIF Images", "jpg", "gif"); + * "JPG & GIF Images", "jpg", "gif"); * chooser.setFileFilter(filter); * int returnVal = chooser.showOpenDialog(parent); * if(returnVal == JFileChooser.APPROVE_OPTION) { @@ -634,7 +634,7 @@ public class JFileChooser extends JComponent implements Accessible { /** * Pops up an "Open File" file chooser dialog. Note that the * text that appears in the approve button is determined by - * the L&F. + * the L&F. * * @param parent the parent component of the dialog, * can be <code>null</code>; @@ -659,7 +659,7 @@ public class JFileChooser extends JComponent implements Accessible { /** * Pops up a "Save File" file chooser dialog. Note that the * text that appears in the approve button is determined by - * the L&F. + * the L&F. * * @param parent the parent component of the dialog, * can be <code>null</code>; @@ -861,7 +861,7 @@ public class JFileChooser extends JComponent implements Accessible { * @beaninfo * preferred: true * bound: true - * description: Sets whether the approve & cancel buttons are shown. + * description: Sets whether the approve & cancel buttons are shown. * * @see #getControlButtonsAreShown * @see #CONTROL_BUTTONS_ARE_SHOWN_CHANGED_PROPERTY @@ -1841,7 +1841,7 @@ public class JFileChooser extends JComponent implements Accessible { } /** - * Returns a string that specifies the name of the L&F class + * Returns a string that specifies the name of the L&F class * that renders this component. * * @return the string "FileChooserUI" @@ -1849,16 +1849,16 @@ public class JFileChooser extends JComponent implements Accessible { * @see UIDefaults#getUI * @beaninfo * expert: true - * description: A string that specifies the name of the L&F class. + * description: A string that specifies the name of the L&F class. */ public String getUIClassID() { return uiClassID; } /** - * Gets the UI object which implements the L&F for this component. + * Gets the UI object which implements the L&F for this component. * - * @return the FileChooserUI object that implements the FileChooserUI L&F + * @return the FileChooserUI object that implements the FileChooserUI L&F */ public FileChooserUI getUI() { return (FileChooserUI) ui; diff --git a/jdk/src/share/classes/javax/swing/JLabel.java b/jdk/src/share/classes/javax/swing/JLabel.java index be900a4697d..c6e28d92eaa 100644 --- a/jdk/src/share/classes/javax/swing/JLabel.java +++ b/jdk/src/share/classes/javax/swing/JLabel.java @@ -237,7 +237,7 @@ public class JLabel extends JComponent implements SwingConstants, Accessible /** - * Returns the L&F object that renders this component. + * Returns the L&F object that renders this component. * * @return LabelUI object */ @@ -247,9 +247,9 @@ public class JLabel extends JComponent implements SwingConstants, Accessible /** - * Sets the L&F object that renders this component. + * Sets the L&F object that renders this component. * - * @param ui the LabelUI L&F object + * @param ui the LabelUI L&F object * @see UIDefaults#getUI * @beaninfo * bound: true @@ -277,7 +277,7 @@ public class JLabel extends JComponent implements SwingConstants, Accessible /** - * Returns a string that specifies the name of the l&f class + * Returns a string that specifies the name of the l&f class * that renders this component. * * @return String "LabelUI" @@ -545,8 +545,8 @@ public class JLabel extends JComponent implements SwingConstants, Accessible * * @since 1.4 * @param index Index into the String to underline - * @exception IllegalArgumentException will be thrown if <code>index</code - * is >= length of the text, or < -1 + * @exception IllegalArgumentException will be thrown if <code>index</code> + * is >= length of the text, or < -1 * * @beaninfo * bound: true @@ -1251,7 +1251,7 @@ public class JLabel extends JComponent implements SwingConstants, Accessible * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, * null for an invalid index or part * @since 1.3 @@ -1298,7 +1298,7 @@ public class JLabel extends JComponent implements SwingConstants, Accessible * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, null for an invalid * index or part * @since 1.3 @@ -1362,7 +1362,7 @@ public class JLabel extends JComponent implements SwingConstants, Accessible * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, null for an invalid index * or part * @since 1.3 diff --git a/jdk/src/share/classes/javax/swing/JList.java b/jdk/src/share/classes/javax/swing/JList.java index 9b016251a7e..e62bc80135b 100644 --- a/jdk/src/share/classes/javax/swing/JList.java +++ b/jdk/src/share/classes/javax/swing/JList.java @@ -146,7 +146,7 @@ import static sun.swing.SwingUtilities2.Section.*; * Responsibility for listening to selection changes in order to keep the list's * visual representation up to date lies with the list's {@code ListUI}. * <p> - * <a name="renderer"> + * <a name="renderer"></a> * Painting of cells in a {@code JList} is handled by a delegate called a * cell renderer, installed on the list as the {@code cellRenderer} property. * The renderer provides a {@code java.awt.Component} that is used @@ -202,7 +202,7 @@ import static sun.swing.SwingUtilities2.Section.*; * To avoid these calculations, you can set a {@code fixedCellWidth} and * {@code fixedCellHeight} on the list, or have these values calculated * automatically based on a single prototype value: - * <a name="prototype_example"> + * <a name="prototype_example"></a> * <pre> * {@code * JList<String> bigDataList = new JList<String>(bigData); @@ -1512,7 +1512,7 @@ public class JList<E> extends JComponent implements Scrollable, Accessible * tooltip text on the cell level, by using {@code setToolTipText} on your * cell renderer component. * <p> - * <bold>Note:</bold> For <code>JList</code> to properly display the + * <strong>Note:</strong> For <code>JList</code> to properly display the * tooltips of its renderers in this manner, <code>JList</code> must be a * registered component with the <code>ToolTipManager</code>. This registration * is done automatically in the constructor. However, if at a later point diff --git a/jdk/src/share/classes/javax/swing/JMenu.java b/jdk/src/share/classes/javax/swing/JMenu.java index 60aa661ff70..7493ede1ab8 100644 --- a/jdk/src/share/classes/javax/swing/JMenu.java +++ b/jdk/src/share/classes/javax/swing/JMenu.java @@ -225,7 +225,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement /** - * Returns the name of the L&F class that renders this component. + * Returns the name of the L&F class that renders this component. * * @return the string "MenuUI" * @see JComponent#getUIClassID @@ -490,7 +490,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement /** * Returns the suggested delay, in milliseconds, before submenus * are popped up or down. - * Each look and feel (L&F) may determine its own policy for + * Each look and feel (L&F) may determine its own policy for * observing the <code>delay</code> property. * In most cases, the delay is not observed for top level menus * or while dragging. The default for <code>delay</code> is 0. @@ -506,7 +506,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement /** * Sets the suggested delay before the menu's <code>PopupMenu</code> - * is popped up or down. Each look and feel (L&F) may determine + * is popped up or down. Each look and feel (L&F) may determine * it's own policy for observing the delay property. In most cases, * the delay is not observed for top level menus or while dragging. * This method is a property of the look and feel code and is used @@ -676,7 +676,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement * @param pos an integer specifying the position at which to add the * new menu item * @exception IllegalArgumentException when the value of - * <code>pos</code> < 0 + * <code>pos</code> < 0 */ public void insert(String s, int pos) { if (pos < 0) { @@ -695,7 +695,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement * new <code>JMenuitem</code> * @return the new menu item * @exception IllegalArgumentException if the value of - * <code>pos</code> < 0 + * <code>pos</code> < 0 */ public JMenuItem insert(JMenuItem mi, int pos) { if (pos < 0) { @@ -714,7 +714,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement * @param pos an integer specifying the position at which to add the * new menu item * @exception IllegalArgumentException if the value of - * <code>pos</code> < 0 + * <code>pos</code> < 0 */ public JMenuItem insert(Action a, int pos) { if (pos < 0) { @@ -735,7 +735,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement * @param index an integer specifying the position at which to * insert the menu separator * @exception IllegalArgumentException if the value of - * <code>index</code> < 0 + * <code>index</code> < 0 */ public void insertSeparator(int index) { if (index < 0) { @@ -754,7 +754,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement * * @param pos an integer specifying the position * @exception IllegalArgumentException if the value of - * <code>pos</code> < 0 + * <code>pos</code> < 0 * @return the menu item at the specified position; or <code>null</code> * if the item as the specified position is not a menu item */ @@ -811,7 +811,7 @@ public class JMenu extends JMenuItem implements Accessible,MenuElement * * @param pos the position of the item to be removed * @exception IllegalArgumentException if the value of - * <code>pos</code> < 0, or if <code>pos</code> + * <code>pos</code> < 0, or if <code>pos</code> * is greater than the number of menu items */ public void remove(int pos) { diff --git a/jdk/src/share/classes/javax/swing/JMenuBar.java b/jdk/src/share/classes/javax/swing/JMenuBar.java index 8e6683d6f17..f00d4207485 100644 --- a/jdk/src/share/classes/javax/swing/JMenuBar.java +++ b/jdk/src/share/classes/javax/swing/JMenuBar.java @@ -130,9 +130,9 @@ public class JMenuBar extends JComponent implements Accessible,MenuElement } /** - * Sets the L&F object that renders this component. + * Sets the L&F object that renders this component. * - * @param ui the new MenuBarUI L&F object + * @param ui the new MenuBarUI L&F object * @see UIDefaults#getUI * @beaninfo * bound: true @@ -155,7 +155,7 @@ public class JMenuBar extends JComponent implements Accessible,MenuElement /** - * Returns the name of the L&F class that renders this component. + * Returns the name of the L&F class that renders this component. * * @return the string "MenuBarUI" * @see JComponent#getUIClassID diff --git a/jdk/src/share/classes/javax/swing/JTextField.java b/jdk/src/share/classes/javax/swing/JTextField.java index 0e5e9aa4915..d4bc1aa0f6b 100644 --- a/jdk/src/share/classes/javax/swing/JTextField.java +++ b/jdk/src/share/classes/javax/swing/JTextField.java @@ -367,7 +367,7 @@ public class JTextField extends JTextComponent implements SwingConstants { /** * Returns the number of columns in this <code>TextField</code>. * - * @return the number of columns >= 0 + * @return the number of columns >= 0 */ public int getColumns() { return columns; @@ -377,7 +377,7 @@ public class JTextField extends JTextComponent implements SwingConstants { * Sets the number of columns in this <code>TextField</code>, * and then invalidate the layout. * - * @param columns the number of columns >= 0 + * @param columns the number of columns >= 0 * @exception IllegalArgumentException if <code>columns</code> * is less than 0 * @beaninfo @@ -402,7 +402,7 @@ public class JTextField extends JTextComponent implements SwingConstants { * character <em>m</em> for the font used. This method can be * redefined to be some alternative amount * - * @return the column width >= 1 + * @return the column width >= 1 */ protected int getColumnWidth() { if (columnWidth == 0) { @@ -744,7 +744,7 @@ public class JTextField extends JTextComponent implements SwingConstants { /** * Gets the scroll offset, in pixels. * - * @return the offset >= 0 + * @return the offset >= 0 */ public int getScrollOffset() { return visibility.getValue(); @@ -753,7 +753,7 @@ public class JTextField extends JTextComponent implements SwingConstants { /** * Sets the scroll offset, in pixels. * - * @param scrollOffset the offset >= 0 + * @param scrollOffset the offset >= 0 */ public void setScrollOffset(int scrollOffset) { visibility.setValue(scrollOffset); diff --git a/jdk/src/share/classes/javax/swing/KeyboardManager.java b/jdk/src/share/classes/javax/swing/KeyboardManager.java index 3ce79226a5f..afbd93e734e 100644 --- a/jdk/src/share/classes/javax/swing/KeyboardManager.java +++ b/jdk/src/share/classes/javax/swing/KeyboardManager.java @@ -208,7 +208,7 @@ class KeyboardManager { public boolean fireKeyboardAction(KeyEvent e, boolean pressed, Container topAncestor) { if (e.isConsumed()) { - System.out.println("Aquired pre-used event!"); + System.out.println("Acquired pre-used event!"); Thread.dumpStack(); } diff --git a/jdk/src/share/classes/javax/swing/SortingFocusTraversalPolicy.java b/jdk/src/share/classes/javax/swing/SortingFocusTraversalPolicy.java index cbdfc015a19..45b3766c33e 100644 --- a/jdk/src/share/classes/javax/swing/SortingFocusTraversalPolicy.java +++ b/jdk/src/share/classes/javax/swing/SortingFocusTraversalPolicy.java @@ -116,7 +116,7 @@ public class SortingFocusTraversalPolicy index = Collections.binarySearch(cycle, aComponent, comparator); } catch (ClassCastException e) { if (log.isLoggable(PlatformLogger.Level.FINE)) { - log.fine("### During the binary search for " + aComponent + " the exception occured: ", e); + log.fine("### During the binary search for " + aComponent + " the exception occurred: ", e); } return -1; } diff --git a/jdk/src/share/classes/javax/swing/text/AbstractDocument.java b/jdk/src/share/classes/javax/swing/text/AbstractDocument.java index 5ccd80d95e5..71e9d5d8c60 100644 --- a/jdk/src/share/classes/javax/swing/text/AbstractDocument.java +++ b/jdk/src/share/classes/javax/swing/text/AbstractDocument.java @@ -1367,7 +1367,7 @@ public abstract class AbstractDocument implements Document, Serializable { currWriter = Thread.currentThread(); numWriters = 1; } catch (InterruptedException e) { - throw new Error("Interrupted attempt to aquire write lock"); + throw new Error("Interrupted attempt to acquire write lock"); } } @@ -1409,7 +1409,7 @@ public abstract class AbstractDocument implements Document, Serializable { } numReaders += 1; } catch (InterruptedException e) { - throw new Error("Interrupted attempt to aquire read lock"); + throw new Error("Interrupted attempt to acquire read lock"); } } diff --git a/jdk/src/share/classes/javax/swing/tree/DefaultMutableTreeNode.java b/jdk/src/share/classes/javax/swing/tree/DefaultMutableTreeNode.java index 5e776a0cd81..17840426075 100644 --- a/jdk/src/share/classes/javax/swing/tree/DefaultMutableTreeNode.java +++ b/jdk/src/share/classes/javax/swing/tree/DefaultMutableTreeNode.java @@ -26,6 +26,7 @@ package javax.swing.tree; // ISSUE: this class depends on nothing in AWT -- move to java.util? +import java.beans.Transient; import java.io.*; import java.util.*; @@ -215,6 +216,7 @@ public class DefaultMutableTreeNode implements Cloneable, * * @param newParent this node's new parent */ + @Transient public void setParent(MutableTreeNode newParent) { parent = newParent; } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ByteVector.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ByteVector.java index 0d3472bcac1..89eb6d4b640 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ByteVector.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ByteVector.java @@ -233,11 +233,14 @@ public class ByteVector { * automatically enlarged if necessary. * * @param s - * a String. + * a String whose UTF8 encoded length must be less than 65536. * @return this byte vector. */ public ByteVector putUTF8(final String s) { int charLength = s.length(); + if (charLength > 65535) { + throw new IllegalArgumentException(); + } int len = length; if (len + 2 + charLength > data.length) { enlarge(2 + charLength); @@ -267,6 +270,9 @@ public class ByteVector { byteLength += 2; } } + if (byteLength > 65535) { + throw new IllegalArgumentException(); + } data[length] = (byte) (byteLength >>> 8); data[length + 1] = (byte) byteLength; if (length + 2 + byteLength > data.length) { diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassReader.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassReader.java index 8cbc2d2c199..4f842157ac3 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassReader.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassReader.java @@ -1266,7 +1266,7 @@ public class ClassReader { u += 2; // generates the first (implicit) stack map frame - if (FRAMES && (stackMap != 0 || unzip)) { + if (FRAMES && stackMap != 0) { /* * for the first explicit frame the offset is not offset_delta + 1 * but only offset_delta; setting the implicit frame offset to -1 @@ -1283,8 +1283,6 @@ public class ClassReader { if (unzip) { getImplicitFrame(context); } - } - if (FRAMES && stackMap != 0) { /* * Finds labels for UNINITIALIZED frame types. Instead of decoding * each element of the stack map table, we look for 3 consecutive @@ -1322,17 +1320,19 @@ public class ClassReader { } } - // visits the frame(s) for this offset, if any + // visits the frame for this offset, if any while (FRAMES && frame != null && (frame.offset == offset || frame.offset == -1)) { // if there is a frame for this offset, makes the visitor visit // it, and reads the next frame if there is one. - if (!zip || unzip) { - mv.visitFrame(Opcodes.F_NEW, frame.localCount, frame.local, - frame.stackCount, frame.stack); - } else if (frame.offset != -1) { - mv.visitFrame(frame.mode, frame.localDiff, frame.local, - frame.stackCount, frame.stack); + if (frame.offset != -1) { + if (!zip || unzip) { + mv.visitFrame(Opcodes.F_NEW, frame.localCount, + frame.local, frame.stackCount, frame.stack); + } else { + mv.visitFrame(frame.mode, frame.localDiff, frame.local, + frame.stackCount, frame.stack); + } } if (frameCount > 0) { stackMap = readFrame(stackMap, zip, unzip, frame); @@ -1434,6 +1434,7 @@ public class ClassReader { case ClassWriter.FIELDORMETH_INSN: case ClassWriter.ITFMETH_INSN: { int cpIndex = items[readUnsignedShort(u + 1)]; + boolean itf = b[cpIndex - 1] == ClassWriter.IMETH; String iowner = readClass(cpIndex, c); cpIndex = items[readUnsignedShort(cpIndex + 2)]; String iname = readUTF8(cpIndex, c); @@ -1441,7 +1442,7 @@ public class ClassReader { if (opcode < Opcodes.INVOKEVIRTUAL) { mv.visitFieldInsn(opcode, iowner, iname, idesc); } else { - mv.visitMethodInsn(opcode, iowner, iname, idesc); + mv.visitMethodInsn(opcode, iowner, iname, idesc, itf); } if (opcode == Opcodes.INVOKEINTERFACE) { u += 5; diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassWriter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassWriter.java index d5d8fa48903..ab9dcd0dce4 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassWriter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/ClassWriter.java @@ -516,12 +516,12 @@ public class ClassWriter extends ClassVisitor { * <tt>true</tt> if the maximum stack size and number of local variables * must be automatically computed. */ - private final boolean computeMaxs; + private boolean computeMaxs; /** * <tt>true</tt> if the stack map frames must be recomputed from scratch. */ - private final boolean computeFrames; + private boolean computeFrames; /** * <tt>true</tt> if the stack map tables of this class are invalid. The @@ -988,9 +988,22 @@ public class ClassWriter extends ClassVisitor { attrs.put(this, null, 0, -1, -1, out); } if (invalidFrames) { - ClassWriter cw = new ClassWriter(COMPUTE_FRAMES); - new ClassReader(out.data).accept(cw, ClassReader.SKIP_FRAMES); - return cw.toByteArray(); + anns = null; + ianns = null; + attrs = null; + innerClassesCount = 0; + innerClasses = null; + bootstrapMethodsCount = 0; + bootstrapMethods = null; + firstField = null; + lastField = null; + firstMethod = null; + lastMethod = null; + computeMaxs = false; + computeFrames = true; + invalidFrames = false; + new ClassReader(out.data).accept(this, ClassReader.SKIP_FRAMES); + return toByteArray(); } return out.data; } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/Handle.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/Handle.java index f262f9a09a0..e8b2859b05d 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/Handle.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/Handle.java @@ -78,7 +78,8 @@ public final class Handle { final int tag; /** - * The internal name of the field or method designed by this handle. + * The internal name of the class that owns the field or method designated + * by this handle. */ final String owner; @@ -105,8 +106,8 @@ public final class Handle { * {@link Opcodes#H_NEWINVOKESPECIAL} or * {@link Opcodes#H_INVOKEINTERFACE}. * @param owner - * the internal name of the field or method designed by this - * handle. + * the internal name of the class that owns the field or method + * designated by this handle. * @param name * the name of the field or method designated by this handle. * @param desc @@ -135,9 +136,11 @@ public final class Handle { } /** - * Returns the internal name of the field or method designed by this handle. + * Returns the internal name of the class that owns the field or method + * designated by this handle. * - * @return the internal name of the field or method designed by this handle. + * @return the internal name of the class that owns the field or method + * designated by this handle. */ public String getOwner() { return owner; diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodVisitor.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodVisitor.java index f21519e962c..0bb1a05b805 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodVisitor.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodVisitor.java @@ -68,11 +68,11 @@ package jdk.internal.org.objectweb.asm; * <tt>visitTryCatchBlock</tt> | <tt>visitTryCatchBlockAnnotation</tt> | * <tt>visitLocalVariable</tt> | <tt>visitLocalVariableAnnotation</tt> | * <tt>visitLineNumber</tt> )* <tt>visitMaxs</tt> ] <tt>visitEnd</tt>. In - * addition, the <tt>visit<i>X</i>Insn</tt> and <tt>visitLabel</tt> - * methods must be called in the sequential order of the bytecode instructions - * of the visited code, <tt>visitInsnAnnotation</tt> must be called <i>after</i> - * the annotated instruction, <tt>visitTryCatchBlock</tt> must be called - * <i>before</i> the labels passed as arguments have been visited, + * addition, the <tt>visit<i>X</i>Insn</tt> and <tt>visitLabel</tt> methods must + * be called in the sequential order of the bytecode instructions of the visited + * code, <tt>visitInsnAnnotation</tt> must be called <i>after</i> the annotated + * instruction, <tt>visitTryCatchBlock</tt> must be called <i>before</i> the + * labels passed as arguments have been visited, * <tt>visitTryCatchBlockAnnotation</tt> must be called <i>after</i> the * corresponding try catch block has been visited, and the * <tt>visitLocalVariable</tt>, <tt>visitLocalVariableAnnotation</tt> and @@ -274,13 +274,9 @@ public abstract class MethodVisitor { * compressed form (all frames must use the same format, i.e. you must not * mix expanded and compressed frames within a single method): * <ul> - * <li>In expanded form, all frames must have the F_NEW type, and a first - * frame corresponding to the method signature must be explicitly visited - * before the first instruction.</li> + * <li>In expanded form, all frames must have the F_NEW type.</li> * <li>In compressed form, frames are basically "deltas" from the state of - * the previous frame (the first frame, corresponding to the method's - * parameters and access flags, is implicit in this form, and must not be - * visited): + * the previous frame: * <ul> * <li>{@link Opcodes#F_SAME} representing frame with exactly the same * locals as the previous frame and with the empty stack.</li> @@ -296,8 +292,14 @@ public abstract class MethodVisitor { * same as the locals in the previous frame, except that the last 1-3 locals * are absent and with the empty stack (<code>nLocals</code> is 1, 2 or 3).</li> * <li>{@link Opcodes#F_FULL} representing complete frame data.</li> - * </ul></li> * </ul> + * </li> + * </ul> + * <br> + * In both cases the first frame, corresponding to the method's parameters + * and access flags, is implicit and must not be visited. Also, it is + * illegal to visit two or more frames for the same code location (i.e., at + * least one instruction must be visited between two calls to visitFrame). * * @param type * the type of this stack map frame. Must be @@ -466,13 +468,52 @@ public abstract class MethodVisitor { * @param desc * the method's descriptor (see {@link Type Type}). */ + @Deprecated public void visitMethodInsn(int opcode, String owner, String name, String desc) { + if (api >= Opcodes.ASM5) { + boolean itf = opcode == Opcodes.INVOKEINTERFACE; + visitMethodInsn(opcode, owner, name, desc, itf); + return; + } if (mv != null) { mv.visitMethodInsn(opcode, owner, name, desc); } } + /** + * Visits a method instruction. A method instruction is an instruction that + * invokes a method. + * + * @param opcode + * the opcode of the type instruction to be visited. This opcode + * is either INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or + * INVOKEINTERFACE. + * @param owner + * the internal name of the method's owner class (see + * {@link Type#getInternalName() getInternalName}). + * @param name + * the method's name. + * @param desc + * the method's descriptor (see {@link Type Type}). + * @param itf + * if the method's owner class is an interface. + */ + public void visitMethodInsn(int opcode, String owner, String name, + String desc, boolean itf) { + if (api < Opcodes.ASM5) { + if (itf != (opcode == Opcodes.INVOKEINTERFACE)) { + throw new IllegalArgumentException( + "INVOKESPECIAL/STATIC on interfaces require ASM 5"); + } + visitMethodInsn(opcode, owner, name, desc); + return; + } + if (mv != null) { + mv.visitMethodInsn(opcode, owner, name, desc, itf); + } + } + /** * Visits an invokedynamic instruction. * diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodWriter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodWriter.java index f59abfa7a3a..81a82804d6e 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodWriter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/MethodWriter.java @@ -71,7 +71,7 @@ class MethodWriter extends MethodVisitor { /** * Pseudo access flag used to denote constructors. */ - static final int ACC_CONSTRUCTOR = 262144; + static final int ACC_CONSTRUCTOR = 0x80000; /** * Frame has exactly the same locals as the previous stack map frame and @@ -297,11 +297,6 @@ class MethodWriter extends MethodVisitor { */ private int[] previousFrame; - /** - * Index of the next element to be added in {@link #frame}. - */ - private int frameIndex; - /** * The current stack map frame. The first element contains the offset of the * instruction to which the frame corresponds, the second element is the @@ -496,6 +491,9 @@ class MethodWriter extends MethodVisitor { cw.lastMethod = this; this.cw = cw; this.access = access; + if ("<init>".equals(name)) { + this.access |= ACC_CONSTRUCTOR; + } this.name = cw.newUTF8(name); this.desc = cw.newUTF8(desc); this.descriptor = desc; @@ -511,9 +509,6 @@ class MethodWriter extends MethodVisitor { } this.compute = computeFrames ? FRAMES : (computeMaxs ? MAXS : NOTHING); if (computeMaxs || computeFrames) { - if (computeFrames && "<init>".equals(name)) { - this.access |= ACC_CONSTRUCTOR; - } // updates maxLocals int size = Type.getArgumentsAndReturnSizes(descriptor) >> 2; if ((access & Opcodes.ACC_STATIC) != 0) { @@ -649,8 +644,11 @@ class MethodWriter extends MethodVisitor { } if (type == Opcodes.F_NEW) { + if (previousFrame == null) { + visitImplicitFirstFrame(); + } currentLocals = nLocal; - startFrame(code.length, nLocal, nStack); + int frameIndex = startFrame(code.length, nLocal, nStack); for (int i = 0; i < nLocal; ++i) { if (local[i] instanceof String) { frame[frameIndex++] = Frame.OBJECT @@ -914,9 +912,8 @@ class MethodWriter extends MethodVisitor { @Override public void visitMethodInsn(final int opcode, final String owner, - final String name, final String desc) { + final String name, final String desc, final boolean itf) { lastCodeOffset = code.length; - boolean itf = opcode == Opcodes.INVOKEINTERFACE; Item i = cw.newMethodItem(owner, name, desc, itf); int argSize = i.intVal; // Label currentBlock = this.currentBlock; @@ -954,7 +951,7 @@ class MethodWriter extends MethodVisitor { } } // adds the instruction to the bytecode of the method - if (itf) { + if (opcode == Opcodes.INVOKEINTERFACE) { if (argSize == 0) { argSize = Type.getArgumentsAndReturnSizes(desc); i.intVal = argSize; @@ -1528,8 +1525,8 @@ class MethodWriter extends MethodVisitor { } code.data[end] = (byte) Opcodes.ATHROW; // emits a frame for this unreachable block - startFrame(start, 0, 1); - frame[frameIndex++] = Frame.OBJECT + int frameIndex = startFrame(start, 0, 1); + frame[frameIndex] = Frame.OBJECT | cw.addType("java/lang/Throwable"); endFrame(); // removes the start-end range from the exception @@ -1756,7 +1753,7 @@ class MethodWriter extends MethodVisitor { } } // visits the frame and its content - startFrame(f.owner.position, nLocal, nStack); + int frameIndex = startFrame(f.owner.position, nLocal, nStack); for (i = 0; nLocal > 0; ++i, --nLocal) { t = locals[i]; frame[frameIndex++] = t; @@ -1774,6 +1771,67 @@ class MethodWriter extends MethodVisitor { endFrame(); } + /** + * Visit the implicit first frame of this method. + */ + private void visitImplicitFirstFrame() { + // There can be at most descriptor.length() + 1 locals + int frameIndex = startFrame(0, descriptor.length() + 1, 0); + if ((access & Opcodes.ACC_STATIC) == 0) { + if ((access & ACC_CONSTRUCTOR) == 0) { + frame[frameIndex++] = Frame.OBJECT | cw.addType(cw.thisName); + } else { + frame[frameIndex++] = 6; // Opcodes.UNINITIALIZED_THIS; + } + } + int i = 1; + loop: while (true) { + int j = i; + switch (descriptor.charAt(i++)) { + case 'Z': + case 'C': + case 'B': + case 'S': + case 'I': + frame[frameIndex++] = 1; // Opcodes.INTEGER; + break; + case 'F': + frame[frameIndex++] = 2; // Opcodes.FLOAT; + break; + case 'J': + frame[frameIndex++] = 4; // Opcodes.LONG; + break; + case 'D': + frame[frameIndex++] = 3; // Opcodes.DOUBLE; + break; + case '[': + while (descriptor.charAt(i) == '[') { + ++i; + } + if (descriptor.charAt(i) == 'L') { + ++i; + while (descriptor.charAt(i) != ';') { + ++i; + } + } + frame[frameIndex++] = Frame.OBJECT + | cw.addType(descriptor.substring(j, ++i)); + break; + case 'L': + while (descriptor.charAt(i) != ';') { + ++i; + } + frame[frameIndex++] = Frame.OBJECT + | cw.addType(descriptor.substring(j + 1, i++)); + break; + default: + break loop; + } + } + frame[1] = frameIndex - 3; + endFrame(); + } + /** * Starts the visit of a stack map frame. * @@ -1783,8 +1841,9 @@ class MethodWriter extends MethodVisitor { * the number of local variables in the frame. * @param nStack * the number of stack elements in the frame. + * @return the index of the next element to be written in this frame. */ - private void startFrame(final int offset, final int nLocal, final int nStack) { + private int startFrame(final int offset, final int nLocal, final int nStack) { int n = 3 + nLocal + nStack; if (frame == null || frame.length < n) { frame = new int[n]; @@ -1792,7 +1851,7 @@ class MethodWriter extends MethodVisitor { frame[0] = offset; frame[1] = nLocal; frame[2] = nStack; - frameIndex = 3; + return 3; } /** @@ -2110,7 +2169,8 @@ class MethodWriter extends MethodVisitor { */ final void put(final ByteVector out) { final int FACTOR = ClassWriter.TO_ACC_SYNTHETIC; - int mask = Opcodes.ACC_DEPRECATED | ClassWriter.ACC_SYNTHETIC_ATTRIBUTE + int mask = ACC_CONSTRUCTOR | Opcodes.ACC_DEPRECATED + | ClassWriter.ACC_SYNTHETIC_ATTRIBUTE | ((access & ClassWriter.ACC_SYNTHETIC_ATTRIBUTE) / FACTOR); out.putShort(access & ~mask).putShort(name).putShort(desc); if (classReaderOffset != 0) { diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AdviceAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AdviceAdapter.java index c7d51d45b91..c07917784df 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AdviceAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AdviceAdapter.java @@ -442,10 +442,31 @@ public abstract class AdviceAdapter extends GeneratorAdapter implements Opcodes } } + @Deprecated @Override public void visitMethodInsn(final int opcode, final String owner, final String name, final String desc) { - mv.visitMethodInsn(opcode, owner, name, desc); + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(int opcode, final String owner, + final String name, final String desc, final boolean itf) { + mv.visitMethodInsn(opcode, owner, name, desc, itf); if (constructor) { Type[] types = Type.getArgumentTypes(desc); for (int i = 0; i < types.length; i++) { diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AnalyzerAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AnalyzerAdapter.java index 1371250da0a..e914d45134e 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AnalyzerAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/AnalyzerAdapter.java @@ -165,10 +165,15 @@ public class AnalyzerAdapter extends MethodVisitor { * @param mv * the method visitor to which this adapter delegates calls. May * be <tt>null</tt>. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public AnalyzerAdapter(final String owner, final int access, final String name, final String desc, final MethodVisitor mv) { this(Opcodes.ASM5, owner, access, name, desc, mv); + if (getClass() != AnalyzerAdapter.class) { + throw new IllegalStateException(); + } } /** @@ -331,11 +336,32 @@ public class AnalyzerAdapter extends MethodVisitor { execute(opcode, 0, desc); } + @Deprecated @Override public void visitMethodInsn(final int opcode, final String owner, final String name, final String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(int opcode, final String owner, + final String name, final String desc, final boolean itf) { if (mv != null) { - mv.visitMethodInsn(opcode, owner, name, desc); + mv.visitMethodInsn(opcode, owner, name, desc, itf); } if (this.locals == null) { labels = null; diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/CodeSizeEvaluator.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/CodeSizeEvaluator.java index a04a643d18b..0a41b2b8af6 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/CodeSizeEvaluator.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/CodeSizeEvaluator.java @@ -149,9 +149,30 @@ public class CodeSizeEvaluator extends MethodVisitor implements Opcodes { } } + @Deprecated @Override public void visitMethodInsn(final int opcode, final String owner, final String name, final String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(int opcode, final String owner, + final String name, final String desc, final boolean itf) { if (opcode == INVOKEINTERFACE) { minSize += 5; maxSize += 5; @@ -160,7 +181,7 @@ public class CodeSizeEvaluator extends MethodVisitor implements Opcodes { maxSize += 3; } if (mv != null) { - mv.visitMethodInsn(opcode, owner, name, desc); + mv.visitMethodInsn(opcode, owner, name, desc, itf); } } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/GeneratorAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/GeneratorAdapter.java index 7e30acbbe72..786a5b5365a 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/GeneratorAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/GeneratorAdapter.java @@ -284,10 +284,15 @@ public class GeneratorAdapter extends LocalVariablesSorter { * the method's name. * @param desc * the method's descriptor (see {@link Type Type}). + * @throws IllegalStateException + * If a subclass calls this constructor. */ public GeneratorAdapter(final MethodVisitor mv, final int access, final String name, final String desc) { this(Opcodes.ASM5, mv, access, name, desc); + if (getClass() != GeneratorAdapter.class) { + throw new IllegalStateException(); + } } /** @@ -1400,11 +1405,11 @@ public class GeneratorAdapter extends LocalVariablesSorter { * the method to be invoked. */ private void invokeInsn(final int opcode, final Type type, - final Method method) { + final Method method, final boolean itf) { String owner = type.getSort() == Type.ARRAY ? type.getDescriptor() : type.getInternalName(); mv.visitMethodInsn(opcode, owner, method.getName(), - method.getDescriptor()); + method.getDescriptor(), itf); } /** @@ -1416,7 +1421,7 @@ public class GeneratorAdapter extends LocalVariablesSorter { * the method to be invoked. */ public void invokeVirtual(final Type owner, final Method method) { - invokeInsn(Opcodes.INVOKEVIRTUAL, owner, method); + invokeInsn(Opcodes.INVOKEVIRTUAL, owner, method, false); } /** @@ -1428,7 +1433,7 @@ public class GeneratorAdapter extends LocalVariablesSorter { * the constructor to be invoked. */ public void invokeConstructor(final Type type, final Method method) { - invokeInsn(Opcodes.INVOKESPECIAL, type, method); + invokeInsn(Opcodes.INVOKESPECIAL, type, method, false); } /** @@ -1440,7 +1445,7 @@ public class GeneratorAdapter extends LocalVariablesSorter { * the method to be invoked. */ public void invokeStatic(final Type owner, final Method method) { - invokeInsn(Opcodes.INVOKESTATIC, owner, method); + invokeInsn(Opcodes.INVOKESTATIC, owner, method, false); } /** @@ -1452,7 +1457,7 @@ public class GeneratorAdapter extends LocalVariablesSorter { * the method to be invoked. */ public void invokeInterface(final Type owner, final Method method) { - invokeInsn(Opcodes.INVOKEINTERFACE, owner, method); + invokeInsn(Opcodes.INVOKEINTERFACE, owner, method, true); } /** diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/InstructionAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/InstructionAdapter.java index 912b622db13..4ece2dba90d 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/InstructionAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/InstructionAdapter.java @@ -82,9 +82,14 @@ public class InstructionAdapter extends MethodVisitor { * * @param mv * the method visitor to which this adapter delegates calls. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public InstructionAdapter(final MethodVisitor mv) { this(Opcodes.ASM5, mv); + if (getClass() != InstructionAdapter.class) { + throw new IllegalStateException(); + } } /** @@ -536,18 +541,39 @@ public class InstructionAdapter extends MethodVisitor { } } + @Deprecated @Override public void visitMethodInsn(final int opcode, final String owner, final String name, final String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(int opcode, final String owner, + final String name, final String desc, final boolean itf) { switch (opcode) { case Opcodes.INVOKESPECIAL: - invokespecial(owner, name, desc); + invokespecial(owner, name, desc, itf); break; case Opcodes.INVOKEVIRTUAL: - invokevirtual(owner, name, desc); + invokevirtual(owner, name, desc, itf); break; case Opcodes.INVOKESTATIC: - invokestatic(owner, name, desc); + invokestatic(owner, name, desc, itf); break; case Opcodes.INVOKEINTERFACE: invokeinterface(owner, name, desc); @@ -1014,24 +1040,78 @@ public class InstructionAdapter extends MethodVisitor { mv.visitFieldInsn(Opcodes.PUTFIELD, owner, name, desc); } + @Deprecated public void invokevirtual(final String owner, final String name, final String desc) { + if (api >= Opcodes.ASM5) { + invokevirtual(owner, name, desc, false); + return; + } mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, owner, name, desc); } + public void invokevirtual(final String owner, final String name, + final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + if (itf) { + throw new IllegalArgumentException( + "INVOKEVIRTUAL on interfaces require ASM 5"); + } + invokevirtual(owner, name, desc); + return; + } + mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, owner, name, desc, itf); + } + + @Deprecated public void invokespecial(final String owner, final String name, final String desc) { - mv.visitMethodInsn(Opcodes.INVOKESPECIAL, owner, name, desc); + if (api >= Opcodes.ASM5) { + invokespecial(owner, name, desc, false); + return; + } + mv.visitMethodInsn(Opcodes.INVOKESPECIAL, owner, name, desc, false); + } + + public void invokespecial(final String owner, final String name, + final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + if (itf) { + throw new IllegalArgumentException( + "INVOKESPECIAL on interfaces require ASM 5"); + } + invokespecial(owner, name, desc); + return; + } + mv.visitMethodInsn(Opcodes.INVOKESPECIAL, owner, name, desc, itf); + } + + @Deprecated + public void invokestatic(final String owner, final String name, + final String desc) { + if (api < Opcodes.ASM5) { + invokestatic(owner, name, desc, false); + return; + } + mv.visitMethodInsn(Opcodes.INVOKESTATIC, owner, name, desc, false); } public void invokestatic(final String owner, final String name, - final String desc) { - mv.visitMethodInsn(Opcodes.INVOKESTATIC, owner, name, desc); + final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + if (itf) { + throw new IllegalArgumentException( + "INVOKESTATIC on interfaces require ASM 5"); + } + invokestatic(owner, name, desc); + return; + } + mv.visitMethodInsn(Opcodes.INVOKESTATIC, owner, name, desc, itf); } public void invokeinterface(final String owner, final String name, final String desc) { - mv.visitMethodInsn(Opcodes.INVOKEINTERFACE, owner, name, desc); + mv.visitMethodInsn(Opcodes.INVOKEINTERFACE, owner, name, desc, true); } public void invokedynamic(String name, String desc, Handle bsm, diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/JSRInlinerAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/JSRInlinerAdapter.java index 1a255b7096f..e0514114e51 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/JSRInlinerAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/JSRInlinerAdapter.java @@ -136,11 +136,16 @@ public class JSRInlinerAdapter extends MethodNode implements Opcodes { * the internal names of the method's exception classes (see * {@link Type#getInternalName() getInternalName}). May be * <tt>null</tt>. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public JSRInlinerAdapter(final MethodVisitor mv, final int access, final String name, final String desc, final String signature, final String[] exceptions) { this(Opcodes.ASM5, mv, access, name, desc, signature, exceptions); + if (getClass() != JSRInlinerAdapter.class) { + throw new IllegalStateException(); + } } /** @@ -381,6 +386,17 @@ public class JSRInlinerAdapter extends MethodNode implements Opcodes { // Use tail recursion here in the form of an outer while loop to // avoid our stack growing needlessly: index++; + + // We implicitly assumed above that execution can always fall + // through to the next instruction after a JSR. But a subroutine may + // never return, in which case the code after the JSR is unreachable + // and can be anything. In particular, it can seem to fall off the + // end of the method, so we must handle this case here (we could + // instead detect whether execution can return or not from a JSR, + // but this is more complicated). + if (index >= instructions.size()) { + return; + } } } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/LocalVariablesSorter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/LocalVariablesSorter.java index 0353c499382..5d02c53768d 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/LocalVariablesSorter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/LocalVariablesSorter.java @@ -120,10 +120,15 @@ public class LocalVariablesSorter extends MethodVisitor { * the method's descriptor (see {@link Type Type}). * @param mv * the method visitor to which this adapter delegates calls. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public LocalVariablesSorter(final int access, final String desc, final MethodVisitor mv) { this(Opcodes.ASM5, access, desc, mv); + if (getClass() != LocalVariablesSorter.class) { + throw new IllegalStateException(); + } } /** @@ -323,6 +328,7 @@ public class LocalVariablesSorter extends MethodVisitor { int local = newLocalMapping(type); setLocalType(local, type); setFrameLocal(local, t); + changed = true; return local; } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingMethodAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingMethodAdapter.java index 319d9dedc7e..d5493a1b1b5 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingMethodAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingMethodAdapter.java @@ -148,12 +148,41 @@ public class RemappingMethodAdapter extends LocalVariablesSorter { remapper.mapDesc(desc)); } + @Deprecated @Override - public void visitMethodInsn(int opcode, String owner, String name, - String desc) { - super.visitMethodInsn(opcode, remapper.mapType(owner), - remapper.mapMethodName(owner, name, desc), - remapper.mapMethodDesc(desc)); + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(int opcode, String owner, String name, + String desc, boolean itf) { + // Calling super.visitMethodInsn requires to call the correct version + // depending on this.api (otherwise infinite loops can occur). To + // simplify and to make it easier to automatically remove the backward + // compatibility code, we inline the code of the overridden method here. + // IMPORTANT: THIS ASSUMES THAT visitMethodInsn IS NOT OVERRIDDEN IN + // LocalVariableSorter. + if (mv != null) { + mv.visitMethodInsn(opcode, remapper.mapType(owner), + remapper.mapMethodName(owner, name, desc), + remapper.mapMethodDesc(desc), itf); + } } @Override diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingSignatureAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingSignatureAdapter.java index 458ee69b1ff..3b8ab02a3f1 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingSignatureAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/RemappingSignatureAdapter.java @@ -95,10 +95,12 @@ public class RemappingSignatureAdapter extends SignatureVisitor { @Override public void visitInnerClassType(String name) { + String remappedOuter = remapper.mapType(className) + '$'; className = className + '$' + name; String remappedName = remapper.mapType(className); - v.visitInnerClassType(remappedName.substring(remappedName - .lastIndexOf('$') + 1)); + int index = remappedName.startsWith(remappedOuter) ? remappedOuter + .length() : remappedName.lastIndexOf('$') + 1; + v.visitInnerClassType(remappedName.substring(index)); } @Override diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/SerialVersionUIDAdder.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/SerialVersionUIDAdder.java index 4050d0ce402..de8915125ff 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/SerialVersionUIDAdder.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/SerialVersionUIDAdder.java @@ -195,9 +195,14 @@ public class SerialVersionUIDAdder extends ClassVisitor { * @param cv * a {@link ClassVisitor} to which this visitor will delegate * calls. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public SerialVersionUIDAdder(final ClassVisitor cv) { this(Opcodes.ASM5, cv); + if (getClass() != SerialVersionUIDAdder.class) { + throw new IllegalStateException(); + } } /** @@ -218,7 +223,7 @@ public class SerialVersionUIDAdder extends ClassVisitor { } // ------------------------------------------------------------------------ - // Overriden methods + // Overridden methods // ------------------------------------------------------------------------ /* @@ -234,7 +239,7 @@ public class SerialVersionUIDAdder extends ClassVisitor { if (computeSVUID) { this.name = name; this.access = access; - this.interfaces = interfaces; + this.interfaces = Arrays.copyOf(interfaces, interfaces.length); } super.visit(version, access, name, signature, superName, interfaces); diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/StaticInitMerger.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/StaticInitMerger.java index 3514d090787..2f2f3b6ddcb 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/StaticInitMerger.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/StaticInitMerger.java @@ -107,7 +107,8 @@ public class StaticInitMerger extends ClassVisitor { if (clinit == null) { clinit = cv.visitMethod(a, name, desc, null, null); } - clinit.visitMethodInsn(Opcodes.INVOKESTATIC, this.name, n, desc); + clinit.visitMethodInsn(Opcodes.INVOKESTATIC, this.name, n, desc, + false); } else { mv = cv.visitMethod(access, name, desc, signature, exceptions); } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/TryCatchBlockSorter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/TryCatchBlockSorter.java index 0b2be355877..39c2bf37904 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/TryCatchBlockSorter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/commons/TryCatchBlockSorter.java @@ -66,7 +66,6 @@ import jdk.internal.org.objectweb.asm.MethodVisitor; import jdk.internal.org.objectweb.asm.Opcodes; import jdk.internal.org.objectweb.asm.tree.MethodNode; import jdk.internal.org.objectweb.asm.tree.TryCatchBlockNode; -import jdk.internal.org.objectweb.asm.tree.TypeAnnotationNode; /** * A {@link MethodVisitor} adapter to sort the exception handlers. The handlers diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/AnnotationNode.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/AnnotationNode.java index 57b88f1b11f..b67ea38591a 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/AnnotationNode.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/AnnotationNode.java @@ -96,9 +96,14 @@ public class AnnotationNode extends AnnotationVisitor { * * @param desc * the class descriptor of the annotation class. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public AnnotationNode(final String desc) { this(Opcodes.ASM5, desc); + if (getClass() != AnnotationNode.class) { + throw new IllegalStateException(); + } } /** diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/ClassNode.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/ClassNode.java index cb70518aa93..39334641754 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/ClassNode.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/ClassNode.java @@ -216,9 +216,15 @@ public class ClassNode extends ClassVisitor { * Constructs a new {@link ClassNode}. <i>Subclasses must not use this * constructor</i>. Instead, they must use the {@link #ClassNode(int)} * version. + * + * @throws IllegalStateException + * If a subclass calls this constructor. */ public ClassNode() { this(Opcodes.ASM5); + if (getClass() != ClassNode.class) { + throw new IllegalStateException(); + } } /** diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/FieldNode.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/FieldNode.java index a155d2c1b80..cc79a5815cb 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/FieldNode.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/FieldNode.java @@ -168,16 +168,20 @@ public class FieldNode extends FieldVisitor { * <tt>null</tt> if the field does not have an initial value, * must be an {@link Integer}, a {@link Float}, a {@link Long}, a * {@link Double} or a {@link String}. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public FieldNode(final int access, final String name, final String desc, final String signature, final Object value) { this(Opcodes.ASM5, access, name, desc, signature, value); + if (getClass() != FieldNode.class) { + throw new IllegalStateException(); + } } /** * Constructs a new {@link FieldNode}. <i>Subclasses must not use this - * constructor</i>. Instead, they must use the - * {@link #FieldNode(int, int, String, String, String, Object)} version. + * constructor</i>. * * @param api * the ASM API version implemented by this visitor. Must be one diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodInsnNode.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodInsnNode.java index 6f6d5dc4453..2f61df3b517 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodInsnNode.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodInsnNode.java @@ -61,6 +61,7 @@ package jdk.internal.org.objectweb.asm.tree; import java.util.Map; import jdk.internal.org.objectweb.asm.MethodVisitor; +import jdk.internal.org.objectweb.asm.Opcodes; /** * A node that represents a method instruction. A method instruction is an @@ -86,6 +87,11 @@ public class MethodInsnNode extends AbstractInsnNode { */ public String desc; + /** + * If the method's owner class if an interface. + */ + public boolean itf; + /** * Constructs a new {@link MethodInsnNode}. * @@ -102,12 +108,37 @@ public class MethodInsnNode extends AbstractInsnNode { * @param desc * the method's descriptor (see {@link jdk.internal.org.objectweb.asm.Type}). */ + @Deprecated public MethodInsnNode(final int opcode, final String owner, final String name, final String desc) { + this(opcode, owner, name, desc, opcode == Opcodes.INVOKEINTERFACE); + } + + /** + * Constructs a new {@link MethodInsnNode}. + * + * @param opcode + * the opcode of the type instruction to be constructed. This + * opcode must be INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC or + * INVOKEINTERFACE. + * @param owner + * the internal name of the method's owner class (see + * {@link jdk.internal.org.objectweb.asm.Type#getInternalName() + * getInternalName}). + * @param name + * the method's name. + * @param desc + * the method's descriptor (see {@link jdk.internal.org.objectweb.asm.Type}). + * @param itf + * if the method's owner class is an interface. + */ + public MethodInsnNode(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { super(opcode); this.owner = owner; this.name = name; this.desc = desc; + this.itf = itf; } /** @@ -128,11 +159,11 @@ public class MethodInsnNode extends AbstractInsnNode { @Override public void accept(final MethodVisitor mv) { - mv.visitMethodInsn(opcode, owner, name, desc); + mv.visitMethodInsn(opcode, owner, name, desc, itf); } @Override public AbstractInsnNode clone(final Map<LabelNode, LabelNode> labels) { - return new MethodInsnNode(opcode, owner, name, desc); + return new MethodInsnNode(opcode, owner, name, desc, itf); } } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodNode.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodNode.java index 072d549265c..dfd58a0fe1f 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodNode.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/MethodNode.java @@ -71,7 +71,6 @@ import jdk.internal.org.objectweb.asm.MethodVisitor; import jdk.internal.org.objectweb.asm.Opcodes; import jdk.internal.org.objectweb.asm.Type; import jdk.internal.org.objectweb.asm.TypePath; -import jdk.internal.org.objectweb.asm.TypeReference; /** * A node that represents a method. @@ -245,9 +244,15 @@ public class MethodNode extends MethodVisitor { * Constructs an uninitialized {@link MethodNode}. <i>Subclasses must not * use this constructor</i>. Instead, they must use the * {@link #MethodNode(int)} version. + * + * @throws IllegalStateException + * If a subclass calls this constructor. */ public MethodNode() { this(Opcodes.ASM5); + if (getClass() != MethodNode.class) { + throw new IllegalStateException(); + } } /** @@ -281,10 +286,15 @@ public class MethodNode extends MethodVisitor { * the internal names of the method's exception classes (see * {@link Type#getInternalName() getInternalName}). May be * <tt>null</tt>. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public MethodNode(final int access, final String name, final String desc, final String signature, final String[] exceptions) { this(Opcodes.ASM5, access, name, desc, signature, exceptions); + if (getClass() != MethodNode.class) { + throw new IllegalStateException(); + } } /** @@ -461,12 +471,27 @@ public class MethodNode extends MethodVisitor { instructions.add(new FieldInsnNode(opcode, owner, name, desc)); } + @Deprecated @Override - public void visitMethodInsn(final int opcode, final String owner, - final String name, final String desc) { + public void visitMethodInsn(int opcode, String owner, String name, + String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } instructions.add(new MethodInsnNode(opcode, owner, name, desc)); } + @Override + public void visitMethodInsn(int opcode, String owner, String name, + String desc, boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + instructions.add(new MethodInsnNode(opcode, owner, name, desc, itf)); + } + @Override public void visitInvokeDynamicInsn(String name, String desc, Handle bsm, Object... bsmArgs) { @@ -696,6 +721,12 @@ public class MethodNode extends MethodVisitor { && insn.invisibleTypeAnnotations.size() > 0) { throw new RuntimeException(); } + if (insn instanceof MethodInsnNode) { + boolean itf = ((MethodInsnNode) insn).itf; + if (itf != (insn.opcode == Opcodes.INVOKEINTERFACE)) { + throw new RuntimeException(); + } + } } if (visibleLocalVariableAnnotations != null && visibleLocalVariableAnnotations.size() > 0) { @@ -705,7 +736,6 @@ public class MethodNode extends MethodVisitor { && invisibleLocalVariableAnnotations.size() > 0) { throw new RuntimeException(); } - } } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/TypeAnnotationNode.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/TypeAnnotationNode.java index c9e21d8c5be..641dca1c17d 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/TypeAnnotationNode.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/TypeAnnotationNode.java @@ -94,10 +94,15 @@ public class TypeAnnotationNode extends AnnotationNode { * <tt>null</tt> if the annotation targets 'typeRef' as a whole. * @param desc * the class descriptor of the annotation class. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public TypeAnnotationNode(final int typeRef, final TypePath typePath, final String desc) { this(Opcodes.ASM5, typeRef, typePath, desc); + if (getClass() != TypeAnnotationNode.class) { + throw new IllegalStateException(); + } } /** diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/analysis/Frame.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/analysis/Frame.java index 2d9434fc22e..f6b8db3ddfb 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/analysis/Frame.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/tree/analysis/Frame.java @@ -162,6 +162,15 @@ public class Frame<V extends Value> { return locals; } + /** + * Returns the maximum stack size of this frame. + * + * @return the maximum stack size of this frame. + */ + public int getMaxStackSize() { + return values.length - locals; + } + /** * Returns the value of the given local variable. * diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/ASMifier.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/ASMifier.java index 6b6bd4dc6bb..a9487e16f5e 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/ASMifier.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/ASMifier.java @@ -113,9 +113,15 @@ public class ASMifier extends Printer { * Constructs a new {@link ASMifier}. <i>Subclasses must not use this * constructor</i>. Instead, they must use the * {@link #ASMifier(int, String, int)} version. + * + * @throws IllegalStateException + * If a subclass calls this constructor. */ public ASMifier() { this(Opcodes.ASM5, "cw", 0); + if (getClass() != ASMifier.class) { + throw new IllegalStateException(); + } } /** @@ -483,8 +489,9 @@ public class ASMifier extends Printer { @Override public void visitParameter(String parameterName, int access) { buf.setLength(0); - buf.append(name).append(".visitParameter(").append(parameterName) - .append(", "); + buf.append(name).append(".visitParameter("); + appendString(buf, parameterName); + buf.append(", "); appendAccess(access); text.add(buf.append(");\n").toString()); } @@ -639,9 +646,30 @@ public class ASMifier extends Printer { text.add(buf.toString()); } + @Deprecated @Override public void visitMethodInsn(final int opcode, final String owner, final String name, final String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { buf.setLength(0); buf.append(this.name).append(".visitMethodInsn(") .append(OPCODES[opcode]).append(", "); @@ -650,6 +678,8 @@ public class ASMifier extends Printer { appendConstant(name); buf.append(", "); appendConstant(desc); + buf.append(", "); + buf.append(itf ? "true" : "false"); buf.append(");\n"); text.add(buf.toString()); } @@ -1076,6 +1106,13 @@ public class ASMifier extends Printer { buf.append("ACC_DEPRECATED"); first = false; } + if ((access & Opcodes.ACC_MANDATED) != 0) { + if (!first) { + buf.append(" + "); + } + buf.append("ACC_MANDATED"); + first = false; + } if (first) { buf.append('0'); } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckClassAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckClassAdapter.java index ad29ab964a7..5105db7f9c2 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckClassAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckClassAdapter.java @@ -246,7 +246,7 @@ public class CheckClassAdapter extends ClassVisitor { List<Type> interfaces = new ArrayList<Type>(); for (Iterator<String> i = cn.interfaces.iterator(); i.hasNext();) { - interfaces.add(Type.getObjectType(i.next().toString())); + interfaces.add(Type.getObjectType(i.next())); } for (int i = 0; i < methods.size(); ++i) { @@ -359,9 +359,14 @@ public class CheckClassAdapter extends ClassVisitor { * <tt>false</tt> to not perform any data flow check (see * {@link CheckMethodAdapter}). This option requires valid * maxLocals and maxStack values. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public CheckClassAdapter(final ClassVisitor cv, final boolean checkDataFlow) { this(Opcodes.ASM5, cv, checkDataFlow); + if (getClass() != CheckClassAdapter.class) { + throw new IllegalStateException(); + } } /** @@ -471,7 +476,15 @@ public class CheckClassAdapter extends ClassVisitor { CheckMethodAdapter.checkInternalName(outerName, "outer class name"); } if (innerName != null) { - CheckMethodAdapter.checkIdentifier(innerName, "inner class name"); + int start = 0; + while (start < innerName.length() + && Character.isDigit(innerName.charAt(start))) { + start++; + } + if (start == 0 || start < innerName.length()) { + CheckMethodAdapter.checkIdentifier(innerName, start, -1, + "inner class name"); + } } checkAccess(access, Opcodes.ACC_PUBLIC + Opcodes.ACC_PRIVATE + Opcodes.ACC_PROTECTED + Opcodes.ACC_STATIC diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckFieldAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckFieldAdapter.java index b09559c0d8a..e0857bf06b3 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckFieldAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckFieldAdapter.java @@ -79,9 +79,14 @@ public class CheckFieldAdapter extends FieldVisitor { * * @param fv * the field visitor to which this adapter must delegate calls. + * @throws IllegalStateException + * If a subclass calls this constructor. */ public CheckFieldAdapter(final FieldVisitor fv) { this(Opcodes.ASM5, fv); + if (getClass() != CheckFieldAdapter.class) { + throw new IllegalStateException(); + } } /** diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckMethodAdapter.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckMethodAdapter.java index b59709890f4..0716debae62 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckMethodAdapter.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/CheckMethodAdapter.java @@ -142,11 +142,6 @@ public class CheckMethodAdapter extends MethodVisitor { */ private Set<Label> usedLabels; - /** - * If an explicit first frame has been visited before the first instruction. - */ - private boolean hasExplicitFirstFrame; - /** * Number of visited frames in expanded form. */ @@ -157,6 +152,11 @@ public class CheckMethodAdapter extends MethodVisitor { */ private int compressedFrames; + /** + * Number of instructions before the last visited frame. + */ + private int lastFrame = -1; + /** * The exception handler ranges. Each pair of list element contains the * start and end labels of an exception handler block. @@ -421,10 +421,15 @@ public class CheckMethodAdapter extends MethodVisitor { * the method visitor to which this adapter must delegate calls. * @param labels * a map of already visited labels (in other methods). + * @throws IllegalStateException + * If a subclass calls this constructor. */ public CheckMethodAdapter(final MethodVisitor mv, final Map<Label, Integer> labels) { this(Opcodes.ASM5, mv, labels); + if (getClass() != CheckMethodAdapter.class) { + throw new IllegalStateException(); + } } /** @@ -465,7 +470,7 @@ public class CheckMethodAdapter extends MethodVisitor { public CheckMethodAdapter(final int access, final String name, final String desc, final MethodVisitor cmv, final Map<Label, Integer> labels) { - this(new MethodNode(access, name, desc, null, null) { + this(new MethodNode(Opcodes.ASM5, access, name, desc, null, null) { @Override public void visitEnd() { Analyzer<BasicValue> a = new Analyzer<BasicValue>( @@ -499,6 +504,7 @@ public class CheckMethodAdapter extends MethodVisitor { } CheckClassAdapter.checkAccess(access, Opcodes.ACC_FINAL + Opcodes.ACC_MANDATED + Opcodes.ACC_SYNTHETIC); + super.visitParameter(name, access); } @Override @@ -566,6 +572,11 @@ public class CheckMethodAdapter extends MethodVisitor { @Override public void visitFrame(final int type, final int nLocal, final Object[] local, final int nStack, final Object[] stack) { + if (insnCount == lastFrame) { + throw new IllegalStateException( + "At most one frame can be visited at a given code location."); + } + lastFrame = insnCount; int mLocal; int mStack; switch (type) { @@ -621,13 +632,6 @@ public class CheckMethodAdapter extends MethodVisitor { checkFrameValue(stack[i]); } if (type == Opcodes.F_NEW) { - if (insnCount == 0) { - hasExplicitFirstFrame = true; - } else if (!hasExplicitFirstFrame) { - throw new RuntimeException( - "In expanded form, a first frame must be explicitly " - + "visited before the first instruction."); - } ++expandedFrames; } else { ++compressedFrames; @@ -709,9 +713,30 @@ public class CheckMethodAdapter extends MethodVisitor { ++insnCount; } + @Deprecated @Override - public void visitMethodInsn(final int opcode, final String owner, - final String name, final String desc) { + public void visitMethodInsn(int opcode, String owner, String name, + String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(int opcode, String owner, String name, + String desc, boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(int opcode, final String owner, + final String name, final String desc, final boolean itf) { checkStartCode(); checkEndCode(); checkOpcode(opcode, 5); @@ -720,7 +745,21 @@ public class CheckMethodAdapter extends MethodVisitor { } checkInternalName(owner, "owner"); checkMethodDesc(desc); - super.visitMethodInsn(opcode, owner, name, desc); + if (opcode == Opcodes.INVOKEVIRTUAL && itf) { + throw new IllegalArgumentException( + "INVOKEVIRTUAL can't be used with interfaces"); + } + if (opcode == Opcodes.INVOKEINTERFACE && !itf) { + throw new IllegalArgumentException( + "INVOKEINTERFACE can't be used with classes"); + } + // Calling super.visitMethodInsn requires to call the correct version + // depending on this.api (otherwise infinite loops can occur). To + // simplify and to make it easier to automatically remove the backward + // compatibility code, we inline the code of the overridden method here. + if (mv != null) { + mv.visitMethodInsn(opcode, owner, name, desc, itf); + } ++insnCount; } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Printer.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Printer.java index 5d50e8fe539..87e79f47e14 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Printer.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Printer.java @@ -401,8 +401,33 @@ public abstract class Printer { * Method instruction. See * {@link jdk.internal.org.objectweb.asm.MethodVisitor#visitMethodInsn}. */ - public abstract void visitMethodInsn(final int opcode, final String owner, - final String name, final String desc); + @Deprecated + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc) { + if (api >= Opcodes.ASM5) { + boolean itf = opcode == Opcodes.INVOKEINTERFACE; + visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + throw new RuntimeException("Must be overriden"); + } + + /** + * Method instruction. See + * {@link jdk.internal.org.objectweb.asm.MethodVisitor#visitMethodInsn}. + */ + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + if (itf != (opcode == Opcodes.INVOKEINTERFACE)) { + throw new IllegalArgumentException( + "INVOKESPECIAL/STATIC on interfaces require ASM 5"); + } + visitMethodInsn(opcode, owner, name, desc); + return; + } + throw new RuntimeException("Must be overriden"); + } /** * Method instruction. See diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Textifier.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Textifier.java index 3c039ce5e2f..5e20f52c553 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Textifier.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/Textifier.java @@ -172,9 +172,15 @@ public class Textifier extends Printer { * Constructs a new {@link Textifier}. <i>Subclasses must not use this * constructor</i>. Instead, they must use the {@link #Textifier(int)} * version. + * + * @throws IllegalStateException + * If a subclass calls this constructor. */ public Textifier() { this(Opcodes.ASM5); + if (getClass() != Textifier.class) { + throw new IllegalStateException(); + } } /** @@ -821,14 +827,36 @@ public class Textifier extends Printer { text.add(buf.toString()); } + @Deprecated @Override public void visitMethodInsn(final int opcode, final String owner, final String name, final String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, + opcode == Opcodes.INVOKEINTERFACE); + } + + @Override + public void visitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + doVisitMethodInsn(opcode, owner, name, desc, itf); + } + + private void doVisitMethodInsn(final int opcode, final String owner, + final String name, final String desc, final boolean itf) { buf.setLength(0); buf.append(tab2).append(OPCODES[opcode]).append(' '); appendDescriptor(INTERNAL_NAME, owner); buf.append('.').append(name).append(' '); appendDescriptor(METHOD_DESCRIPTOR, desc); + buf.append(' ').append(itf ? "itf" : ""); buf.append('\n'); text.add(buf.toString()); } diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/TraceMethodVisitor.java b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/TraceMethodVisitor.java index bf80e1f38ca..ea679c6a0b9 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/TraceMethodVisitor.java +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/util/TraceMethodVisitor.java @@ -176,11 +176,31 @@ public final class TraceMethodVisitor extends MethodVisitor { super.visitFieldInsn(opcode, owner, name, desc); } + @Deprecated @Override - public void visitMethodInsn(final int opcode, final String owner, - final String name, final String desc) { + public void visitMethodInsn(int opcode, String owner, String name, + String desc) { + if (api >= Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc); + return; + } p.visitMethodInsn(opcode, owner, name, desc); - super.visitMethodInsn(opcode, owner, name, desc); + if (mv != null) { + mv.visitMethodInsn(opcode, owner, name, desc); + } + } + + @Override + public void visitMethodInsn(int opcode, String owner, String name, + String desc, boolean itf) { + if (api < Opcodes.ASM5) { + super.visitMethodInsn(opcode, owner, name, desc, itf); + return; + } + p.visitMethodInsn(opcode, owner, name, desc, itf); + if (mv != null) { + mv.visitMethodInsn(opcode, owner, name, desc, itf); + } } @Override diff --git a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/version.txt b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/version.txt index d795ab2a10b..efe71fa4d26 100644 --- a/jdk/src/share/classes/jdk/internal/org/objectweb/asm/version.txt +++ b/jdk/src/share/classes/jdk/internal/org/objectweb/asm/version.txt @@ -1,12 +1,12 @@ Path: . -Working Copy Root Path: /w/lthudson/hudson-data/jobs/objectweb-cr-pull/workspace/ASM_5_FUTURE -URL: svn://svn.forge.objectweb.org/svnroot/asm/branches/ASM_5_FUTURE +Working Copy Root Path: /hudson/jobs/objectweb-pull/workspace/ASM_5_0_BETA +URL: svn://svn.forge.objectweb.org/svnroot/asm/trunk/asm Repository Root: svn://svn.forge.objectweb.org/svnroot/asm Repository UUID: 271bd773-ee82-43a6-9b2b-1890ed8ce7f9 -Revision: 1681 +Revision: 1700 Node Kind: directory Schedule: normal -Last Changed Author: forax -Last Changed Rev: 1681 -Last Changed Date: 2013-04-01 11:28:58 -0700 (Mon, 01 Apr 2013) +Last Changed Author: ebruneton +Last Changed Rev: 1700 +Last Changed Date: 2013-10-29 20:22:52 +0100 (Tue, 29 Oct 2013) diff --git a/jdk/src/share/classes/sun/awt/AppContext.java b/jdk/src/share/classes/sun/awt/AppContext.java index e0f232e5c0c..fbd4b21d9c3 100644 --- a/jdk/src/share/classes/sun/awt/AppContext.java +++ b/jdk/src/share/classes/sun/awt/AppContext.java @@ -430,7 +430,7 @@ public final class AppContext { try { w.dispose(); } catch (Throwable t) { - log.finer("exception occured while disposing app context", t); + log.finer("exception occurred while disposing app context", t); } } AccessController.doPrivileged(new PrivilegedAction<Void>() { @@ -820,30 +820,6 @@ public final class AppContext { // Set up JavaAWTAccess in SharedSecrets static { sun.misc.SharedSecrets.setJavaAWTAccess(new sun.misc.JavaAWTAccess() { - public Object get(Object key) { - AppContext ac = getAppContext(); - return (ac == null) ? null : ac.get(key); - } - public void put(Object key, Object value) { - AppContext ac = getAppContext(); - if (ac != null) { - ac.put(key, value); - } - } - public void remove(Object key) { - AppContext ac = getAppContext(); - if (ac != null) { - ac.remove(key); - } - } - public boolean isDisposed() { - AppContext ac = getAppContext(); - return (ac == null) ? true : ac.isDisposed(); - } - public boolean isMainAppContext() { - return (numAppContexts.get() == 1 && mainAppContext != null); - } - private boolean hasRootThreadGroup(final AppContext ecx) { return AccessController.doPrivileged(new PrivilegedAction<Boolean>() { @Override diff --git a/jdk/src/share/classes/sun/management/OperatingSystemImpl.java b/jdk/src/share/classes/sun/management/BaseOperatingSystemImpl.java similarity index 93% rename from jdk/src/share/classes/sun/management/OperatingSystemImpl.java rename to jdk/src/share/classes/sun/management/BaseOperatingSystemImpl.java index 7099a3537fc..ac7e10640d6 100644 --- a/jdk/src/share/classes/sun/management/OperatingSystemImpl.java +++ b/jdk/src/share/classes/sun/management/BaseOperatingSystemImpl.java @@ -37,14 +37,14 @@ import sun.misc.Unsafe; * ManagementFactory.getOperatingSystemMXBean() returns an instance * of this class. */ -public class OperatingSystemImpl implements OperatingSystemMXBean { +public class BaseOperatingSystemImpl implements OperatingSystemMXBean { private final VMManagement jvm; /** - * Constructor of OperatingSystemImpl class. + * Constructor of BaseOperatingSystemImpl class. */ - protected OperatingSystemImpl(VMManagement vm) { + protected BaseOperatingSystemImpl(VMManagement vm) { this.jvm = vm; } diff --git a/jdk/src/share/classes/sun/management/ManagementFactoryHelper.java b/jdk/src/share/classes/sun/management/ManagementFactoryHelper.java index 43079e986d6..be82ddae27e 100644 --- a/jdk/src/share/classes/sun/management/ManagementFactoryHelper.java +++ b/jdk/src/share/classes/sun/management/ManagementFactoryHelper.java @@ -46,7 +46,6 @@ import java.util.Collections; import java.util.HashMap; import java.util.List; import com.sun.management.DiagnosticCommandMBean; -import com.sun.management.OSMBeanFactory; import com.sun.management.HotSpotDiagnosticMXBean; import static java.lang.management.ManagementFactory.*; @@ -104,8 +103,7 @@ public class ManagementFactoryHelper { public static synchronized OperatingSystemMXBean getOperatingSystemMXBean() { if (osMBean == null) { - osMBean = (OperatingSystemImpl) - OSMBeanFactory.getOperatingSystemMXBean(jvm); + osMBean = new OperatingSystemImpl(jvm); } return osMBean; } diff --git a/jdk/src/share/classes/sun/management/RuntimeImpl.java b/jdk/src/share/classes/sun/management/RuntimeImpl.java index 2e947cc03a7..c0abdb74442 100644 --- a/jdk/src/share/classes/sun/management/RuntimeImpl.java +++ b/jdk/src/share/classes/sun/management/RuntimeImpl.java @@ -110,12 +110,7 @@ class RuntimeImpl implements RuntimeMXBean { } public long getUptime() { - long current = System.currentTimeMillis(); - - // TODO: If called from client side when we support - // MBean proxy to read performance counters from shared memory, - // need to check if the monitored VM exitd. - return (current - vmStartupTime); + return jvm.getUptime(); } public long getStartTime() { diff --git a/jdk/src/share/classes/sun/management/VMManagement.java b/jdk/src/share/classes/sun/management/VMManagement.java index a02f828ed16..f4445f0225a 100644 --- a/jdk/src/share/classes/sun/management/VMManagement.java +++ b/jdk/src/share/classes/sun/management/VMManagement.java @@ -71,6 +71,7 @@ public interface VMManagement { public String getBootClassPath(); public List<String> getVmArguments(); public long getStartupTime(); + public long getUptime(); public int getAvailableProcessors(); // Compilation Subsystem diff --git a/jdk/src/share/classes/sun/management/VMManagementImpl.java b/jdk/src/share/classes/sun/management/VMManagementImpl.java index 46e0285e622..c5d050542ac 100644 --- a/jdk/src/share/classes/sun/management/VMManagementImpl.java +++ b/jdk/src/share/classes/sun/management/VMManagementImpl.java @@ -179,6 +179,10 @@ class VMManagementImpl implements VMManagement { return result; } + public long getUptime() { + return getUptime0(); + } + private List<String> vmArgs = null; public synchronized List<String> getVmArguments() { if (vmArgs == null) { @@ -192,6 +196,7 @@ class VMManagementImpl implements VMManagement { public native String[] getVmArguments0(); public native long getStartupTime(); + private native long getUptime0(); public native int getAvailableProcessors(); // Compilation Subsystem diff --git a/jdk/src/share/classes/sun/management/snmp/jvminstr/JVM_MANAGEMENT_MIB_IMPL.java b/jdk/src/share/classes/sun/management/snmp/jvminstr/JVM_MANAGEMENT_MIB_IMPL.java index 37837b24db9..3a70921c109 100644 --- a/jdk/src/share/classes/sun/management/snmp/jvminstr/JVM_MANAGEMENT_MIB_IMPL.java +++ b/jdk/src/share/classes/sun/management/snmp/jvminstr/JVM_MANAGEMENT_MIB_IMPL.java @@ -188,7 +188,7 @@ public class JVM_MANAGEMENT_MIB_IMPL extends JVM_MANAGEMENT_MIB { sendTrap(trap, list); }catch(Exception e) { log.error("handleNotification", - "Exception occured : " + e); + "Exception occurred : " + e); } } } @@ -243,7 +243,7 @@ public class JVM_MANAGEMENT_MIB_IMPL extends JVM_MANAGEMENT_MIB { adaptor.snmpV2Trap(peer, trap, list, null); }catch(Exception e) { log.error("sendTrap", - "Exception occured while sending trap to [" + + "Exception occurred while sending trap to [" + target + "]. Exception : " + e); log.debug("sendTrap",e); } diff --git a/jdk/src/share/classes/sun/misc/Cleaner.java b/jdk/src/share/classes/sun/misc/Cleaner.java index f23764e80de..5e92f35d616 100644 --- a/jdk/src/share/classes/sun/misc/Cleaner.java +++ b/jdk/src/share/classes/sun/misc/Cleaner.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -57,14 +57,14 @@ import java.security.PrivilegedAction; */ public class Cleaner - extends PhantomReference + extends PhantomReference<Object> { // Dummy reference queue, needed because the PhantomReference constructor // insists that we pass a queue. Nothing will ever be placed on this queue // since the reference handler invokes cleaners explicitly. // - private static final ReferenceQueue dummyQueue = new ReferenceQueue(); + private static final ReferenceQueue<Object> dummyQueue = new ReferenceQueue<>(); // Doubly-linked list of live cleaners, which prevents the cleaners // themselves from being GC'd before their referents @@ -119,6 +119,7 @@ public class Cleaner /** * Creates a new cleaner. * + * @param ob the referent object to be cleaned * @param thunk * The cleanup code to be run when the cleaner is invoked. The * cleanup code is run directly from the reference-handler thread, diff --git a/jdk/src/share/classes/sun/misc/ExtensionDependency.java b/jdk/src/share/classes/sun/misc/ExtensionDependency.java index 86f4308c9c3..f09b3ac117e 100644 --- a/jdk/src/share/classes/sun/misc/ExtensionDependency.java +++ b/jdk/src/share/classes/sun/misc/ExtensionDependency.java @@ -265,7 +265,7 @@ public class ExtensionDependency { * the jar file. * </p> * - * @param extensionName key in the attibute list + * @param extensionName key in the attribute list * @param attr manifest file attributes * @param file installed extension jar file to compare the requested * extension against. diff --git a/jdk/src/share/classes/sun/misc/JavaAWTAccess.java b/jdk/src/share/classes/sun/misc/JavaAWTAccess.java index e0d3c384584..65f44dbbe68 100644 --- a/jdk/src/share/classes/sun/misc/JavaAWTAccess.java +++ b/jdk/src/share/classes/sun/misc/JavaAWTAccess.java @@ -33,12 +33,4 @@ public interface JavaAWTAccess { // or running in the main app context, returns null. // Otherwise, returns the AppContext of the calling applet. public Object getAppletContext(); - - // convenience methods to cache objects in the current thread group's - // AppContext - public Object get(Object key); - public void put(Object key, Object value); - public void remove(Object key); - public boolean isDisposed(); - public boolean isMainAppContext(); } diff --git a/jdk/src/share/classes/sun/misc/JavaLangAccess.java b/jdk/src/share/classes/sun/misc/JavaLangAccess.java index 77126470586..812f88e2098 100644 --- a/jdk/src/share/classes/sun/misc/JavaLangAccess.java +++ b/jdk/src/share/classes/sun/misc/JavaLangAccess.java @@ -127,4 +127,9 @@ public interface JavaLangAccess { * inherited AccessControlContext. */ Thread newThreadWithAcc(Runnable target, AccessControlContext acc); + + /** + * Invokes the finalize method of the given object. + */ + void invokeFinalize(Object o) throws Throwable; } diff --git a/jdk/src/share/classes/sun/misc/ProxyGenerator.java b/jdk/src/share/classes/sun/misc/ProxyGenerator.java index dd93aa092e0..d561df61d27 100644 --- a/jdk/src/share/classes/sun/misc/ProxyGenerator.java +++ b/jdk/src/share/classes/sun/misc/ProxyGenerator.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -384,7 +384,7 @@ public class ProxyGenerator { private String className; /** proxy interfaces */ - private Class[] interfaces; + private Class<?>[] interfaces; /** proxy class access flags */ private int accessFlags; diff --git a/jdk/src/share/classes/sun/misc/VM.java b/jdk/src/share/classes/sun/misc/VM.java index ef4c54f948b..a464305a201 100644 --- a/jdk/src/share/classes/sun/misc/VM.java +++ b/jdk/src/share/classes/sun/misc/VM.java @@ -148,6 +148,7 @@ public class VM { private static volatile boolean booted = false; + private static final Object lock = new Object(); // Invoked by by System.initializeSystemClass just before returning. // Subsystems that are invoked during initialization can check this @@ -155,13 +156,27 @@ public class VM { // application class loader has been set up. // public static void booted() { - booted = true; + synchronized (lock) { + booted = true; + lock.notifyAll(); + } } public static boolean isBooted() { return booted; } + // Waits until VM completes initialization + // + // This method is invoked by the Finalizer thread + public static void awaitBooted() throws InterruptedException { + synchronized (lock) { + while (!booted) { + lock.wait(); + } + } + } + // A user-settable upper limit on the maximum amount of allocatable direct // buffer memory. This value may be changed during VM initialization if // "java" is launched with "-XX:MaxDirectMemorySize=<size>". diff --git a/jdk/src/share/classes/sun/reflect/NativeConstructorAccessorImpl.java b/jdk/src/share/classes/sun/reflect/NativeConstructorAccessorImpl.java index 4f91ddc4460..d56c3caab08 100644 --- a/jdk/src/share/classes/sun/reflect/NativeConstructorAccessorImpl.java +++ b/jdk/src/share/classes/sun/reflect/NativeConstructorAccessorImpl.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -26,6 +26,7 @@ package sun.reflect; import java.lang.reflect.*; +import sun.reflect.misc.ReflectUtil; /** Used only for the first few invocations of a Constructor; afterward, switches to bytecode-based implementation */ @@ -44,7 +45,11 @@ class NativeConstructorAccessorImpl extends ConstructorAccessorImpl { IllegalArgumentException, InvocationTargetException { - if (++numInvocations > ReflectionFactory.inflationThreshold()) { + // We can't inflate a constructor belonging to a vm-anonymous class + // because that kind of class can't be referred to by name, hence can't + // be found from the generated bytecode. + if (++numInvocations > ReflectionFactory.inflationThreshold() + && !ReflectUtil.isVMAnonymousClass(c.getDeclaringClass())) { ConstructorAccessorImpl acc = (ConstructorAccessorImpl) new MethodAccessorGenerator(). generateConstructor(c.getDeclaringClass(), diff --git a/jdk/src/share/classes/sun/reflect/NativeMethodAccessorImpl.java b/jdk/src/share/classes/sun/reflect/NativeMethodAccessorImpl.java index 93f186b7b49..b1d39e7c965 100644 --- a/jdk/src/share/classes/sun/reflect/NativeMethodAccessorImpl.java +++ b/jdk/src/share/classes/sun/reflect/NativeMethodAccessorImpl.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2001, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -26,6 +26,7 @@ package sun.reflect; import java.lang.reflect.*; +import sun.reflect.misc.ReflectUtil; /** Used only for the first few invocations of a Method; afterward, switches to bytecode-based implementation */ @@ -42,7 +43,11 @@ class NativeMethodAccessorImpl extends MethodAccessorImpl { public Object invoke(Object obj, Object[] args) throws IllegalArgumentException, InvocationTargetException { - if (++numInvocations > ReflectionFactory.inflationThreshold()) { + // We can't inflate methods belonging to vm-anonymous classes because + // that kind of class can't be referred to by name, hence can't be + // found from the generated bytecode. + if (++numInvocations > ReflectionFactory.inflationThreshold() + && !ReflectUtil.isVMAnonymousClass(method.getDeclaringClass())) { MethodAccessorImpl acc = (MethodAccessorImpl) new MethodAccessorGenerator(). generateMethod(method.getDeclaringClass(), diff --git a/jdk/src/share/classes/sun/reflect/ReflectionFactory.java b/jdk/src/share/classes/sun/reflect/ReflectionFactory.java index de97dfc7001..0dbada7d5f3 100644 --- a/jdk/src/share/classes/sun/reflect/ReflectionFactory.java +++ b/jdk/src/share/classes/sun/reflect/ReflectionFactory.java @@ -33,6 +33,7 @@ import java.lang.reflect.Modifier; import java.security.AccessController; import java.security.Permission; import java.security.PrivilegedAction; +import sun.reflect.misc.ReflectUtil; /** <P> The master factory for all reflective objects, both those in java.lang.reflect (Fields, Methods, Constructors) as well as their @@ -144,7 +145,7 @@ public class ReflectionFactory { public MethodAccessor newMethodAccessor(Method method) { checkInitted(); - if (noInflation) { + if (noInflation && !ReflectUtil.isVMAnonymousClass(method.getDeclaringClass())) { return new MethodAccessorGenerator(). generateMethod(method.getDeclaringClass(), method.getName(), @@ -181,7 +182,7 @@ public class ReflectionFactory { return new BootstrapConstructorAccessorImpl(c); } - if (noInflation) { + if (noInflation && !ReflectUtil.isVMAnonymousClass(c.getDeclaringClass())) { return new MethodAccessorGenerator(). generateConstructor(c.getDeclaringClass(), c.getParameterTypes(), diff --git a/jdk/src/share/classes/sun/reflect/annotation/AnnotatedTypeFactory.java b/jdk/src/share/classes/sun/reflect/annotation/AnnotatedTypeFactory.java index 926d6d0fc12..ae32624c071 100644 --- a/jdk/src/share/classes/sun/reflect/annotation/AnnotatedTypeFactory.java +++ b/jdk/src/share/classes/sun/reflect/annotation/AnnotatedTypeFactory.java @@ -34,7 +34,7 @@ import java.util.Map; import static sun.reflect.annotation.TypeAnnotation.*; -public class AnnotatedTypeFactory { +public final class AnnotatedTypeFactory { /** * Create an AnnotatedType. * @@ -47,10 +47,10 @@ public class AnnotatedTypeFactory { * corresponds to */ public static AnnotatedType buildAnnotatedType(Type type, - LocationInfo currentLoc, - TypeAnnotation[] actualTypeAnnos, - TypeAnnotation[] allOnSameTarget, - AnnotatedElement decl) { + LocationInfo currentLoc, + TypeAnnotation[] actualTypeAnnos, + TypeAnnotation[] allOnSameTarget, + AnnotatedElement decl) { if (type == null) { return EMPTY_ANNOTATED_TYPE; } @@ -156,40 +156,40 @@ public class AnnotatedTypeFactory { } @Override - public Annotation[] getDeclaredAnnotations() { + public final Annotation[] getDeclaredAnnotations() { return annotations.values().toArray(new Annotation[0]); } @Override @SuppressWarnings("unchecked") - public <T extends Annotation> T getDeclaredAnnotation(Class<T> annotation) { + public final <T extends Annotation> T getDeclaredAnnotation(Class<T> annotation) { return (T)annotations.get(annotation); } @Override - public <T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotation) { + public final <T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotation) { return AnnotationSupport.getDirectlyAndIndirectlyPresent(annotations, annotation); } // AnnotatedType @Override - public Type getType() { + public final Type getType() { return type; } // Implementation details - LocationInfo getLocation() { + final LocationInfo getLocation() { return location; } - TypeAnnotation[] getTypeAnnotations() { + final TypeAnnotation[] getTypeAnnotations() { return allOnSameTargetTypeAnnotations; } - AnnotatedElement getDecl() { + final AnnotatedElement getDecl() { return decl; } } - private static class AnnotatedArrayTypeImpl extends AnnotatedTypeBaseImpl implements AnnotatedArrayType { + private static final class AnnotatedArrayTypeImpl extends AnnotatedTypeBaseImpl implements AnnotatedArrayType { AnnotatedArrayTypeImpl(Type type, LocationInfo location, TypeAnnotation[] actualTypeAnnotations, TypeAnnotation[] allOnSameTargetTypeAnnotations, AnnotatedElement decl) { @@ -215,7 +215,7 @@ public class AnnotatedTypeFactory { } } - private static class AnnotatedTypeVariableImpl extends AnnotatedTypeBaseImpl implements AnnotatedTypeVariable { + private static final class AnnotatedTypeVariableImpl extends AnnotatedTypeBaseImpl implements AnnotatedTypeVariable { AnnotatedTypeVariableImpl(TypeVariable<?> type, LocationInfo location, TypeAnnotation[] actualTypeAnnotations, TypeAnnotation[] allOnSameTargetTypeAnnotations, AnnotatedElement decl) { @@ -232,7 +232,8 @@ public class AnnotatedTypeFactory { } } - private static class AnnotatedParameterizedTypeImpl extends AnnotatedTypeBaseImpl implements AnnotatedParameterizedType { + private static final class AnnotatedParameterizedTypeImpl extends AnnotatedTypeBaseImpl + implements AnnotatedParameterizedType { AnnotatedParameterizedTypeImpl(ParameterizedType type, LocationInfo location, TypeAnnotation[] actualTypeAnnotations, TypeAnnotation[] allOnSameTargetTypeAnnotations, AnnotatedElement decl) { @@ -265,7 +266,7 @@ public class AnnotatedTypeFactory { } } - private static class AnnotatedWildcardTypeImpl extends AnnotatedTypeBaseImpl implements AnnotatedWildcardType { + private static final class AnnotatedWildcardTypeImpl extends AnnotatedTypeBaseImpl implements AnnotatedWildcardType { private final boolean hasUpperBounds; AnnotatedWildcardTypeImpl(WildcardType type, LocationInfo location, TypeAnnotation[] actualTypeAnnotations, TypeAnnotation[] allOnSameTargetTypeAnnotations, diff --git a/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotation.java b/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotation.java index 1f4b9e71f5e..5c94db4d6d5 100644 --- a/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotation.java +++ b/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotation.java @@ -40,7 +40,7 @@ import java.util.List; * distinguish between '@A Inner.@B Outer' in for example nested types), * target info and the declaration the TypeAnnotaiton was parsed from. */ -public class TypeAnnotation { +public final class TypeAnnotation { private final TypeAnnotationTargetInfo targetInfo; private final LocationInfo loc; private final Annotation annotation; @@ -92,7 +92,8 @@ public class TypeAnnotation { METHOD_FORMAL_PARAMETER, THROWS; } - public static class TypeAnnotationTargetInfo { + + public static final class TypeAnnotationTargetInfo { private final TypeAnnotationTarget target; private final int count; private final int secondaryIndex; @@ -131,7 +132,7 @@ public class TypeAnnotation { } } - public static class LocationInfo { + public static final class LocationInfo { private final int depth; private final Location[] locations; @@ -204,7 +205,7 @@ public class TypeAnnotation { return true; } - public static class Location { + public static final class Location { public final byte tag; public final byte index; diff --git a/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotationParser.java b/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotationParser.java index d716a4734c3..abd28cfafd0 100644 --- a/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotationParser.java +++ b/jdk/src/share/classes/sun/reflect/annotation/TypeAnnotationParser.java @@ -43,7 +43,7 @@ import static sun.reflect.annotation.TypeAnnotation.*; * TypeAnnotationParser implements the logic needed to parse * TypeAnnotations from an array of bytes. */ -public class TypeAnnotationParser { +public final class TypeAnnotationParser { private static final TypeAnnotation[] EMPTY_TYPE_ANNOTATION_ARRAY = new TypeAnnotation[0]; /** @@ -237,7 +237,7 @@ public class TypeAnnotationParser { return parseAnnotatedBounds(bounds, decl, typeVarIndex, LocationInfo.BASE_LOCATION); } //helper for above - static <D extends GenericDeclaration> AnnotatedType[] parseAnnotatedBounds(Type[] bounds, + private static <D extends GenericDeclaration> AnnotatedType[] parseAnnotatedBounds(Type[] bounds, D decl, int typeVarIndex, LocationInfo loc) { diff --git a/jdk/src/share/classes/sun/reflect/generics/reflectiveObjects/ParameterizedTypeImpl.java b/jdk/src/share/classes/sun/reflect/generics/reflectiveObjects/ParameterizedTypeImpl.java index 97524c40a76..7e80afb7282 100644 --- a/jdk/src/share/classes/sun/reflect/generics/reflectiveObjects/ParameterizedTypeImpl.java +++ b/jdk/src/share/classes/sun/reflect/generics/reflectiveObjects/ParameterizedTypeImpl.java @@ -52,7 +52,7 @@ public class ParameterizedTypeImpl implements ParameterizedType { } private void validateConstructorArguments() { - TypeVariable/*<?>*/[] formals = rawType.getTypeParameters(); + TypeVariable<?>[] formals = rawType.getTypeParameters(); // check correct arity of actual type args if (formals.length != actualTypeArguments.length){ throw new MalformedParameterizedTypeException(); diff --git a/jdk/src/share/classes/sun/reflect/generics/repository/GenericDeclRepository.java b/jdk/src/share/classes/sun/reflect/generics/repository/GenericDeclRepository.java index 672cbd89cb4..4eca0a90a58 100644 --- a/jdk/src/share/classes/sun/reflect/generics/repository/GenericDeclRepository.java +++ b/jdk/src/share/classes/sun/reflect/generics/repository/GenericDeclRepository.java @@ -42,7 +42,7 @@ import sun.reflect.generics.visitor.Reifier; public abstract class GenericDeclRepository<S extends Signature> extends AbstractRepository<S> { - private TypeVariable[] typeParams; // caches the formal type parameters + private TypeVariable<?>[] typeParams; // caches the formal type parameters protected GenericDeclRepository(String rawSig, GenericsFactory f) { super(rawSig, f); @@ -64,7 +64,7 @@ public abstract class GenericDeclRepository<S extends Signature> * Return the formal type parameters of this generic declaration. * @return the formal type parameters of this generic declaration */ - public TypeVariable/*<?>*/[] getTypeParameters(){ + public TypeVariable<?>[] getTypeParameters(){ if (typeParams == null) { // lazily initialize type parameters // first, extract type parameter subtree(s) from AST FormalTypeParameter[] ftps = getTree().getFormalTypeParameters(); diff --git a/jdk/src/share/classes/sun/reflect/misc/ReflectUtil.java b/jdk/src/share/classes/sun/reflect/misc/ReflectUtil.java index 1f871e8de02..fb9220894ef 100644 --- a/jdk/src/share/classes/sun/reflect/misc/ReflectUtil.java +++ b/jdk/src/share/classes/sun/reflect/misc/ReflectUtil.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -298,4 +298,13 @@ public final class ReflectUtil { } return false; } + + /** + * Checks if {@code Class cls} is a VM-anonymous class + * as defined by {@link sun.misc.Unsafe#defineAnonymousClass} + * (not to be confused with a Java Language anonymous inner class). + */ + public static boolean isVMAnonymousClass(Class<?> cls) { + return cls.getName().indexOf("/") > -1; + } } diff --git a/jdk/src/share/classes/sun/rmi/rmic/Main.java b/jdk/src/share/classes/sun/rmi/rmic/Main.java index 8e0eb3a9a62..f321a6e6d4c 100644 --- a/jdk/src/share/classes/sun/rmi/rmic/Main.java +++ b/jdk/src/share/classes/sun/rmi/rmic/Main.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1996, 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -494,7 +494,7 @@ public class Main implements sun.rmi.rmic.Constants { extDirsArg); BatchEnvironment result = null; try { - Class[] ctorArgTypes = {OutputStream.class,ClassPath.class,Main.class}; + Class<?>[] ctorArgTypes = {OutputStream.class,ClassPath.class,Main.class}; Object[] ctorArgs = {out,classPath,this}; Constructor<? extends BatchEnvironment> constructor = environmentClass.getConstructor(ctorArgTypes); diff --git a/jdk/src/share/classes/sun/rmi/rmic/RMIGenerator.java b/jdk/src/share/classes/sun/rmi/rmic/RMIGenerator.java index a9649c7fca9..6b997e42647 100644 --- a/jdk/src/share/classes/sun/rmi/rmic/RMIGenerator.java +++ b/jdk/src/share/classes/sun/rmi/rmic/RMIGenerator.java @@ -1132,7 +1132,7 @@ public class RMIGenerator implements RMIConstants, Generator { throws IOException { if (types.length != names.length) { - throw new Error("paramter type and name arrays different sizes"); + throw new Error("parameter type and name arrays different sizes"); } for (int i = 0; i < types.length; i++) { @@ -1213,7 +1213,7 @@ public class RMIGenerator implements RMIConstants, Generator { throws IOException { if (types.length != names.length) { - throw new Error("paramter type and name arrays different sizes"); + throw new Error("parameter type and name arrays different sizes"); } boolean readObject = false; diff --git a/jdk/src/share/classes/sun/rmi/server/LoaderHandler.java b/jdk/src/share/classes/sun/rmi/server/LoaderHandler.java index c35da195ad2..96c692b8ec8 100644 --- a/jdk/src/share/classes/sun/rmi/server/LoaderHandler.java +++ b/jdk/src/share/classes/sun/rmi/server/LoaderHandler.java @@ -692,7 +692,7 @@ public final class LoaderHandler { * Define a proxy class in the given class loader. The proxy * class will implement the given interfaces Classes. */ - private static Class<?> loadProxyClass(ClassLoader loader, Class[] interfaces) + private static Class<?> loadProxyClass(ClassLoader loader, Class<?>[] interfaces) throws ClassNotFoundException { try { @@ -719,7 +719,7 @@ public final class LoaderHandler { */ private static ClassLoader loadProxyInterfaces(String[] interfaces, ClassLoader loader, - Class[] classObjs, + Class<?>[] classObjs, boolean[] nonpublic) throws ClassNotFoundException { diff --git a/jdk/src/share/classes/sun/rmi/server/UnicastServerRef.java b/jdk/src/share/classes/sun/rmi/server/UnicastServerRef.java index 180a6252304..8342c08264a 100644 --- a/jdk/src/share/classes/sun/rmi/server/UnicastServerRef.java +++ b/jdk/src/share/classes/sun/rmi/server/UnicastServerRef.java @@ -299,7 +299,7 @@ public class UnicastServerRef extends UnicastRef logCall(obj, method); // unmarshal parameters - Class[] types = method.getParameterTypes(); + Class<?>[] types = method.getParameterTypes(); Object[] params = new Object[types.length]; try { diff --git a/jdk/src/share/classes/sun/rmi/server/Util.java b/jdk/src/share/classes/sun/rmi/server/Util.java index 0f82a84c9b1..e37bcb9620b 100644 --- a/jdk/src/share/classes/sun/rmi/server/Util.java +++ b/jdk/src/share/classes/sun/rmi/server/Util.java @@ -87,7 +87,7 @@ public final class Util { Collections.synchronizedMap(new WeakHashMap<Class<?>, Void>(11)); /** parameter types for stub constructor */ - private static final Class[] stubConsParamTypes = { RemoteRef.class }; + private static final Class<?>[] stubConsParamTypes = { RemoteRef.class }; private Util() { } @@ -143,7 +143,7 @@ public final class Util { } final ClassLoader loader = implClass.getClassLoader(); - final Class[] interfaces = getRemoteInterfaces(implClass); + final Class<?>[] interfaces = getRemoteInterfaces(implClass); final InvocationHandler handler = new RemoteObjectInvocationHandler(clientRef); diff --git a/jdk/src/share/classes/sun/security/jgss/krb5/InitialToken.java b/jdk/src/share/classes/sun/security/jgss/krb5/InitialToken.java index c15ddd23529..7b34ff83914 100644 --- a/jdk/src/share/classes/sun/security/jgss/krb5/InitialToken.java +++ b/jdk/src/share/classes/sun/security/jgss/krb5/InitialToken.java @@ -192,7 +192,7 @@ abstract class InitialToken extends Krb5Token { if (krbCredMessage.length > 0x0000ffff) throw new GSSException(GSSException.FAILURE, -1, - "Incorrect messsage length"); + "Incorrect message length"); writeLittleEndian(krbCredMessage.length, temp); checksumBytes[pos++] = temp[0]; diff --git a/jdk/src/share/classes/sun/security/jgss/spnego/SpNegoContext.java b/jdk/src/share/classes/sun/security/jgss/spnego/SpNegoContext.java index 0312a1fbf76..1acc3a9a06b 100644 --- a/jdk/src/share/classes/sun/security/jgss/spnego/SpNegoContext.java +++ b/jdk/src/share/classes/sun/security/jgss/spnego/SpNegoContext.java @@ -360,7 +360,7 @@ public class SpNegoContext implements GSSContextSpi { if (internal_mech == null) { // return wth failure throw new GSSException(errorCode, -1, - "supported mechansim from server is null"); + "supported mechanism from server is null"); } // get the negotiated result @@ -911,7 +911,7 @@ public class SpNegoContext implements GSSContextSpi { return mechContext.isEstablished(); } else { if (DEBUG) { - System.out.println("The underlying mechansim context has " + + System.out.println("The underlying mechanism context has " + "not been initialized"); } return false; @@ -1024,7 +1024,7 @@ public class SpNegoContext implements GSSContextSpi { return peerName; } else { if (DEBUG) { - System.out.println("The underlying mechansim context has " + + System.out.println("The underlying mechanism context has " + "not been initialized"); } return null; @@ -1040,7 +1040,7 @@ public class SpNegoContext implements GSSContextSpi { return myName; } else { if (DEBUG) { - System.out.println("The underlying mechansim context has " + + System.out.println("The underlying mechanism context has " + "not been initialized"); } return null; diff --git a/jdk/src/share/classes/sun/security/tools/jarsigner/Main.java b/jdk/src/share/classes/sun/security/tools/jarsigner/Main.java index e0fc5492036..0cc5052a791 100644 --- a/jdk/src/share/classes/sun/security/tools/jarsigner/Main.java +++ b/jdk/src/share/classes/sun/security/tools/jarsigner/Main.java @@ -1781,14 +1781,14 @@ public class Main { try { java.security.cert.Certificate[] cs = null; if (altCertChain != null) { - try { + try (FileInputStream fis = new FileInputStream(altCertChain)) { cs = CertificateFactory.getInstance("X.509"). - generateCertificates(new FileInputStream(altCertChain)). + generateCertificates(fis). toArray(new Certificate[0]); - } catch (CertificateException ex) { - error(rb.getString("Cannot.restore.certchain.from.file.specified")); } catch (FileNotFoundException ex) { error(rb.getString("File.specified.by.certchain.does.not.exist")); + } catch (CertificateException | IOException ex) { + error(rb.getString("Cannot.restore.certchain.from.file.specified")); } } else { try { diff --git a/jdk/src/share/classes/sun/text/resources/sv/FormatData_sv_SE.java b/jdk/src/share/classes/sun/text/resources/sv/FormatData_sv_SE.java index a9a7881a607..f9304122e27 100644 --- a/jdk/src/share/classes/sun/text/resources/sv/FormatData_sv_SE.java +++ b/jdk/src/share/classes/sun/text/resources/sv/FormatData_sv_SE.java @@ -52,7 +52,7 @@ public class FormatData_sv_SE extends ParallelListResourceBundle { new String[] { "#,##0.###;-#,##0.###", // decimal pattern "#,##0.00 \u00A4;-#,##0.00 \u00A4", // currency pattern - "#,##0%" // percent pattern + "#,##0 %" // percent pattern } }, }; diff --git a/jdk/src/share/classes/sun/tools/jinfo/JInfo.java b/jdk/src/share/classes/sun/tools/jinfo/JInfo.java index 001284726ec..07f13b76a30 100644 --- a/jdk/src/share/classes/sun/tools/jinfo/JInfo.java +++ b/jdk/src/share/classes/sun/tools/jinfo/JInfo.java @@ -26,7 +26,6 @@ package sun.tools.jinfo; import java.lang.reflect.Method; -import java.io.File; import java.io.IOException; import java.io.InputStream; @@ -44,7 +43,7 @@ public class JInfo { public static void main(String[] args) throws Exception { if (args.length == 0) { - usage(); // no arguments + usage(1); // no arguments } boolean useSA = true; @@ -56,14 +55,20 @@ public class JInfo { // (<executable> and <code file>). So, total // argument count including option has to 2 or 3. if (args.length != 2 && args.length != 3) { - usage(); + usage(1); } } else if (arg1.equals("-flag")) { // do not use SA, use attach-on-demand useSA = false; } else { // unknown option or -h or -help, print help - usage(); + int exit; + if (arg1.equals("-help") || arg1.equals("-h")) { + exit = 0; + } else { + exit = 1; + } + usage(exit); } } @@ -75,7 +80,13 @@ public class JInfo { String option = args[1]; flag(pid, option); } else { - usage(); + int exit; + if (arg1.equals("-help") || arg1.equals("-h")) { + exit = 0; + } else { + exit = 1; + } + usage(exit); } } } @@ -86,7 +97,7 @@ public class JInfo { // Tool not available on this platform. Class<?> c = loadClass(tool); if (c == null) { - usage(); + usage(1); } // invoke the main method with the arguments @@ -176,39 +187,39 @@ public class JInfo { // print usage message - private static void usage() { + private static void usage(int exit) { Class<?> c = loadClass("sun.jvm.hotspot.tools.JInfo"); boolean usageSA = (c != null); - System.out.println("Usage:"); + System.err.println("Usage:"); if (usageSA) { - System.out.println(" jinfo [option] <pid>"); - System.out.println(" (to connect to running process)"); - System.out.println(" jinfo [option] <executable <core>"); - System.out.println(" (to connect to a core file)"); - System.out.println(" jinfo [option] [server_id@]<remote server IP or hostname>"); - System.out.println(" (to connect to remote debug server)"); - System.out.println(""); - System.out.println("where <option> is one of:"); - System.out.println(" -flag <name> to print the value of the named VM flag"); - System.out.println(" -flag [+|-]<name> to enable or disable the named VM flag"); - System.out.println(" -flag <name>=<value> to set the named VM flag to the given value"); - System.out.println(" -flags to print VM flags"); - System.out.println(" -sysprops to print Java system properties"); - System.out.println(" <no option> to print both of the above"); - System.out.println(" -h | -help to print this help message"); + System.err.println(" jinfo [option] <pid>"); + System.err.println(" (to connect to running process)"); + System.err.println(" jinfo [option] <executable <core>"); + System.err.println(" (to connect to a core file)"); + System.err.println(" jinfo [option] [server_id@]<remote server IP or hostname>"); + System.err.println(" (to connect to remote debug server)"); + System.err.println(""); + System.err.println("where <option> is one of:"); + System.err.println(" -flag <name> to print the value of the named VM flag"); + System.err.println(" -flag [+|-]<name> to enable or disable the named VM flag"); + System.err.println(" -flag <name>=<value> to set the named VM flag to the given value"); + System.err.println(" -flags to print VM flags"); + System.err.println(" -sysprops to print Java system properties"); + System.err.println(" <no option> to print both of the above"); + System.err.println(" -h | -help to print this help message"); } else { - System.out.println(" jinfo <option> <pid>"); - System.out.println(" (to connect to a running process)"); - System.out.println(""); - System.out.println("where <option> is one of:"); - System.out.println(" -flag <name> to print the value of the named VM flag"); - System.out.println(" -flag [+|-]<name> to enable or disable the named VM flag"); - System.out.println(" -flag <name>=<value> to set the named VM flag to the given value"); - System.out.println(" -h | -help to print this help message"); + System.err.println(" jinfo <option> <pid>"); + System.err.println(" (to connect to a running process)"); + System.err.println(""); + System.err.println("where <option> is one of:"); + System.err.println(" -flag <name> to print the value of the named VM flag"); + System.err.println(" -flag [+|-]<name> to enable or disable the named VM flag"); + System.err.println(" -flag <name>=<value> to set the named VM flag to the given value"); + System.err.println(" -h | -help to print this help message"); } - System.exit(1); + System.exit(exit); } } diff --git a/jdk/src/share/classes/sun/tools/jmap/JMap.java b/jdk/src/share/classes/sun/tools/jmap/JMap.java index f8b303528a5..5d349fc0c17 100644 --- a/jdk/src/share/classes/sun/tools/jmap/JMap.java +++ b/jdk/src/share/classes/sun/tools/jmap/JMap.java @@ -60,7 +60,7 @@ public class JMap { public static void main(String[] args) throws Exception { if (args.length == 0) { - usage(); // no arguments + usage(1); // no arguments } // used to indicate if we should use SA @@ -77,11 +77,13 @@ public class JMap { if (!arg.startsWith("-")) { break; } - if (arg.equals(FORCE_SA_OPTION)) { + if (arg.equals("-help") || arg.equals("-h")) { + usage(0); + } else if (arg.equals(FORCE_SA_OPTION)) { useSA = true; } else { if (option != null) { - usage(); // option already specified + usage(1); // option already specified } option = arg; } @@ -101,7 +103,7 @@ public class JMap { // only one parameter (the process-id) int paramCount = args.length - optionCount; if (paramCount == 0 || paramCount > 2) { - usage(); + usage(1); } if (optionCount == 0 || paramCount != 1) { @@ -139,7 +141,7 @@ public class JMap { } else if (option.startsWith(DUMP_OPTION_PREFIX)) { dump(pid, option); } else { - usage(); + usage(1); } } } @@ -161,7 +163,9 @@ public class JMap { if (option.startsWith(DUMP_OPTION_PREFIX)) { // first check that the option can be parsed String fn = parseDumpOptions(option); - if (fn == null) usage(); + if (fn == null) { + usage(1); + } // tool for heap dumping tool = "sun.jvm.hotspot.tools.HeapDumper"; @@ -180,13 +184,13 @@ public class JMap { } } if (tool == null) { - usage(); // no mapping to tool + usage(1); // no mapping to tool } // Tool not available on this platform. Class<?> c = loadClass(tool); if (c == null) { - usage(); + usage(1); } // invoke the main method with the arguments @@ -225,7 +229,7 @@ public class JMap { // parse the options to get the dump filename String filename = parseDumpOptions(options); if (filename == null) { - usage(); // invalid options or no filename + usage(1); // invalid options or no filename } // get the canonical path - important to avoid just passing @@ -341,49 +345,49 @@ public class JMap { } // print usage message - private static void usage() { - System.out.println("Usage:"); + private static void usage(int exit) { + System.err.println("Usage:"); if (haveSA()) { - System.out.println(" jmap [option] <pid>"); - System.out.println(" (to connect to running process)"); - System.out.println(" jmap [option] <executable <core>"); - System.out.println(" (to connect to a core file)"); - System.out.println(" jmap [option] [server_id@]<remote server IP or hostname>"); - System.out.println(" (to connect to remote debug server)"); - System.out.println(""); - System.out.println("where <option> is one of:"); - System.out.println(" <none> to print same info as Solaris pmap"); - System.out.println(" -heap to print java heap summary"); - System.out.println(" -histo[:live] to print histogram of java object heap; if the \"live\""); - System.out.println(" suboption is specified, only count live objects"); - System.out.println(" -clstats to print class loader statistics"); - System.out.println(" -finalizerinfo to print information on objects awaiting finalization"); - System.out.println(" -dump:<dump-options> to dump java heap in hprof binary format"); - System.out.println(" dump-options:"); - System.out.println(" live dump only live objects; if not specified,"); - System.out.println(" all objects in the heap are dumped."); - System.out.println(" format=b binary format"); - System.out.println(" file=<file> dump heap to <file>"); - System.out.println(" Example: jmap -dump:live,format=b,file=heap.bin <pid>"); - System.out.println(" -F force. Use with -dump:<dump-options> <pid> or -histo"); - System.out.println(" to force a heap dump or histogram when <pid> does not"); - System.out.println(" respond. The \"live\" suboption is not supported"); - System.out.println(" in this mode."); - System.out.println(" -h | -help to print this help message"); - System.out.println(" -J<flag> to pass <flag> directly to the runtime system"); + System.err.println(" jmap [option] <pid>"); + System.err.println(" (to connect to running process)"); + System.err.println(" jmap [option] <executable <core>"); + System.err.println(" (to connect to a core file)"); + System.err.println(" jmap [option] [server_id@]<remote server IP or hostname>"); + System.err.println(" (to connect to remote debug server)"); + System.err.println(""); + System.err.println("where <option> is one of:"); + System.err.println(" <none> to print same info as Solaris pmap"); + System.err.println(" -heap to print java heap summary"); + System.err.println(" -histo[:live] to print histogram of java object heap; if the \"live\""); + System.err.println(" suboption is specified, only count live objects"); + System.err.println(" -clstats to print class loader statistics"); + System.err.println(" -finalizerinfo to print information on objects awaiting finalization"); + System.err.println(" -dump:<dump-options> to dump java heap in hprof binary format"); + System.err.println(" dump-options:"); + System.err.println(" live dump only live objects; if not specified,"); + System.err.println(" all objects in the heap are dumped."); + System.err.println(" format=b binary format"); + System.err.println(" file=<file> dump heap to <file>"); + System.err.println(" Example: jmap -dump:live,format=b,file=heap.bin <pid>"); + System.err.println(" -F force. Use with -dump:<dump-options> <pid> or -histo"); + System.err.println(" to force a heap dump or histogram when <pid> does not"); + System.err.println(" respond. The \"live\" suboption is not supported"); + System.err.println(" in this mode."); + System.err.println(" -h | -help to print this help message"); + System.err.println(" -J<flag> to pass <flag> directly to the runtime system"); } else { - System.out.println(" jmap -histo <pid>"); - System.out.println(" (to connect to running process and print histogram of java object heap"); - System.out.println(" jmap -dump:<dump-options> <pid>"); - System.out.println(" (to connect to running process and dump java heap)"); - System.out.println(""); - System.out.println(" dump-options:"); - System.out.println(" format=b binary default"); - System.out.println(" file=<file> dump heap to <file>"); - System.out.println(""); - System.out.println(" Example: jmap -dump:format=b,file=heap.bin <pid>"); + System.err.println(" jmap -histo <pid>"); + System.err.println(" (to connect to running process and print histogram of java object heap"); + System.err.println(" jmap -dump:<dump-options> <pid>"); + System.err.println(" (to connect to running process and dump java heap)"); + System.err.println(""); + System.err.println(" dump-options:"); + System.err.println(" format=b binary default"); + System.err.println(" file=<file> dump heap to <file>"); + System.err.println(""); + System.err.println(" Example: jmap -dump:format=b,file=heap.bin <pid>"); } - System.exit(1); + System.exit(exit); } } diff --git a/jdk/src/share/classes/sun/tools/jps/Jps.java b/jdk/src/share/classes/sun/tools/jps/Jps.java index 9c653816b30..75f2dc139b8 100644 --- a/jdk/src/share/classes/sun/tools/jps/Jps.java +++ b/jdk/src/share/classes/sun/tools/jps/Jps.java @@ -45,11 +45,11 @@ public class Jps { } catch (IllegalArgumentException e) { System.err.println(e.getMessage()); Arguments.printUsage(System.err); - return; + System.exit(1); } if (arguments.isHelp()) { - Arguments.printUsage(System.out); + Arguments.printUsage(System.err); System.exit(0); } @@ -165,6 +165,7 @@ public class Jps { e.printStackTrace(); } } + System.exit(1); } } } diff --git a/jdk/src/share/classes/sun/tools/jstack/JStack.java b/jdk/src/share/classes/sun/tools/jstack/JStack.java index e638446b4f1..6807f66580b 100644 --- a/jdk/src/share/classes/sun/tools/jstack/JStack.java +++ b/jdk/src/share/classes/sun/tools/jstack/JStack.java @@ -42,7 +42,7 @@ import sun.tools.attach.HotSpotVirtualMachine; public class JStack { public static void main(String[] args) throws Exception { if (args.length == 0) { - usage(); // no arguments + usage(1); // no arguments } boolean useSA = false; @@ -56,16 +56,20 @@ public class JStack { if (!arg.startsWith("-")) { break; } - if (arg.equals("-F")) { + if (arg.equals("-help") || arg.equals("-h")) { + usage(0); + } + else if (arg.equals("-F")) { useSA = true; - } else { + } + else { if (arg.equals("-m")) { mixed = true; } else { if (arg.equals("-l")) { locks = true; } else { - usage(); + usage(1); } } } @@ -81,7 +85,7 @@ public class JStack { // we assume core file and executable so we use SA. int paramCount = args.length - optionCount; if (paramCount == 0 || paramCount > 2) { - usage(); + usage(1); } if (paramCount == 2) { useSA = true; @@ -118,7 +122,7 @@ public class JStack { private static void runJStackTool(boolean mixed, boolean locks, String args[]) throws Exception { Class<?> cl = loadSAClass(); if (cl == null) { - usage(); // SA not available + usage(1); // SA not available } // JStack tool also takes -m and -l arguments @@ -199,31 +203,31 @@ public class JStack { } // print usage message - private static void usage() { - System.out.println("Usage:"); - System.out.println(" jstack [-l] <pid>"); - System.out.println(" (to connect to running process)"); + private static void usage(int exit) { + System.err.println("Usage:"); + System.err.println(" jstack [-l] <pid>"); + System.err.println(" (to connect to running process)"); if (loadSAClass() != null) { - System.out.println(" jstack -F [-m] [-l] <pid>"); - System.out.println(" (to connect to a hung process)"); - System.out.println(" jstack [-m] [-l] <executable> <core>"); - System.out.println(" (to connect to a core file)"); - System.out.println(" jstack [-m] [-l] [server_id@]<remote server IP or hostname>"); - System.out.println(" (to connect to a remote debug server)"); + System.err.println(" jstack -F [-m] [-l] <pid>"); + System.err.println(" (to connect to a hung process)"); + System.err.println(" jstack [-m] [-l] <executable> <core>"); + System.err.println(" (to connect to a core file)"); + System.err.println(" jstack [-m] [-l] [server_id@]<remote server IP or hostname>"); + System.err.println(" (to connect to a remote debug server)"); } - System.out.println(""); - System.out.println("Options:"); + System.err.println(""); + System.err.println("Options:"); if (loadSAClass() != null) { - System.out.println(" -F to force a thread dump. Use when jstack <pid> does not respond" + + System.err.println(" -F to force a thread dump. Use when jstack <pid> does not respond" + " (process is hung)"); - System.out.println(" -m to print both java and native frames (mixed mode)"); + System.err.println(" -m to print both java and native frames (mixed mode)"); } - System.out.println(" -l long listing. Prints additional information about locks"); - System.out.println(" -h or -help to print this help message"); - System.exit(1); + System.err.println(" -l long listing. Prints additional information about locks"); + System.err.println(" -h or -help to print this help message"); + System.exit(exit); } } diff --git a/jdk/src/share/classes/sun/tools/serialver/SerialVer.java b/jdk/src/share/classes/sun/tools/serialver/SerialVer.java index b2a2de60bcf..a02a897437b 100644 --- a/jdk/src/share/classes/sun/tools/serialver/SerialVer.java +++ b/jdk/src/share/classes/sun/tools/serialver/SerialVer.java @@ -211,7 +211,7 @@ public class SerialVer extends Applet { Class<?> cl = Class.forName(classname, false, loader); ObjectStreamClass desc = ObjectStreamClass.lookup(cl); if (desc != null) { - return " static final long serialVersionUID = " + + return " private static final long serialVersionUID = " + desc.getSerialVersionUID() + "L;"; } else { return null; diff --git a/jdk/src/share/demo/jfc/FileChooserDemo/FileChooserDemo.java b/jdk/src/share/demo/jfc/FileChooserDemo/FileChooserDemo.java index e492e09e032..24c5533f9a1 100644 --- a/jdk/src/share/demo/jfc/FileChooserDemo/FileChooserDemo.java +++ b/jdk/src/share/demo/jfc/FileChooserDemo/FileChooserDemo.java @@ -450,9 +450,9 @@ public class FileChooserDemo extends JPanel implements ActionListener { "User cancelled operation. No file was chosen."); } else if (retval == ERROR_OPTION) { JOptionPane.showMessageDialog(frame, - "An error occured. No file was chosen."); + "An error occurred. No file was chosen."); } else { - JOptionPane.showMessageDialog(frame, "Unknown operation occured."); + JOptionPane.showMessageDialog(frame, "Unknown operation occurred."); } } diff --git a/jdk/src/share/demo/jvmti/java_crw_demo/java_crw_demo.c b/jdk/src/share/demo/jvmti/java_crw_demo/java_crw_demo.c index cd6d1040f50..73413fd4fa6 100644 --- a/jdk/src/share/demo/jvmti/java_crw_demo/java_crw_demo.c +++ b/jdk/src/share/demo/jvmti/java_crw_demo/java_crw_demo.c @@ -263,8 +263,8 @@ fatal_error(CrwClassImage *ci, const char *message, const char *file, int line) /* Normal operation should NEVER reach here */ /* NO CRW FATAL ERROR HANDLER! */ (void)fprintf(stderr, "CRW: %s [%s:%d]\n", message, file, line); - abort(); } + abort(); } #if defined(DEBUG) || !defined(NDEBUG) diff --git a/jdk/src/share/javavm/export/jmm.h b/jdk/src/share/javavm/export/jmm.h index e017e5a02c7..3f938e25055 100644 --- a/jdk/src/share/javavm/export/jmm.h +++ b/jdk/src/share/javavm/export/jmm.h @@ -78,6 +78,7 @@ typedef enum { JMM_COMPILE_TOTAL_TIME_MS = 8, /* Total accumulated time spent in compilation */ JMM_GC_TIME_MS = 9, /* Total accumulated time spent in collection */ JMM_GC_COUNT = 10, /* Total number of collections */ + JMM_JVM_UPTIME_MS = 11, /* The JVM uptime in milliseconds */ JMM_INTERNAL_ATTRIBUTE_INDEX = 100, JMM_CLASS_LOADED_BYTES = 101, /* Number of bytes loaded instance classes */ diff --git a/jdk/src/share/native/java/net/Inet4Address.c b/jdk/src/share/native/java/net/Inet4Address.c index 20304712270..b2f25416133 100644 --- a/jdk/src/share/native/java/net/Inet4Address.c +++ b/jdk/src/share/native/java/net/Inet4Address.c @@ -46,5 +46,4 @@ Java_java_net_Inet4Address_init(JNIEnv *env, jclass cls) { ia4_class = (*env)->NewGlobalRef(env, c); CHECK_NULL(ia4_class); ia4_ctrID = (*env)->GetMethodID(env, ia4_class, "<init>", "()V"); - CHECK_NULL(ia4_ctrID); } diff --git a/jdk/src/share/native/java/net/Inet6Address.c b/jdk/src/share/native/java/net/Inet6Address.c index 54c41497f48..729fe78281d 100644 --- a/jdk/src/share/native/java/net/Inet6Address.c +++ b/jdk/src/share/native/java/net/Inet6Address.c @@ -65,9 +65,8 @@ Java_java_net_Inet6Address_init(JNIEnv *env, jclass cls) { ia6_cachedscopeidID = (*env)->GetFieldID(env, ia6_class, "cached_scope_id", "I"); CHECK_NULL(ia6_cachedscopeidID); ia6_scopeidsetID = (*env)->GetFieldID(env, ia6h_class, "scope_id_set", "Z"); - CHECK_NULL(ia6_scopeidID); + CHECK_NULL(ia6_scopeidsetID); ia6_scopeifnameID = (*env)->GetFieldID(env, ia6h_class, "scope_ifname", "Ljava/net/NetworkInterface;"); CHECK_NULL(ia6_scopeifnameID); ia6_ctrID = (*env)->GetMethodID(env, ia6_class, "<init>", "()V"); - CHECK_NULL(ia6_ctrID); } diff --git a/jdk/src/share/native/java/net/InetAddress.c b/jdk/src/share/native/java/net/InetAddress.c index 31115739b7e..e9fd0979cb8 100644 --- a/jdk/src/share/native/java/net/InetAddress.c +++ b/jdk/src/share/native/java/net/InetAddress.c @@ -64,5 +64,4 @@ Java_java_net_InetAddress_init(JNIEnv *env, jclass cls) { iac_familyID = (*env)->GetFieldID(env, iac_class, "family", "I"); CHECK_NULL(iac_familyID); iac_hostNameID = (*env)->GetFieldID(env, iac_class, "hostName", "Ljava/lang/String;"); - CHECK_NULL(iac_hostNameID); } diff --git a/jdk/src/share/native/sun/java2d/cmm/lcms/cmsio0.c b/jdk/src/share/native/sun/java2d/cmm/lcms/cmsio0.c index 82b9a6e6db4..80104145454 100644 --- a/jdk/src/share/native/sun/java2d/cmm/lcms/cmsio0.c +++ b/jdk/src/share/native/sun/java2d/cmm/lcms/cmsio0.c @@ -1077,7 +1077,13 @@ cmsHPROFILE CMSEXPORT cmsOpenProfileFromMem(const void* MemPtr, cmsUInt32Number static cmsBool SanityCheck(_cmsICCPROFILE* profile) { - cmsIOHANDLER* io = profile->IOhandler; + cmsIOHANDLER* io; + + if (!profile) { + return FALSE; + } + + io = profile->IOhandler; if (!io) { return FALSE; } @@ -1108,8 +1114,6 @@ cmsBool SaveTags(_cmsICCPROFILE* Icc, _cmsICCPROFILE* FileOrig) cmsTagTypeSignature TypeBase; cmsTagTypeHandler* TypeHandler; - if (!SanityCheck(FileOrig)) return FALSE; - for (i=0; i < Icc -> TagCount; i++) { @@ -1126,7 +1130,7 @@ cmsBool SaveTags(_cmsICCPROFILE* Icc, _cmsICCPROFILE* FileOrig) // Reach here if we are copying a tag from a disk-based ICC profile which has not been modified by user. // In this case a blind copy of the block data is performed - if (FileOrig != NULL && Icc -> TagOffsets[i]) { + if (SanityCheck(FileOrig) && Icc -> TagOffsets[i]) { cmsUInt32Number TagSize = FileOrig -> TagSizes[i]; cmsUInt32Number TagOffset = FileOrig -> TagOffsets[i]; diff --git a/jdk/src/share/native/sun/management/VMManagementImpl.c b/jdk/src/share/native/sun/management/VMManagementImpl.c index 27784e5dd62..1aa09d2c41e 100644 --- a/jdk/src/share/native/sun/management/VMManagementImpl.c +++ b/jdk/src/share/native/sun/management/VMManagementImpl.c @@ -200,6 +200,13 @@ Java_sun_management_VMManagementImpl_getStartupTime JMM_JVM_INIT_DONE_TIME_MS); } +JNIEXPORT jlong JNICALL +Java_sun_management_VMManagementImpl_getUptime0 + (JNIEnv *env, jobject dummy) +{ + return jmm_interface->GetLongAttribute(env, NULL, JMM_JVM_UPTIME_MS); +} + JNIEXPORT jboolean JNICALL Java_sun_management_VMManagementImpl_isThreadContentionMonitoringEnabled (JNIEnv *env, jobject dummy) diff --git a/jdk/src/share/native/sun/security/pkcs11/wrapper/p11_util.c b/jdk/src/share/native/sun/security/pkcs11/wrapper/p11_util.c index 8889f740d0e..79d5250390d 100644 --- a/jdk/src/share/native/sun/security/pkcs11/wrapper/p11_util.c +++ b/jdk/src/share/native/sun/security/pkcs11/wrapper/p11_util.c @@ -598,16 +598,16 @@ void jAttributeArrayToCKAttributeArray(JNIEnv *env, jobjectArray jArray, CK_ATTR throwOutOfMemoryError(env, 0); return; } - TRACE1(", converting %d attibutes", jLength); + TRACE1(", converting %d attributes", jLength); for (i=0; i<(*ckpLength); i++) { - TRACE1(", getting %d. attibute", i); + TRACE1(", getting %d. attribute", i); jAttribute = (*env)->GetObjectArrayElement(env, jArray, i); if ((*env)->ExceptionCheck(env)) { freeCKAttributeArray(*ckpArray, i); return; } TRACE1(", jAttribute = %d", jAttribute); - TRACE1(", converting %d. attibute", i); + TRACE1(", converting %d. attribute", i); (*ckpArray)[i] = jAttributeToCKAttribute(env, jAttribute); if ((*env)->ExceptionCheck(env)) { freeCKAttributeArray(*ckpArray, i); diff --git a/jdk/src/share/sample/nio/chatserver/ClientReader.java b/jdk/src/share/sample/nio/chatserver/ClientReader.java index de7f639e81b..822125a946c 100644 --- a/jdk/src/share/sample/nio/chatserver/ClientReader.java +++ b/jdk/src/share/sample/nio/chatserver/ClientReader.java @@ -58,7 +58,7 @@ class ClientReader { } /** - * Runs a cycle of doing a beforeRead action and then inquiring a new + * Runs a cycle of doing a beforeRead action and then enqueuing a new * read on the client. Handles closed channels and errors while reading. * If the client is still connected a new round of actions are called. */ diff --git a/jdk/src/solaris/classes/com/sun/management/OSMBeanFactory.java b/jdk/src/solaris/classes/com/sun/management/OSMBeanFactory.java deleted file mode 100644 index cbd9aa207d3..00000000000 --- a/jdk/src/solaris/classes/com/sun/management/OSMBeanFactory.java +++ /dev/null @@ -1,53 +0,0 @@ -/* - * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved. - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * This code is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. - * - * This code is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - * version 2 for more details (a copy is included in the LICENSE file that - * accompanied this code). - * - * You should have received a copy of the GNU General Public License version - * 2 along with this work; if not, write to the Free Software Foundation, - * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. - * - * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA - * or visit www.oracle.com if you need additional information or have any - * questions. - */ - -package com.sun.management; - -import java.lang.management.OperatingSystemMXBean; -import sun.management.VMManagement; - -/** - * Operating system dependent MBean factory. - * <p> - * <b>WARNING:</b> While this class is public, it should not be treated as - * public API and its API may change in incompatable ways between dot dot - * releases and even patch releases. You should not rely on this class. - */ -@jdk.Exported(false) -public class OSMBeanFactory { - /* static factory class */ - private OSMBeanFactory() {}; - - private static UnixOperatingSystem osMBean = null; - - public static synchronized OperatingSystemMXBean - getOperatingSystemMXBean(VMManagement jvm) { - - if (osMBean == null) { - osMBean = new UnixOperatingSystem(jvm); - } - return (OperatingSystemMXBean) osMBean; - } -} diff --git a/jdk/src/solaris/classes/sun/awt/X11/XDecoratedPeer.java b/jdk/src/solaris/classes/sun/awt/X11/XDecoratedPeer.java index e61273dc4d4..912a951f374 100644 --- a/jdk/src/solaris/classes/sun/awt/X11/XDecoratedPeer.java +++ b/jdk/src/solaris/classes/sun/awt/X11/XDecoratedPeer.java @@ -1173,7 +1173,7 @@ abstract class XDecoratedPeer extends XWindowPeer { } if (target == activeWindow && target != focusedWindow) { // Happens when an owned window is currently focused - focusLog.fine("Focus is on child window - transfering it back to the owner"); + focusLog.fine("Focus is on child window - transferring it back to the owner"); handleWindowFocusInSync(-1); return true; } diff --git a/jdk/src/solaris/classes/com/sun/management/UnixOperatingSystem.java b/jdk/src/solaris/classes/sun/management/OperatingSystemImpl.java similarity index 89% rename from jdk/src/solaris/classes/com/sun/management/UnixOperatingSystem.java rename to jdk/src/solaris/classes/sun/management/OperatingSystemImpl.java index d80779cf46f..666840f247d 100644 --- a/jdk/src/solaris/classes/com/sun/management/UnixOperatingSystem.java +++ b/jdk/src/solaris/classes/sun/management/OperatingSystemImpl.java @@ -23,9 +23,7 @@ * questions. */ -package com.sun.management; - -import sun.management.VMManagement; +package sun.management; /** * Implementation class for the operating system. @@ -34,11 +32,10 @@ import sun.management.VMManagement; * ManagementFactory.getOperatingSystemMXBean() returns an instance * of this class. */ -class UnixOperatingSystem - extends sun.management.OperatingSystemImpl - implements UnixOperatingSystemMXBean { +class OperatingSystemImpl extends BaseOperatingSystemImpl + implements com.sun.management.UnixOperatingSystemMXBean { - UnixOperatingSystem(VMManagement vm) { + OperatingSystemImpl(VMManagement vm) { super(vm); } diff --git a/jdk/src/solaris/classes/sun/nio/fs/UnixFileSystemProvider.java b/jdk/src/solaris/classes/sun/nio/fs/UnixFileSystemProvider.java index 553c4b2e8c8..bd8253e94e5 100644 --- a/jdk/src/solaris/classes/sun/nio/fs/UnixFileSystemProvider.java +++ b/jdk/src/solaris/classes/sun/nio/fs/UnixFileSystemProvider.java @@ -484,7 +484,7 @@ public abstract class UnixFileSystemProvider if (sm != null) { FilePermission perm = new FilePermission(link.getPathForPermissionCheck(), SecurityConstants.FILE_READLINK_ACTION); - AccessController.checkPermission(perm); + sm.checkPermission(perm); } try { byte[] target = readlink(link); diff --git a/jdk/src/solaris/classes/sun/nio/fs/UnixPath.java b/jdk/src/solaris/classes/sun/nio/fs/UnixPath.java index 0d358f2a541..f4a06420cad 100644 --- a/jdk/src/solaris/classes/sun/nio/fs/UnixPath.java +++ b/jdk/src/solaris/classes/sun/nio/fs/UnixPath.java @@ -145,7 +145,7 @@ class UnixPath } if (error) { throw new InvalidPathException(input, - "Malformed input or input contains unmappable chacraters"); + "Malformed input or input contains unmappable characters"); } // trim result to actual length if required diff --git a/jdk/src/solaris/doc/sun/man/man1/appletviewer.1 b/jdk/src/solaris/doc/sun/man/man1/appletviewer.1 index 887abbd66e3..71ccac3c664 100644 --- a/jdk/src/solaris/doc/sun/man/man1/appletviewer.1 +++ b/jdk/src/solaris/doc/sun/man/man1/appletviewer.1 @@ -1,66 +1,90 @@ -." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH appletviewer 1 "10 May 2011" +'\" t +.\" Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: appletviewer.1 +.\" +.if n .pl 99999 +.TH appletviewer 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -appletviewer \- The Java Applet Viewer. -.LP -.LP -The \f3appletviewer\fP command allows you to run applets outside of a web browser. -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4appletviewer\fP \f2[\fP \f2options\fP \f2] \fP\f2urls\fP ... -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3appletviewer\fP command connects to the documents or resources designated by \f2urls\fP and displays each applet referenced by the documents in its own window. Note: if the documents referred to by \f2urls\fP do not reference any applets with the \f2OBJECT\fP, \f2EMBED\fP, or \f2APPLET\fP tag, then \f3appletviewer\fP does nothing. For details on the HTML tags that \f3appletviewer\fP supports, see -.na -\f2AppletViewer Tags\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/appletviewertags.html. -.LP -.LP -\f3Note:\fP The \f3appletviewer\fP requires encoded URLs according to the escaping mechanism defined in RFC2396. Only encoded URLs are supported. However, file names must be unencoded, as specified in RFC2396. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-debug -Starts the applet viewer in the Java debugger, jdb(1), thus allowing you to debug the applets in the document. -.TP 3 -\-encoding \ \ encoding name -Specify the input HTML file encoding name. -.TP 3 -\-Jjavaoption -Passes through the string \f2javaoption\fP as a single argument to the Java interpreter which runs the appletviewer. The argument should not contain spaces. Multiple argument words must all begin with the prefix \f3\-J\fP, which is stripped. This is useful for adjusting the compiler's execution environment or memory usage. -.RE +.SH NAME +appletviewer \- Runs applets outside of a web browser\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP - -.LP - +\fBappletviewer\fR [\fIoptions\fR] \fIurl\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options separated by spaces\&. See Options\&. +.TP +\fIurl\fR +The location of the documents or resources to be displayed\&. You can specify multiple URLs separated by spaces\&. +.SH DESCRIPTION +The \f3appletviewer\fR command connects to the documents or resources designated by \fIurls\fR and displays each applet referenced by the documents in its own window\&. If the documents referred to by urls do not reference any applets with the \f3OBJECT\fR, \f3EMBED\fR, or \f3APPLET\fR tag, then the \f3appletviewer\fR command does nothing\&. For details about the HTML tags that the \f3appletviewer\fR command supports, see AppletViewer Tags at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/appletviewertags\&.html +.PP +The \f3appletviewer\fR command requires encoded URLs according to the escaping mechanism defined in RFC2396\&. Only encoded URLs are supported\&. However, file names must be unencoded, as specified in RFC2396\&. +.PP +\fINote:\fR The \f3appletviewer\fR command is intended for development purposes only\&. For more information, see About Sample/Test Applications and Code at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/aboutCodeSamples\&.html +.SH OPTIONS +.TP +-debug +.br +Starts the Applet Viewer in the Java debugger with the \f3jdb\fR command to debug the applets in the document\&. +.TP +-encoding \fIencoding-name\fR +.br +Specifies the input HTML file encoding name\&. +.TP +-J\fIjavaoption\fR +.br +Passes the string \f3javaoption\fR as a single argument to the Java interpreter, which runs the Applet Viewer\&. The argument should not contain spaces\&. Multiple argument words must all begin with the prefix \f3-J\fR\&. This is useful for adjusting the compiler\&'s execution environment or memory usage\&. +.PP +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/extcheck.1 b/jdk/src/solaris/doc/sun/man/man1/extcheck.1 index 9dfe6472adf..09599d3aa02 100644 --- a/jdk/src/solaris/doc/sun/man/man1/extcheck.1 +++ b/jdk/src/solaris/doc/sun/man/man1/extcheck.1 @@ -1,73 +1,91 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH extcheck 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: extcheck.1 +.\" +.if n .pl 99999 +.TH extcheck 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -extcheck \- A utility to detect jar conflicts -.LP -.LP -\f3extcheck\fP detects version conflicts between a target jar file and currently installed extension jar files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -extcheck [ \-verbose ] targetfile.jar -.fl -\fP -.fi +.SH NAME +extcheck \- Detects version conflicts between a target Java Archive (JAR) file and currently installed extension JAR files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3extcheck\fP utility checks a specified Jar file for title and version conflicts with any extensions installed in the Java(TM) SDK. Before installing an extension, you can use this utility to see if the same or a more recent version of the extension is already installed. -.LP -.LP -The \f3extcheck\fP utility compares the \f2Specification\-title\fP and \f2Specification\-version\fP headers in the manifest of the \f2targetfile.jar\fP file against the corresponding headers in all Jar files currently installed in the extension directory. (The extension directory is \f2jre/lib/ext\fP by default.) The \f3extcheck\fP utility compares version numbers in the same way as the method \f2java.lang.Package.isCompatibleWith\fP. -.LP -.LP -If no conflict is detected, the return code is \f20\fP. -.LP -.LP -If the manifest of any jar file in the extensions directory has the same \f2Specification\-title\fP and the same or a newer \f2Specification\-version\fP number, a non\-zero error code is returned. A non\-zero error code is also returned if \f2targetfile.jar\fP does not have the \f2Specification\-title\fP or \f2Specification\-version\fP attributes in its manifest. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-verbose -Lists Jar files in the extension directory as they are checked. Additionally, manifest attributes of the target jar file and any conflicting jar files are also reported. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP +\fBextcheck\fR [\fIoptions\fR] \fItargetfile\&.jar\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fItargetfile\&.jar\fR +The target JAR file against which the currently installed extension JAR files are compared to detect version conflicts\&. +.SH DESCRIPTION +The \f3extcheck\fR command checks a specified JAR file for title and version conflicts with any extensions installed in the Java SE SDK\&. Before installing an extension, you can use this utility to see whether the same or a more recent version of the extension is already installed\&. +.PP +The \f3extcheck\fR command compares the Specification-title and Specification-version headers in the manifest of the \f3targetfile\&.jar\fR file against the corresponding headers in all JAR files currently installed in the extension directory\&. By default, the extension directory is \f3jre/lib/ext\fR on Oracle Solaris and \f3\ejre\elib\eext\fR on Windows\&. The \f3extcheck\fR command compares version numbers in the same way as the \f3java\&.lang\&.Package\&.isCompatibleWith\fR method\&. +.PP +If no conflict is detected, then the return code is 0\&. +.PP +If the manifest of any JAR file in the extensions directory has the same \f3Specification-title\fR and the same or a newer \f3Specification-version\fR number, then a non-zero error code is returned\&. A non-zero error code is also returned when \f3targetfile\&.jar\fR does not have the \f3Specification-title\fR or \f3Specification-version\fR attributes in its manifest file\&. +.SH OPTIONS +.TP +-verbose +.br +Lists JAR files in the extension directory as they are checked\&. Additionally, manifest attributes of the target JAR file and any conflicting JAR files are also reported\&. +.TP +-J\fIoption\fR +.br +Passes \fIoption\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu jar(1) -.LP - +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/idlj.1 b/jdk/src/solaris/doc/sun/man/man1/idlj.1 index 2ed5652bc63..01130581906 100644 --- a/jdk/src/solaris/doc/sun/man/man1/idlj.1 +++ b/jdk/src/solaris/doc/sun/man/man1/idlj.1 @@ -1,739 +1,568 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH idlj 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: idlj.1 +.\" +.if n .pl 99999 +.TH idlj 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -idlj \- The IDL\-to\-Java Compiler -.LP -\f3idlj\fP generates Java bindings from a given IDL file. -.SH "Synopsis" -.LP -.nf -\f3 -.fl -idlj [ \fP\f3options\fP\f3 ] \fP\f4idl\-file\fP\f3 -.fl -\fP -.fi +.SH NAME +idlj \- Generates Java bindings for a specified Interface Definition Language (IDL) file\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -where \f2idl\-file\fP is the name of a file containing Interface Definition Language (IDL) definitions. \f2Options\fP may appear in any order, but must precede the \f2idl\-file\fP. -.LP -.SH "Description" -.LP -.LP -The IDL\-to\-Java Compiler generates the Java bindings for a given IDL file.\ For binding details, see the -.na -\f2OMG IDL to Java Language Language Mapping Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/mapping/jidlMapping.html. Some previous releases of the IDL\-to\-Java compiler were named \f2idltojava\fP. -.LP -.SS -Emitting Client and Server Bindings -.LP -.LP -To generate Java bindings for an IDL file named My.idl: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -This generates the client\-side bindings and is equivalent to: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient\fP My.idl -.fl -.fi - -.LP -.LP -The client\-side bindings do not include the server\-side skeleton. If you want to generate the server\-side bindings for the interfaces: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fserver\fP My.idl -.fl -.fi - -.LP -.LP -Server\-side bindings include the client\-side bindings plus the skeleton, all of which are \f2POA\fP (that is, Inheritance Model) classes. If you want to generate both client and server\-side bindings, use one of the following (equivalent) commands: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient \-fserver\fP My.idl -.fl -idlj \f3\-fall\fP My.idl -.fl -.fi - -.LP -.LP -There are two possible server\-side models: the Inheritance Model and the Tie Delegation Model. -.LP -.LP -The default server\-side model is the \f2Portable Servant Inheritance Model\fP. Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2MyPOA.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2MyPOA\fP. -.LP -.LP -\f2MyPOA.java\fP is a stream\-based skeleton that extends -.na -\f2org.omg.PortableServer.Servant\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/org/omg/PortableServer/Servant.html and implements the \f2InvokeHandler\fP interface and the operations interface associated with the IDL interface the skeleton implements. -.LP -.LP -The \f2PortableServer\fP module for the -.na -\f2Portable Object Adapter (POA)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. -.LP -.LP -Another option for the Inheritance Model is to use the \f2\-oldImplBase\fP flag in order to generate server\-side bindings that are compatible with versions of the Java programming language prior to J2SE 1.4. Note that using the \f2\-oldImplBase\fP flag is non\-standard: these APIs are being deprecated. You would use this flag ONLY for compatibility with existing servers written in J2SE 1.3. In that case, you would need to modify an existing MAKEFILE to add the \f2\-oldImplBase\fP flag to the \f2idlj\fP compiler, otherwise POA\-based server\-side mappings will be generated. To generate server\-side bindings that are backwards compatible: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fclient \-fserver\fP \f3\-oldImplBase\fP My.idl -.fl -idlj \f3\-fall\fP \f3\-oldImplBase\fP My.idl -.fl -.fi - -.LP -.LP -Given an interface \f2My\fP defined in \f2My.idl\fP, the file \f2_MyImplBase.java\fP is generated. You must provide the implementation for \f2My\fP and it must inherit from \f2_MyImplBase\fP. -.LP -.LP -The other server\-side model is called the Tie Model. This is a delegation model. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately. The following commands generate the bindings for the Tie Model: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-fall\fP My.idl -.fl -idlj \f3\-fallTIE\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, the second command generates \f2MyPOATie.java\fP. The constructor to \f2MyPOATie\fP takes a \f2delegate\fP. In this example, using the default POA model, the constructor also needs a \f2poa\fP. You must provide the implementation for \f2delegate\fP, but it does not have to inherit from any other class, only the interface \f2MyOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2MyPOATie\fP. For instance: -.LP -.nf -\f3 -.fl - ORB orb = ORB.init(args, System.getProperties()); -.fl - -.fl - // Get reference to rootpoa & activate the POAManager -.fl - POA rootpoa = (POA)orb.resolve_initial_references("RootPOA"); -.fl - rootpoa.the_POAManager().activate(); -.fl - -.fl - // create servant and register it with the ORB -.fl - MyServant myDelegate = new MyServant(); -.fl - myDelegate.setORB(orb); -.fl - -.fl - // create a tie, with servant being the delegate. -.fl - MyPOATie tie = new MyPOATie(myDelegate, rootpoa); -.fl - -.fl - // obtain the objectRef for the tie -.fl - My ref = tie._this(orb); -.fl -\fP -.fi - -.LP -.LP -You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method. -.LP -.LP -To generate server\-side, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions prior to J2SE 1.4. -.LP -.nf -\f3 -.fl -idlj \fP\f3\-oldImplBase\fP \f3\-fall\fP My.idl -.fl -idlj \f3\-oldImplBase\fP \f3\-fallTIE\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, this will generate \f2My_Tie.java\fP. The constructor to \f2My_Tie\fP takes a \f2impl\fP. You must provide the implementation for \f2impl\fP, but it does not have to inherit from any other class, only the interface \f2HelloOperations\fP. But to use it with the ORB, you must wrap your implementation within \f2My_Tie\fP. For instance: -.LP -.nf -\f3 -.fl - ORB orb = ORB.init(args, System.getProperties()); -.fl - -.fl - // create servant and register it with the ORB -.fl - MyServant myDelegate = new MyServant(); -.fl - myDelegate.setORB(orb); -.fl - -.fl - // create a tie, with servant being the delegate. -.fl - MyPOATie tie = new MyPOATie(myDelegate); -.fl - -.fl - // obtain the objectRef for the tie -.fl - My ref = tie._this(orb); -.fl -\fP -.fi - -.LP -.SS -Specifying Alternate Locations for Emitted Files -.LP -.LP -If you want to direct the emitted files to a directory other than the current directory, invoke the compiler as: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-td /altdir\fP My.idl -.fl -.fi - -.LP -.LP -For the interface \f2My\fP, the bindings will be emitted to \f2/altdir/My.java\fP, etc., instead of \f2./My.java\fP. -.LP -.SS -Specifying Alternate Locations for Include Files -.LP -.LP -If \f2My.idl\fP included another idl file, \f2MyOther.idl\fP, the compiler assumes that \f2MyOther.idl\fP resides in the local directory. If it resides in \f2/includes\fP, for example, then you would invoke the compiler with the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-i /includes\fP My.idl -.fl -.fi - -.LP -.LP -If \f2My.idl\fP also included \f2Another.idl\fP that resided in \f2/moreIncludes\fP, for example, then you would invoke the compiler with the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-i /includes \-i /moreIncludes\fP My.idl -.fl -.fi - -.LP -.LP -Since this form of include can become irritatingly long, another means of indicating to the compiler where to search for included files is provided. This technique is similar to the idea of an environment variable. Create a file named \f2idl.config\fP in a directory that is listed in your CLASSPATH. Inside of \f2idl.config\fP, provide a line with the following form: -.LP -.nf -\f3 -.fl -includes=/includes;/moreIncludes -.fl -\fP -.fi - -.LP -.LP -The compiler will find this file and read in the includes list. Note that in this example the separator character between the two directories is a semicolon (;). This separator character is platform dependent. On the Windows platform, use a semicolon, on the Unix platform, use a colon, etc. For more information on \f2includes\fP, see the -.na -\f2Setting the Classpath\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general. -.LP -.SS -Emitting Bindings for Include Files -.LP -.LP -By default, only those interfaces, structs, etc, that are defined in the idl file on the command line have Java bindings generated for them. The types defined in included files are not generated. For example, assume the following two idl files: -.LP - -.LP -.LP -\f4My.idl\fP -.LP -.nf -\f3 -.fl -#include <MyOther.idl> -.fl -interface My -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4MyOther.idl\fP -.LP -.nf -\f3 -.fl -interface MyOther -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -The following command will only generate the java bindings for \f2My\fP: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -To generate all of the types in \f2My.idl\fP and all of the types in the files that \f2My.idl\fP includes (in this example, \f2MyOther.idl\fP), use the following command: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-emitAll\fP My.idl -.fl -.fi - -.LP -.LP -There is a caveat to the default rule. \f2#include\fP statements which appear at global scope are treated as described. These \f2#include\fP statements can be thought of as import statements. \f2#include\fP statements which appear within some enclosing scope are treated as true \f2#include\fP statements, meaning that the code within the included file is treated as if it appeared in the original file and, therefore, Java bindings are emitted for it. Here is an example: -.LP - -.LP -.LP -\f4My.idl\fP -.LP -.nf -\f3 -.fl -#include <MyOther.idl> -.fl -interface My -.fl -{ -.fl - #include <Embedded.idl> -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4MyOther.idl\fP -.LP -.nf -\f3 -.fl -interface MyOther -.fl -{ -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -\f4Embedded.idl\fP -.LP -.nf -\f3 -.fl -enum E {one, two, three}; -.fl -\fP -.fi - -.LP - -.LP -.LP -Running the following command: -.LP -.nf -\f3 -.fl -idlj My.idl -.fl -\fP -.fi - -.LP -.LP -will generate the following list of Java files: -.LP -.nf -\f3 -.fl -./MyHolder.java -.fl -./MyHelper.java -.fl -./_MyStub.java -.fl -./MyPackage -.fl -./MyPackage/EHolder.java -.fl -./MyPackage/EHelper.java -.fl -./MyPackage/E.java -.fl -./My.java -.fl -\fP -.fi - -.LP -.LP -Notice that \f2MyOther.java\fP was not generated because it is defined in an import\-like \f2#include\fP. But \f2E.java\fP \f2was\fP generated because it was defined in a true \f2#include\fP. Also notice that since \f2Embedded.idl\fP was included within the scope of the interface \f2My\fP, it appears within the scope of \f2My\fP (that is,in \f2MyPackage\fP). -.LP -.LP -If the \f2\-emitAll\fP flag had been used in the previous example, then all types in all included files would be emitted. -.LP -.SS -Inserting Package Prefixes -.LP -.LP +\fBidlj\fR [ \fIoptions\fR ] \fIidlfile\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. Options can appear in any order, but must precede the \f3idlfile\fR\&. +.TP +\fIidlfile\fR +The name of a file that contains Interface Definition Language (IDL) definitions\&. +.SH DESCRIPTION +The IDL-to-Java Compiler generates the Java bindings for a specified IDL file\&. For binding details, see Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html +.PP +Some earlier releases of the IDL-to-Java compiler were named \f3idltojava\fR\&. +.SS EMIT\ CLIENT\ AND\ SERVER\ BINDINGS +The following \f3idlj\fR command generates an IDL file named \f3My\&.idl\fR with client-side bindings\&. +.sp +.nf +\f3idlj My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The previous syntax is equivalent to the following: +.sp +.nf +\f3idlj \-fclient My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +The next example generates the server-side bindings, and includes the client-side bindings plus the skeleton, all of which are POA (Inheritance Model)\&. +.sp +.nf +\f3idlg \-fserver My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want to generate both client and server-side bindings, then use one of the following (equivalent) commands: +.sp +.nf +\f3idlj \-fclient \-fserver My\&.idl\fP +.fi +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +There are two possible server-side models: the Portal Servant Inheritance Model and the Tie Model\&. See Tie Delegation Model\&. +.PP +\f3Portable Servant Inheritance Model\fR\&. The default server-side model is the Portable Servant Inheritance Model\&. Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3MyPOA\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3MyPOA\fR class\&. \f3MyPOA\&.java\fR is a stream-based skeleton that extends the \f3org\&.omg\&.PortableServer\&.Servant\fR class at http://docs\&.oracle\&.com/javase/8/docs/api/org/omg/PortableServer/Servant\&.html The \f3My\fR interface implements the \f3callHandler\fR interface and the operations interface associated with the IDL interface the skeleton implements\&.The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. See Portable Object Adapter (POA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/POA\&.html In the Java programming language, the \f3Servant\fR type is mapped to the Java \f3org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&.Another option for the Inheritance Model is to use the \f3-oldImplBase\fR flag to generate server-side bindings that are compatible with releases of the Java programming language before Java SE 1\&.4\&. The -\f3oldImplBase\fR flag is nonstandard, and these APIs are deprecated\&. You would use this flag only for compatibility with existing servers written in Java SE 1\&.3\&. In that case, you would need to modify an existing make file to add the \f3-oldImplBase\fR flag to the \f3idlj\fR compiler\&. Otherwise POA-based server-side mappings are generated\&. To generate server-side bindings that are backward compatible, do the following: +.sp +.nf +\f3idlj \-fclient \-fserver \-oldImplBase My\&.idl\fP +.fi +.nf +\f3idlj \-fall \-oldImplBase My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Given an interface \f3My\fR defined in \f3My\&.idl\fR, the file \f3_MyImplBase\&.java\fR is generated\&. You must provide the implementation for the \f3My\fR interface, and the \f3My\fR interface must inherit from the \f3_MyImplBase\fR class\&. +.PP +\f3Tie Delegation Model\fR\&. The other server-side model is called the Tie Model\&. This is a delegation model\&. Because it is not possible to generate ties and skeletons at the same time, they must be generated separately\&. The following commands generate the bindings for the Tie Model: +.sp +.nf +\f3idlj \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the second command generates \f3MyPOATie\&.java\fR\&. The constructor to the \f3MyPOATie\fR class takes a delegate\&. In this example, using the default POA model, the constructor also needs a POA\&. You must provide the implementation for the delegate, but it does not have to inherit from any other class, only the interface \f3MyOperations\fR\&. To use it with the ORB, you must wrap your implementation within the \f3MyPOATie\fR class, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// Get reference to rootpoa & activate the POAManager\fP +.fi +.nf +\f3POA rootpoa = (POA)orb\&.resolve_initial_references("RootPOA");\fP +.fi +.nf +\f3rootpoa\&.the_POAManager()\&.activate();\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate, rootpoa);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +You might want to use the Tie model instead of the typical Inheritance model when your implementation must inherit from some other implementation\&. Java allows any number of interface inheritance, but there is only one slot for class inheritance\&. If you use the inheritance model, then that slot is used up\&. With the Tie Model, that slot is freed up for your own use\&. The drawback is that it introduces a level of indirection: one extra method call occurs when a method is called\&. +.PP +For server-side generation, Tie model bindings that are compatible with versions of the IDL to Java language mapping in versions earlier than Java SE 1\&.4\&. +.sp +.nf +\f3idlj \-oldImplBase \-fall My\&.idl\fP +.fi +.nf +\f3idlj \-oldImplBase \-fallTIE My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +For the \f3My\fR interface, the this generates \f3My_Tie\&.java\fR\&. The constructor to the \f3My_Tie\fR class takes an \f3impl\fR object\&. You must provide the implementation for \f3impl\fR, but it does not have to inherit from any other class, only the interface \f3HelloOperations\fR\&. But to use it with the ORB, you must wrap your implementation within \f3My_Tie\fR, for example: +.sp +.nf +\f3ORB orb = ORB\&.init(args, System\&.getProperties());\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create servant and register it with the ORB\fP +.fi +.nf +\f3MyServant myDelegate = new MyServant();\fP +.fi +.nf +\f3myDelegate\&.setORB(orb); \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// create a tie, with servant being the delegate\&.\fP +.fi +.nf +\f3MyPOATie tie = new MyPOATie(myDelegate);\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3// obtain the objectRef for the tie\fP +.fi +.nf +\f3My ref = tie\&._this(orb);\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ EMITTED\ FILES +If you want to direct the emitted files to a directory other than the current directory, then call the compiler this way: \f3i\fR\f3dlj -td /altdir My\&.idl\fR\&. +.PP +For the \f3My\fR interface, the bindings are emitted to \f3/altdir/My\&.java\fR, etc\&., instead of \f3\&./My\&.java\fR\&. +.SS SPECIFY\ ALTERNATE\ LOCATIONS\ FOR\ INCLUDE\ FILES +If the \f3My\&.idl\fR file includes another \f3idl\fR file, \f3MyOther\&.idl\fR, then the compiler assumes that the \f3MyOther\&.idl\fR file resides in the local directory\&. If it resides in \f3/includes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If \f3My\&.idl\fR also included \f3Another\&.idl\fR that resided in \f3/moreIncludes\fR, for example, then you call the compiler with the following command: +.sp +.nf +\f3idlj \-i /includes \-i /moreIncludes My\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +Because this form of \f3include\fR can become long, another way to indicate to the compiler where to search for included files is provided\&. This technique is similar to the idea of an environment variable\&. Create a file named idl\&.config in a directory that is listed in your \f3CLASSPATH\fR variable\&. Inside of \f3idl\&.config\fR, provide a line with the following form: +.sp +.nf +\f3includes=/includes;/moreIncludes\fP +.fi +.nf +\f3\fR +.fi +.sp +The compiler will find this file and read in the includes list\&. Note that in this example the separator character between the two directories is a semicolon (;)\&. This separator character is platform dependent\&. On the Windows platform, use a semicolon, on the Unix platform, use a colon, and so on\&. +.SS EMIT\ BINDINGS\ FOR\ INCLUDE\ FILES +By default, only those interfaces, structures, and so on, that are defined in the \f3idl\fR file on the command line have Java bindings generated for them\&. The types defined in included files are not generated\&. For example, assume the following two \f3idl\fR files: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +There is a caveat to the default rule\&. Any \f3#include\fR statements that appear at the global scope are treated as described\&. These \f3#include\fR statements can be thought of as import statements\&. The \f3#include\fR statements that appear within an enclosed scope are treated as true \f3#include\fR statements, which means that the code within the included file is treated as though it appeared in the original file and, therefore, Java bindings are emitted for it\&. Here is an example: +.sp +.nf +\f3My\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3#include <MyOther\&.idl>\fP +.fi +.nf +\f3interface My\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 #include <Embedded\&.idl>\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3MyOther\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3interface MyOther\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3Embedded\&.idl\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3enum E {one, two, three};\fP +.fi +.nf +\f3\fR +.fi +.sp +Run\f3idlj My\&.idl\fRto generate the following list of Java files\&. Notice that \f3MyOther\&.java\fR is not generated because it is defined in an import-like \f3#include\fR\&. But \f3E\&.java\fR was generated because it was defined in a true \f3#include\fR\&. Notice that because the \f3Embedded\&.idl\fR file is included within the scope of the interface \f3My\fR, it appears within the scope of \f3My\fR (in \f3MyPackage\fR)\&. If the \f3-emitAll\fR flag had been used, then all types in all included files would have been emitted\&. +.sp +.nf +\f3\&./MyHolder\&.java\fP +.fi +.nf +\f3\&./MyHelper\&.java\fP +.fi +.nf +\f3\&./_MyStub\&.java\fP +.fi +.nf +\f3\&./MyPackage\fP +.fi +.nf +\f3\&./MyPackage/EHolder\&.java\fP +.fi +.nf +\f3\&./MyPackage/EHelper\&.java\fP +.fi +.nf +\f3\&./MyPackage/E\&.java\fP +.fi +.nf +\f3\&./My\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS INSERT\ PACKAGE\ PREFIXES Suppose that you work for a company named ABC that has constructed the following IDL file: -.LP - -.LP -.LP -\f4Widgets.idl\fP -.LP -.nf -\f3 -.fl -module Widgets -.fl -{ -.fl - interface W1 {...}; -.fl - interface W2 {...}; -.fl -}; -.fl -\fP -.fi - -.LP - -.LP -.LP -Running this file through the IDL\-to\-Java compiler will place the Java bindings for \f2W1\fP and \f2W2\fP within the package \f2Widgets\fP. But there is an industry convention that states that a company's packages should reside within a package named \f2com.<company name>\fP. The \f2Widgets\fP package is not good enough. To follow convention, it should be \f2com.abc.Widgets\fP. To place this package prefix onto the \f2Widgets\fP module, execute the following: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-pkgPrefix Widgets com.abc\fP Widgets.idl -.fl -.fi - -.LP -.LP -If you have an IDL file which includes \f2Widgets.idl\fP, the \f2\-pkgPrefix\fP flag must appear in that command also. If it does not, then your IDL file will be looking for a \f2Widgets\fP package rather than a \f2com.abc.Widgets\fP package. -.LP -.LP -If you have a number of these packages that require prefixes, it might be easier to place them into the \f2idl.config\fP file described above. Each package prefix line should be of the form: -.LP -.nf -\f3 -.fl -PkgPrefix.<type>=<prefix> -.fl -\fP -.fi - -.LP -So the line for the above example would be: -.nf -\f3 -.fl -PkgPrefix.Widgets=com.abc -.fl -\fP -.fi - -.LP -.LP -The use of this option does not affect the Repository ID. -.LP -.SS -Defining Symbols Before Compilation -.LP -.LP -You may need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings. The command -.LP -.nf -\f3 -.fl -idlj \fP\f3\-d\fP MYDEF My.idl -.fl -.fi - -.LP -.LP -is the equivalent of putting the line \f2#define MYDEF\fP inside \f2My.idl\fP. -.LP -.SS -Preserving Pre\-Existing Bindings -.LP -.LP -If the Java binding files already exist, the \f2\-keep\fP flag will keep the compiler from overwriting them. The default is to generate all files without considering if they already exist. If you've customized those files (which you should not do unless you are very comfortable with their contents), then the \f2\-keep\fP option is very useful. The command -.LP -.nf -\f3 -.fl -idlj \fP\f3\-keep\fP My.idl -.fl -.fi - -.LP -.LP -emits all client\-side bindings that do not already exist. -.LP -.SS -Viewing Progress of Compilation -.LP -.LP -The IDL\-to\-Java compiler will generate status messages as it progresses through its phases of execution. Use the \f2\-v\fP option to activate this "verbose" mode: -.LP -.nf -\f3 -.fl -idlj \fP\f3\-v\fP My.idl -.fl -.fi - -.LP -.LP -By default the compiler does not operate in verbose mode. -.LP -.SS -Displaying Version Information -.LP -.LP -To display the build version of the IDL\-to\-Java compiler, specify the \f2\-version\fP option on the command\-line: -.LP -.nf -\f3 -.fl -idlj \-version -.fl -\fP -.fi - -.LP -.LP -Version information also appears within the bindings generated by the compiler. Any additional options appearing on the command\-line are ignored. -.LP -.SH "Options" -.LP -.RS 3 -.TP 3 -\-d symbol -This is equivalent to the following line in an IDL file: -.nf -\f3 -.fl -#define \fP\f4symbol\fP\f3 -.fl -\fP -.fi -.TP 3 -\-emitAll -Emit all types, including those found in \f2#include\fP files. -.TP 3 -\-fside -Defines what bindings to emit. \f2side\fP is one of \f2client\fP, \f2server\fP, \f2serverTIE\fP, \f2all\fP, or \f2allTIE\fP. The \f2\-fserverTIE\fP and \f2\-fallTIE\fP options cause delegate model skeletons to be emitted. Assumes \f2\-fclient\fP if the flag is not specified. -.TP 3 -\-i include\-path -By default, the current directory is scanned for included files. This option adds another directory. -.TP 3 -\-keep -If a file to be generated already exists, do not overwrite it. By default it is overwritten. -.TP 3 -\-noWarn -Suppresses warning messages. -.TP 3 -\-oldImplBase -Generates skeletons compatible with pre\-1.4 JDK ORBs. By default, the POA Inheritance Model server\-side bindings are generated. This option provides backward\-compatibility with older versions of the Java programming language by generating server\-side bindings that are \f2ImplBase\fP Inheritance Model classes. -.TP 3 -\-pkgPrefix type prefix -Wherever \f2type\fP is encountered at file scope, prefix the generated Java package name with \f2prefix\fP for all files generated for that type. The \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module. -.TP 3 -\-pkgTranslate type package -Whenever the module name \f2type\fP is encountered in an identifier, replace it in the identifier with \f2package\fP for all files in the generated Java package. Note that \f2pkgPrefix\fP changes are made first. \f2type\fP is the simple name of either a top\-level module, or an IDL type defined outside of any module, and must match the full package name exactly. +.sp +.nf +\f3Widgets\&.idl file:\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3module Widgets\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 interface W1 {\&.\&.\&.};\fP +.fi +.nf +\f3 interface W2 {\&.\&.\&.};\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fR +.fi +.sp +If you run this file through the IDL-to-Java compiler, then the Java bindings for W1 and W2 are placed within the \f3Widgets\fR package\&. There is an industry convention that states that a company\&'s packages should reside within a package named \f3com\&.<company name>\fR\&. To follow this convention, the package name should be \f3com\&.abc\&.Widgets\fR\&. To place this package prefix onto the Widgets module, execute the following: +.sp +.nf +\f3idlj \-pkgPrefix Widgets com\&.abc Widgets\&.idl\fP +.fi +.nf +\f3\fR +.fi +.sp +If you have an IDL file that includes Widgets\&.idl, then the \f3-pkgPrefix\fR flag must appear in that command also\&. If it does not, then your IDL file will be looking for a \f3Widgets\fR package rather than a \f3com\&.abc\&.Widgets\fR package\&. +.PP +If you have a number of these packages that require prefixes, then it might be easier to place them into the idl\&.config file described previously\&. Each package prefix line should be of the form: \f3PkgPrefix\&.<type>=<prefix>\fR\&. The line for the previous example would be \f3PkgPrefix\&.Widgets=com\&.abc\fR\&. This option does not affect the Repository ID\&. +.SS DEFINE\ SYMBOLS\ BEFORE\ COMPILATION +You might need to define a symbol for compilation that is not defined within the IDL file, perhaps to include debugging code in the bindings\&. The command \f3idlj -d MYDEF My\&.idl\fRis equivalent to putting the line \f3#define MYDEF\fR inside My\&.idl\&. +.SS PRESERVE\ PREEXISTING\ BINDINGS +If the Java binding files already exist, then the \f3-keep\fR flag keeps the compiler from overwriting them\&. The default is to generate all files without considering that they already exist\&. If you have customized those files (which you should not do unless you are very comfortable with their contents), then the \f3-keep\fR option is very useful\&. The command \f3idlj -keep My\&.idl\fR emits all client-side bindings that do not already exist\&. +.SS VIEW\ COMPILATION\ PROGRESS +The IDL-to-Java compiler generates status messages as it progresses through its phases of execution\&. Use the \f3-v\fR option to activate the verbose mode: \f3idlj -v My\&.idl\fR\&. +.PP +By default the compiler does not operate in verbose mode +.SS DISPLAY\ VERSION\ INFORMATION +To display the build version of the IDL-to-Java compiler, specify the \f3-version\fR option on the command-line: \f3idlj -version\fR\&. +.PP +Version information also appears within the bindings generated by the compiler\&. Any additional options appearing on the command-line are ignored\&. +.SH OPTIONS +.TP +-d \fIsymbol\fR .br +This is equivalent to the following line in an IDL file: +.sp +.nf +\f3#define \fIsymbol\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-demitAll .br -If more than one translation matches an identifier, the longest match is chosen. For example, if the arguments include: -.nf -\f3 -.fl - \-pkgTranslate foo bar \-pkgTranslate foo.baz buzz.fizz -.fl -\fP -.fi -The following translations would occur: -.nf -\f3 -.fl -foo => bar -.fl -foo.boo => bar.boo -.fl -foo.baz => buzz.fizz -.fl -foo.baz.bar => buzz.fizz.bar -.fl -\fP -.fi -The following package names cannot be translated: -.RS 3 -.TP 2 -o -\f2org\fP -.TP 2 -o -\f2org.omg\fP or any subpackages of \f2org.omg\fP -.RE -Any attempt to translate these packages will result in uncompilable code, and the use of these packages as the first argument after \f2\-pkgTranslate\fP will be treated as an error. -.TP 3 -\-skeletonName xxx%yyy -Use \f2xxx%yyy\fP as the pattern for naming the skeleton. The defaults are: -.RS 3 -.TP 2 -o -%POA for the \f2POA\fP base class (\f2\-fserver\fP or \f2\-fall\fP) -.TP 2 -o -_%ImplBase for the \f2oldImplBase\fP class (\f2\-oldImplBase\fP and (\f2\-fserver\fP or \f2\-fall\fP)) -.RE -.TP 3 -\-td dir -Use \f2dir\fP for the output directory instead of the current directory. -.TP 3 -\-tieName xxx%yyy -Name the tie according to the pattern. The defaults are: -.RS 3 -.TP 2 -o -%POATie for the \f2POA\fP tie base class (\f2\-fserverTie\fP or \f2\-fallTie\fP) -.TP 2 -o -%_Tie for the \f2oldImplBase\fP tie class (\f2\-oldImplBase\fP and (\f2\-fserverTie\fP or \f2\-fallTie\fP)) -.RE -.TP 3 -\-nowarn, \-verbose -Verbose mode. -.TP 3 -\-version -Display version information and terminate. -.RE +Emit all types, including those found in \f3#include\fR files\&. +.TP +-fside +.br +Defines what bindings to emit\&. The \f3side\fR parameter can be \f3client\fR, \f3server\fR, \f3serverTIE\fR, \f3all\fR, or \f3allTIE\fR\&. The \f3-fserverTIE\fR and \f3-fallTIE\fR options cause delegate model skeletons to be emitted\&. Defaults to \f3-fclient\fR when the flag is not specified\&. +.TP +-i \fIinclude-path\fR +.br +By default, the current directory is scanned for included files\&. This option adds another directory\&. +.TP +-i \fIkeep\fR +.br +If a file to be generated already exists, then do not overwrite it\&. By default it is overwritten\&. +.TP +-noWarn +.br +Suppress warning messages\&. +.TP +-oldImplBase +.br +Generates skeletons compatible with pre-1\&.4 JDK ORBs\&. By default, the POA Inheritance Model server-side bindings are generated\&. This option provides backward-compatibility with earlier releases of the Java programming language by generating server-side bindings that are \f3ImplBase\fR Inheritance Model classes\&. +.TP +-pkgPrefix \fItype\fR\fIprefix\fR +.br +Wherever \f3type\fR is encountered at file scope, prefix the generated Java package name with \f3prefix\fR for all files generated for that type\&. The type is the simple name of either a top-level module, or an IDL type defined outside of any module\&. +.TP +-pkgTranslate \fItype\fR\fIpackage\fR +.br +Whenever the module name type is encountered in an identifier, replace it in the identifier with package for all files in the generated Java package\&. Note that \f3pkgPrefix\fR changes are made first\&. The type value is the simple name of either a top-level module, or an IDL type defined outside of any module and must match the full package name exactly\&. -.LP -.LP -See the Description section for more option information. -.LP -.SH "Restrictions:" -.LP -.RS 3 -.TP 2 -o -Escaped identifiers in the global scope may not have the same spelling as IDL primitive types, \f2Object\fP, or \f2ValueBase\fP. This is because the symbol table is pre\-loaded with these identifiers; allowing them to be redefined would overwrite their original definitions. (Possible permanent restriction). -.TP 2 -o -The \f2fixed\fP IDL type is not supported. -.RE +If more than one translation matches an identifier, then the longest match is chosen as shown in the following example: -.LP -.SH "Known Problems:" -.LP -.RS 3 -.TP 2 -o -No import generated for global identifiers. If you invoke on an unexported local impl, you do get an exception, but it seems to be due to a \f2NullPointerException\fP in the \f2ServerDelegate\fP DSI code. -.RE +\fICommand\fR: +.sp +.nf +\f3pkgTranslate type pkg \-pkgTranslate type2\&.baz pkg2\&.fizz\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP - + +\fIResulting Translation\fR: +.sp +.nf +\f3type => pkg\fP +.fi +.nf +\f3type\&.ext => pkg\&.ext\fP +.fi +.nf +\f3type\&.baz => pkg2\&.fizz\fP +.fi +.nf +\f3type2\&.baz\&.pkg => pkg2\&.fizz\&.pkg\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following package names \f3org\fR, \f3org\fR\&.o\f3mg\fR, or any subpackages of \f3org\&.omg\fR cannot be translated\&. Any attempt to translate these packages results in uncompilable code, and the use of these packages as the first argument after \f3-pkgTranslate\fR is treated as an error\&. +.TP +-skeletonName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR as the pattern for naming the skeleton\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserver\fR or \f3-fall\fR), and \f3_%ImplBase\fR for the \f3oldImplBase\fR class (-\f3oldImplBase\fR) and (\f3-fserver\fR or \f3-fall\fR))\&. +.TP +-td \fIdir\fR +.br +Use \fIdir\fR for the output directory instead of the current directory\&. +.TP +-tieName \fIxxx%yyy\fR +.br +Use \f3xxx%yyy\fR according to the pattern\&. The defaults are: \f3%POA\fR for the \f3POA\fR base class (\f3-fserverTie or -fallTie\fR), and \f3_%Tie\fR for the \f3oldImplBase\fR tie class (-\f3oldImplBase\fR) and (\f3-fserverTie\fR or \f3-fallTie\fR)) +.TP +-nowarn, -verbose +.br +Displays release information and terminates\&. +.TP +-version +.br +Displays release information and terminates\&. +.SH RESTRICTIONS +Escaped identifiers in the global scope cannot have the same spelling as IDL primitive types, \f3Object\fR, or \f3ValueBase\fR\&. This is because the symbol table is preloaded with these identifiers\&. Allowing them to be redefined would overwrite their original definitions\&. Possible permanent restriction\&. +.PP +The \f3fixed\fR IDL type is not supported\&. +.SH KNOWN\ PROBLEMS +No import is generated for global identifiers\&. If you call an unexported local \f3impl\fR object, then you do get an exception, but it seems to be due to a \f3NullPointerException\fR in the \f3ServerDelegate\fR DSI code\&. +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jar.1 b/jdk/src/solaris/doc/sun/man/man1/jar.1 index cd59f0aa1d3..e559e47a160 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jar.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jar.1 @@ -1,579 +1,485 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jar 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jar.1 +.\" +.if n .pl 99999 +.TH jar 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jar\-The Java Archive Tool -.LP -\f3jar\fP combines multiple files into a single JAR archive file. -.SH "SYNOPSIS" -.LP -.RS 3 -.TP 3 -Create jar file -\f4jar c\fP\f2[v0Mmfe] [\fP\f2manifest\fP\f2] [\fP\f2jarfile\fP\f2] [\fP\f2entrypoint\fP\f2] [\-C\fP \f2dir\fP\f2]\fP \f2inputfiles\fP \f2[\-J\fP\f2option\fP\f2]\fP -.TP 3 -Update jar file -\f4jar u\fP\f2[v0Mmfe] [\fP\f2manifest\fP\f2] [\fP\f2jarfile\fP\f2] [\fP\f2entrypoint\fP\f2] [\-C\fP \f2dir\fP\f2]\fP \f2inputfiles\fP \f2[\-J\fP\f2option\fP\f2]\fP -.TP 3 -Extract jar file -\f4jar x\fP\f2[vf] [\fP\f2jarfile\fP\f2] [\fP\f2inputfiles\fP\f2] [\-J\fP\f2option\fP\f2]\fP -.TP 3 -List table of contents of jar file -\f4jar t\fP\f2[vf] [\fP\f2jarfile\fP\f2] [\fP\f2inputfiles\fP\f2] [\-J\fP\f2option\fP\f2]\fP -.TP 3 -Add index to jar file -\f4jar i\fP \f2jarfile\fP \f2[\-J\fP\f2option\fP\f2]\fP -.RE +.SH NAME +jar \- Manipulates Java Archive (JAR) files\&. +.SH SYNOPSIS +Create JAR file +.sp +.nf -.LP -.LP -where: -.LP -.RS 3 -.TP 3 -cuxtiv0Mmfe -Options that control the \f2jar\fP command. -.TP 3 -jarfile -Jar file to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), or have its table of contents viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if either is present, they must both appear. Note that omitting \f2f\fP and \f2jarfile\fP accepts a "jar file" from standard input (for x and t) or sends the "jar file" to standard output (for c and u). -.TP 3 -inputfiles -Files or directories, separated by spaces, to be combined into \f2jarfile\fP (for c and u), or to be extracted (for x) or listed (for t) from \f2jarfile\fP. All directories are processed recursively. The files are compressed unless option \f20\fP (zero) is used. -.TP 3 -manifest -Pre\-existing manifest file whose \f2name\fP\f2:\fP \f2value\fP pairs are to be included in MANIFEST.MF in the jar file. The \f2\-m\fP option and filename \f2manifest\fP are a pair \-\- if either is present, they must both appear. The letters \f3m\fP, \f3f\fP and \f3e\fP must appear in the same order that \f2manifest\fP, \f2jarfile\fP, \f2entrypoint\fP appear. -.TP 3 -entrypoint -The name of the class that set as the application entry point for stand\-alone applications bundled into executable jar file. The \f2\-e\fP option and entrypoint are a pair \-\- if either is present, they must both appear. The letters \f3m\fP, \f3f\fP and \f3e\fP must appear in the same order that \f2manifest\fP, \f2jarfile\fP, \f2entrypoint\fP appear. -.TP 3 -\-C\ dir -Temporarily changes directories to \f2dir\fP while processing the following \f2inputfiles\fP argument. Multiple \f2\-C\ \fP\f2dir\fP \f2inputfiles\fP sets are allowed. -.TP 3 -\-Joption -Option to be passed into the Java runtime environment. (There must be no space between \f2\-J\fP and \f2option\fP). -.RE +\fBjar c\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -The \f3jar\fP tool combines multiple files into a single JAR archive file. \f3jar\fP is a general\-purpose archiving and compression tool, based on ZIP and the -.na -\f2ZLIB\fP @ -.fi -http://www.gzip.org/zlib/ compression format. However, \f3jar\fP was designed mainly package java applets or applications into a single archive. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a java agent (like a browser) in a single HTTP transaction, rather than requiring a new connection for each piece. This dramatically improves download times. \f3jar\fP also compresses files and so further improves download time. In addition, it allows individual entries in a file to be signed by the applet author so that their origin can be authenticated. The syntax for the jar tool is almost identical to the syntax for the \f2tar\fP command. A \f3jar\fP archive can be used as a class path entry, whether or not it is compressed. -.LP -Typical usage to combine files into a jar file is: -.LP -.nf -\f3 -.fl -% jar cf myFile.jar *.class -.fl -\fP -.fi +Update JAR file +.sp +.nf -.LP -In this example, all the class files in the current directory are placed into the file named \f2myFile.jar\fP. The jar tool automatically generates a manifest file entry named \f2META\-INF/MANIFEST.MF\fP. It is always the first entry in the jar file. The manifest file declares meta\-information about the archive, and stores that data as \f2name\ :\ value\fP pairs. Refer to the -.na -\f2JAR file specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR%20Manifest for details explaining how the jar tool stores meta\-information in the manifest file. -.LP -If a jar file should include \f2name\ :\ value\fP pairs contained in an existing manifest file, specify that file using the \f2\-m\fP option: -.LP -.nf -\f3 -.fl -% jar cmf myManifestFile myFile.jar *.class -.fl -\fP -.fi +\fBjar u\fR[\fBefmMnv0\fR] [\fIentrypoint\fR] [\fIjarfile\fR] [\fImanifest\fR] [\fB\-C\fR \fIdir\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp -.LP -An existing manifest file must end with a new line character.\ \f3jar\fP does not parse the last line of a manifest file if it does not end with a new line character. +Extract JAR file +.sp +.nf + +\fBjar\fR \fBx\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +List Contents of JAR file +.sp +.nf + +\fBjar\fR \fBt\fR[\fBvf\fR] [\fIjarfile\fR] \fIfile\fR \&.\&.\&. [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp + +Add Index to JAR file +.sp +.nf + +\fBjar\fR \fBi\fR \fIjarfile\fR [\-J\fIoption\fR \&.\&.\&.] [@\fIarg\-file\fR \&.\&.\&.] +.fi +.sp +.SH DESCRIPTION +The \f3jar\fR command is a general-purpose archiving and compression tool, based on ZIP and the ZLIB compression format\&. However, the \f3jar\fR command was designed mainly to package Java applets or applications into a single archive\&. When the components of an applet or application (files, images and sounds) are combined into a single archive, they can be downloaded by a Java agent (such as a browser) in a single HTTP transaction, rather than requiring a new connection for each piece\&. This dramatically improves download times\&. The \f3jar\fR command also compresses files, which further improves download time\&. The \f3jar\fR command also allows individual entries in a file to be signed by the applet author so that their origin can be authenticated\&. A JAR file can be used as a class path entry, whether or not it is compressed\&. +.PP +The syntax for the \f3jar\fR command resembles the syntax for the \f3tar\fR command\&. It has several operation modes, defined by one of the mandatory \fIoperation arguments\fR\&. Other arguments are either \fIoptions\fR that modify the behavior of the operation, or \fIoperands\fR required to perform the operation\&. +.SH OPERATION\ ARGUMENTS +When using the \f3jar\fR command, you have to select an operation to be performed by specifying one of the following operation arguments\&. You can mix them up with other one-letter options on the command line, but usually the operation argument is the first argument specified\&. +.TP +c +Create a new JAR archive\&. +.TP +i +Generate index information for a JAR archive\&. +.TP +t +List the contents of a JAR archive\&. +.TP +u +Update a JAR archive\&. +.TP +x +Extract files from a JAR archive\&. +.SH OPTIONS +Use the following options to customize how the JAR file is created, updated, extracted, or viewed: +.TP +e +Sets the class specified by the \fIentrypoint\fR operand to be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The use of this option creates or overrides the \f3Main-Class\fR attribute value in the manifest file\&. The \f3e\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +For example, the following command creates the \f3Main\&.jar\fR archive with the \f3Main\&.class\fR file where the \f3Main-Clas\fRs attribute value in the manifest is set to \f3Main\fR: +.sp +.nf +\f3jar cfe Main\&.jar Main Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The Java Runtime Environment (JRE) can directly call this application by running the following command: +.sp +.nf +\f3java \-jar Main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the entry point class name is in a package, then it could use either the dot (\&.) or slash (/) as the delimiter\&. For example, if \f3Main\&.class\fR is in a package called \f3mydir\fR, then the entry point can be specified in one of the following ways: +.sp +.nf +\f3jar \-cfe Main\&.jar mydir/Main mydir/Main\&.class\fP +.fi +.nf +\f3jar \-cfe Main\&.jar mydir\&.Main mydir/Main\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Note + +Specifying both \f3m\fR and \f3e\fR options together when a particular manifest also contains the \f3Main-Class\fR attribute results in an ambiguous \f3Main-Class\fR specification\&. The ambiguity leads to an error and the \f3jar\fR command creation or update operation is terminated\&. +.TP +f +Sets the file specified by the \fI\fR\fIjarfile\fR operand to be the name of the JAR file that is created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR) from, or viewed (\f3t\fR)\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. +.TP +m +Includes names and values of attributes from the file specified by the \f3manifest\fR operand in the manifest file of the \f3jar\fR command (located in the archive at \f3META-INF/MANIFEST\&.MF\fR)\&. The \f3jar\fR command adds the attribute\(cqs name and value to the JAR file unless an entry already exists with the same name, in which case the \f3jar\fR command updates the value of the attribute\&. The \f3m\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. + +You can add special-purpose name-value attribute pairs to the manifest that are not contained in the default manifest file\&. For example, you can add attributes that specify vendor information, release information, package sealing, or to make JAR-bundled applications executable\&. For examples of using the \f3m\fR option, see Packaging Programs at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.TP +M +Does not create a manifest file entry (for \f3c\fR and \f3u\fR), or delete a manifest file entry when one exists (for \f3u\fR)\&. The \f3M\fR option can be used when creating (\f3c\fR) or updating (\f3u\fR) the JAR file\&. +.TP +n +When creating (\f3c\fR) a JAR file, this option normalizes the archive so that the content is not affected by the packing and unpacking operations of the pack200(1) command\&. Without this normalization, the signature of a signed JAR can become invalid\&. +.TP +v +Generates verbose output to standard output\&. See Examples\&. +.TP +0 +(Zero) Creates (\f3c\fR) or updates (\f3u\fR) the JAR file without using ZIP compression\&. +.TP +-C \fIdir\fR .br +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, this option temporarily changes the directory while processing files specified by the \fIfile\fR operands\&. Its operation is intended to be similar to the \f3-C\fR option of the UNIX \f3tar\fR utility\&.For example, the following command changes to the \f3classes\fR directory and adds the \f3Bar\&.class\fR file from that directory to \f3my\&.jar\fR: +.sp +.nf +\f3jar uf my\&.jar \-C classes Bar\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.br -.LP -\f3Note:\ \fP A jar command that specifies \f2cfm\fP on the command line instead of \f2cmf\fP (the order of the m and \-f options are reversed), the \f3jar\fP command line must specify the name of the jar archive first, followed by the name of the manifest file: -.nf -\f3 -.fl -% jar cfm myFile.jar myManifestFile *.class -.fl -\fP -.fi +The following command changes to the \f3classes\fR directory and adds to \f3my\&.jar\fR all files within the classes directory (without creating a \f3classes\fR directory in the JAR file), then changes back to the original directory before changing to the \f3bin\fR directory to add \f3Xyz\&.class\fR to \f3my\&.jar\fR\&. +.sp +.nf +\f3jar uf my\&.jar \-C classes \&. \-C bin Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -The manifest is in a text format inspired by RFC822 ASCII format, so it is easy to view and process manifest\-file contents. -.LP -To extract the files from a jar file, use \f2x\fP: -.LP -.nf -\f3 -.fl -% jar xf myFile.jar -.fl -\fP -.fi -.LP -.LP -To extract individual files from a jar file, supply their filenames: -.LP -.nf -\f3 -.fl -% jar xf myFile.jar foo bar -.fl -\fP -.fi +If \f3classes\fR contained files \f3bar1\fR and \f3bar2\fR, then the JAR file will contain the following after running the previous command: +.sp +.nf +\f3% \fIjar tf my\&.jar\fR\fP +.fi +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3bar1\fP +.fi +.nf +\f3bar2\fP +.fi +.nf +\f3Xyz\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -Beginning with version 1.3 of the JDK, the \f2jar\fP utility supports -.na -\f2JarIndex\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index, which allows application class loaders to load classes more efficiently from jar files. If an application or applet is bundled into multiple jar files,\ only the necessary jar files will be downloaded and opened to load classes. This performance optimization is enabled by running \f2jar\fP with the \f2\-i\fPoption. It will generate package location information for the specified main jar file and all the jar files it depends on, which need to be specified in the \f2Class\-Path\fP attribute of the main jar file's manifest. -.LP -.nf -\f3 -.fl -% jar i main.jar -.fl -\fP -.fi +.TP +\fI\fR-J\fIoption\fR +Sets the specified JVM option to be used when the JRE runs the JAR file\&. JVM options are described on the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH OPERANDS +The following operands are recognized by the \f3jar\fR command\&. +.TP +\fIfile\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIfile\fR operand defines the path and name of the file or directory that should be added to the archive\&. When extracting (\f3x\fR) or listing the contents (\f3t\fR) of a JAR file, the \fIfile\fR operand defines the path and name of the file to be extrated or listed\&. At least one valid file or directory must be specified\&. Separate multiple \fIfile\fR operands with spaces\&. If the \fIentrypoint\fR, \fIjarfile\fR, or \fImanifest\fR operands are used, the \fIfile\fR operands must be specified after them\&. +.TP +\fIentrypoint\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fIentrypoint\fR operand defines the name of the class that should be the entry point\f3\fR for a standalone Java application bundled into an executable JAR file\&. The \fIentrypoint\fR operand must be specified if the \f3e\fR option is present\&. +.TP +\fIjarfile\fR +Defines the name of the file to be created (\f3c\fR), updated (\f3u\fR), extracted (\f3x\fR), or viewed (\f3t\fR)\&. The \fIjarfile\fR operand must be specified if the \f3f\fR option is present\&. Omitting the \f3f\fR option and the \fIjarfile\fR operand instructs the \f3jar\fR command to accept the JAR file name from \f3stdin\fR (for \f3x\fR and \f3t\fR) or send the JAR \f3\fRfile to \f3stdout\fR (for \f3c\fR and \f3u\fR)\&. -.LP -.LP -In this example, an \f2INDEX.LIST\fP file is inserted into the \f2META\-INF\fP directory of \f2main.jar\fP. -.br -.br -The application class loader uses the information stored in this file for efficient class loading.\ For details about how location information is stored in the index file, refer to the \f2JarIndex\fP specification. -.br -.br -To copy directories, first compress files in \f2dir1\fP to \f2stdout\fP, then extract from \f2stdin\fP to \f2dir2\fP (omitting the \f2\-f\fP option from both \f2jar\fP commands): -.LP -.nf -\f3 -.fl -% (cd dir1; jar c .) | (cd dir2; jar x) -.fl -\fP -.fi +When indexing (\f3i\fR) a JAR file, specify the \fIjarfile\fR operand without the \f3f\fR option\&. +.TP +\fImanifest\fR +When creating (\f3c\fR) or updating (\f3u\fR) a JAR file, the \fImanifest\fR operand defines the preexisting manifest files with names and values of attributes to be included in \f3MANIFEST\&.MF\fR in the JAR file\&. The \fImanifest\fR operand must be specified if the \f3f\fR option is present\&. +.TP +\fI@arg-file\fR +To shorten or simplify the \f3jar\fR command, you can specify arguments in a separate text file and pass it to the \f3jar\fR command with the at sign (@) as a prefix\&. When the \f3jar\fR command encounters an argument beginning with the at sign, it expands the contents of that file into the argument list\&. -.LP -.LP -To review command samples which use \f2jar\fP to opeate on jar files and jar file manifests, see Examples, below. Also refer to the jar trail of the -.na -\f2Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -c -Creates a new archive file named \f2jarfile\fP (if \f2f\fP is specified) or to standard output (if \f2f\fP and \f2jarfile\fP are omitted). Add to it the files and directories specified by \f2inputfiles\fP. -.TP 3 -u -Updates an existing file \f2jarfile\fP (when \f2f\fP is specified) by adding to it files and directories specified by \f2inputfiles\fP. For example: -.nf -\f3 -.fl -jar uf foo.jar foo.class -.fl -\fP -.fi -would add the file \f2foo.class\fP to the existing jar file \f2foo.jar\fP. The \f2\-u\fP option can also update the manifest entry, as given by this example: -.nf -\f3 -.fl -jar umf manifest foo.jar -.fl -\fP -.fi -updates the \f2foo.jar\fP manifest with the \f2name : value\fP pairs in \f2manifest\fP. -.TP 3 -x -Extracts files and directories from \f2jarfile\fP (if \f2f\fP is specified) or standard input (if \f2f\fP and \f2jarfile\fP are omitted). If \f2inputfiles\fP is specified, only those specified files and directories are extracted. Otherwise, all files and directories are extracted. The time and date of the extracted files are those given in the archive. -.TP 3 -t -Lists the table of contents from \f2jarfile\fP (if \f2f\fP is specified) or standard input (if \f2f\fP and \f2jarfile\fP are omitted). If \f2inputfiles\fP is specified, only those specified files and directories are listed. Otherwise, all files and directories are listed. -.TP 3 -i -Generate index information for the specified \f2jarfile\fP and its dependent jar files. For example: -.nf -\f3 -.fl -jar i foo.jar -.fl -\fP -.fi -.LP -would generate an \f2INDEX.LIST\fP file in \f2foo.jar\fP which contains location information for each package in \f2foo.jar\fP and all the jar files specified in the \f2Class\-Path\fP attribute of \f2foo.jar\fP. See the index example. -.TP 3 -f -Specifies the file \f2jarfile\fP to be created (\f2c\fP), updated (\f2u\fP), extracted (\f2x\fP), indexed (\f2i\fP), or viewed (\f2t\fP). The \f2\-f\fP option and filename \f2jarfile\fP are a pair \-\- if present, they must both appear. Omitting \f2f\fP and \f2jarfile\fP accepts a jar file name from \f2stdin\fP(for x and t) or sends jar file to \f2stdout\fP (for c and u). -.TP 3 -v -Generates verbose output to standard output. Examples shown below. -.TP 3 -0 -(zero) Store without using ZIP compression. -.TP 3 -M -Do not create a manifest file entry (for c and u), or delete a manifest file entry if one exists (for u). -.TP 3 -m -Includes \f2name : value\fP attribute pairs from the specified manifest file \f2manifest\fP in the file at \f2META\-INF/MANIFEST.MF\fP. \f2jar\fP adds a \f2name\ :\ value\fP pair unless an entry already exists with the same name, in which case \f2jar\fP updates its value. -.br -.br -On the command line, the letters \f3m\fP and \f3f\fP must appear in the same order that \f2manifest\fP and \f2jarfile\fP appear. Example use: -.nf -\f3 -.fl -jar cmf myManifestFile myFile.jar *.class -.fl -\fP -.fi -You can add special\-purpose \f2name\ :\ value\fP attribute pairs to the manifest that aren't contained in the default manifest. For example, you can add attributes specifying vendor information, version information, package sealing, or to make JAR\-bundled applications executable. See the -.na -\f2JAR Files\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar/ trail in the Java Tutorial for examples of using the \f4\-m\fP option. -.TP 3 -e -Sets \f2entrypoint\fP as the application entry point for stand\-alone applications bundled into executable jar file. The use of this option creates or overrides the \f2Main\-Class\fP attribute value in the manifest file. This option can be used during creation of jar file or while updating the jar file. This option specifies the application entry point without editing or creating the manifest file. -.br -.br -.br -For example, this command creates \f2Main.jar\fP where the \f2Main\-Class\fP attribute value in the manifest is set to \f2Main\fP: -.nf -\f3 -.fl -jar cfe Main.jar Main Main.class -.fl -\fP -.fi -The java runtime can directly invoke this application by running the following command: -.nf -\f3 -.fl -java \-jar Main.jar -.fl -\fP -.fi -If the entrypoint class name is in a package it may use either a dot (".") or slash ("/") character as the delimiter. For example, if \f2Main.class\fP is in a package called \f2foo\fP the entry point can be specified in the following ways: -.nf -\f3 -.fl -jar \-cfe Main.jar foo/Main foo/Main.class -.fl -\fP -.fi -or -.nf -\f3 -.fl -jar \-cfe Main.jar foo.Main foo/Main.class -.fl -\fP -.fi -\f3Note:\ \fP specifying both \f2\-m\fP and \f2\-e\fP options together when the given manifest also contains the \f2Main\-Class\fP attribute results in an ambigous \f2Main.class\fP specification, leading to an error and the jar creation or update operation is aborted. -.TP 3 -\-C\ dir -Temporarily changes directories (\f2cd\fP\ \f2dir\fP) during execution of the \f2jar\fP command while processing the following \f2inputfiles\fP argument. Its operation is intended to be similar to the \f2\-C\fP option of the UNIX \f2tar\fP utility. -.br -.br -For example, this command changes to the \f2classes\fP directory and adds the \f2bar.class\fP from that directory to \f2foo.jar\fP: -.nf -\f3 -.fl -jar uf foo.jar \-C classes bar.class -.fl -\fP -.fi -This command changes to the \f2classes\fP directory and adds to \f2foo.jar\fP all files within the \f2classes\fP directory (without creating a classes directory in the jar file), then changes back to the original directory before changing to the \f2bin\fP directory to add \f2xyz.class\fP to \f2foo.jar\fP. -.nf -\f3 -.fl -jar uf foo.jar \-C classes . \-C bin xyz.class -.fl -\fP -.fi -If \f2classes\fP holds files \f2bar1\fP and \f2bar2\fP, then here's what the jar file will contain using \f2jar tf foo.jar\fP: -.nf -\f3 -.fl -META\-INF/ -.fl -META\-INF/MANIFEST.MF -.fl -bar1 -.fl -bar2 -.fl -xyz.class -.fl -\fP -.fi -.LP -.TP 3 -\-Joption -Pass \f2option\fP to the Java runtime environment, where \f2option\fP is one of the options described on the reference page for the java application launcher. For example, \f4\-J\-Xmx48M\fP sets the maximum memory to 48 megabytes. It is a common convention for \f2\-J\fP to pass options to the underlying runtime environment. -.RE +An argument file can include options and arguments of the \f3jar\fR command (except the \f3-J\fR options, because they are passed to the launcher, which does not support argument files)\&. The arguments within a file can be separated by spaces or newline characters\&. File names within an argument file are relative to the current directory from which you run the \f3jar\fR command, not relative to the location of the argument file\&. Wild cards, such as the asterisk (*), that might otherwise be expanded by the operating system shell, are not expanded\&. -.LP -.SH "COMMAND LINE ARGUMENT FILES" -.LP -To shorten or simplify the jar command line, you can specify one or more files that themselves contain arguments to the \f2jar\fP command (except \f2\-J\fP options). This enables you to create jar commands of any length, overcoming command line limits imposed by the operating system. -.LP -An argument file can include options and filenames. The arguments within a file can be space\-separated or newline\-separated. Filenames within an argument file are relative to the current directory, not relative to the location of the argument file. Wildcards (*) that might otherwise be expanded by the operating system shell are not expanded. Use of the \f2@\fP character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -.LP -When executing \f2jar\fP, pass in the path and name of each argument file with the \f2@\fP leading character. When \f2jar\fP encounters an argument beginning with the character \f2@\fP, it expands the contents of that file into the argument list. -.br -.br -The example below, \f2classes.list\fP holds the names of files output by a \f2find\fP command: -.LP -.nf -\f3 -.fl -% find \fP\f3.\fP \-name '*.class' \-print > classes.list -.fl -.fi +The following example, shows how to create a \f3classes\&.list\fR file with names of files from the current directory output by the \f3find\fR command: +.sp +.nf +\f3find \&. \-name \&'*\&.class\&' \-print > classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -You can then execute the \f2jar\fP command on \f2Classes.list\fP by passing it to \f2jar\fP using argfile syntax: -.LP -.nf -\f3 -.fl -% jar cf my.jar @classes.list -.fl -\fP -.fi -.LP -An argument file can specify a path, but any filenames inside the argument file that have relative paths are relative to the current working directory, not to the path passed in. Here is an example: -.nf -\f3 -.fl -% jar @path1/classes.list -.fl -\fP -.fi +You can then execute the \f3jar\fR command and pass the \f3classes\&.list\fR file to it using the \fI@arg-file\fR syntax: +.sp +.nf +\f3jar cf my\&.jar @classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -.LP -.SH "EXAMPLES" -.LP -To add all the files in a particular directory to an archive (overwriting contents if the archive already exists). Enumerating verbosely (with the \f2\-v\fP option) will tell you more information about the files in the archive, such as their size and last modified date. -.nf -\f3 -.fl -% ls -.fl -1.au Animator.class monkey.jpg -.fl -2.au Wave.class spacemusic.au -.fl -3.au at_work.gif -.fl +An argument file can be specified with a path, but any file names inside the argument file that have relative paths are relative to the current working directory of the \f3jar\fR command, not to the path passed in, for example: +.sp +.nf +\f3jar @dir/classes\&.list\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -% jar cvf bundle.jar * -.fl -added manifest -.fl -adding: 1.au(in = 2324) (out= 67)(deflated 97%) -.fl -adding: 2.au(in = 6970) (out= 90)(deflated 98%) -.fl -adding: 3.au(in = 11616) (out= 108)(deflated 99%) -.fl -adding: Animator.class(in = 2266) (out= 66)(deflated 97%) -.fl -adding: Wave.class(in = 3778) (out= 81)(deflated 97%) -.fl -adding: at_work.gif(in = 6621) (out= 89)(deflated 98%) -.fl -adding: monkey.jpg(in = 7667) (out= 91)(deflated 98%) -.fl -adding: spacemusic.au(in = 3079) (out= 73)(deflated 97%) -.fl -\fP -.fi - -.LP -If you already have separate subdirectories for images, audio files and classes, you can combine them into a single jar file: -.nf -\f3 -.fl -% ls \-F -.fl -audio/ classes/ images/ -.fl - -.fl -% jar cvf bundle.jar audio classes images -.fl -added manifest -.fl -adding: audio/(in = 0) (out= 0)(stored 0%) -.fl -adding: audio/1.au(in = 2324) (out= 67)(deflated 97%) -.fl -adding: audio/2.au(in = 6970) (out= 90)(deflated 98%) -.fl -adding: audio/3.au(in = 11616) (out= 108)(deflated 99%) -.fl -adding: audio/spacemusic.au(in = 3079) (out= 73)(deflated 97%) -.fl -adding: classes/(in = 0) (out= 0)(stored 0%) -.fl -adding: classes/Animator.class(in = 2266) (out= 66)(deflated 97%) -.fl -adding: classes/Wave.class(in = 3778) (out= 81)(deflated 97%) -.fl -adding: images/(in = 0) (out= 0)(stored 0%) -.fl -adding: images/monkey.jpg(in = 7667) (out= 91)(deflated 98%) -.fl -adding: images/at_work.gif(in = 6621) (out= 89)(deflated 98%) -.fl - -.fl -% ls \-F -.fl -audio/ bundle.jar classes/ images/ -.fl -\fP -.fi - -.LP -To see the entry names in the jarfile, use the \f2t\fP option: -.nf -\f3 -.fl -% jar tf bundle.jar -.fl -META\-INF/ -.fl -META\-INF/MANIFEST.MF -.fl -audio/1.au -.fl -audio/2.au -.fl -audio/3.au -.fl -audio/spacemusic.au -.fl -classes/Animator.class -.fl -classes/Wave.class -.fl -images/monkey.jpg -.fl -images/at_work.gif -.fl -\fP -.fi - -.LP -.LP -To add an index file to the jar file for speeding up class loading, use the \f2i\fP option. -.br -.br -Example: -.br - -.LP -If you split the inter\-dependent classes for a stock trade application into three jar files: \f2main.jar\fP, \f2buy.jar\fP, and \f2sell.jar\fP. -.br - -.LP -.br - -.LP -If you specify the \f2Class\-path\fP attribute in the \f2main.jar\fP manifest as: -.nf -\f3 -.fl -Class\-Path: buy.jar sell.jar -.fl -\fP -.fi - -.LP -then you can use the \f2\-i\fP option to speed up the class loading time for your application: -.nf -\f3 -.fl -% jar i main.jar -.fl -\fP -.fi - -.LP -An \f2INDEX.LIST\fP file is inserted to the \f2META\-INF\fP directory. This enables the application class loader to download the specified jar files when it is searching for classes or resources. -.SH "SEE ALSO" -.LP -.LP -.na -\f2The Jar Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jarGuide.html -.LP -.LP -.na -\f2The Jar File Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html -.LP -.LP -.na -\f2The JarIndex Spec\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index -.LP -.LP -.na -\f2Jar Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar/index.html -.LP -.LP -pack200(1) -.LP - +.SH NOTES +The \f3e\fR, \f3f\fR, and \f3m\fR options must appear in the same order on the command line as the \fIentrypoint\fR, \fIjarfile\fR, and \fImanifest\fR operands, for example: +.sp +.nf +\f3jar cmef myManifestFile MyMainClass myFile\&.jar *\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXAMPLES +\f3Example 1 Adding All Files From the Current Directory With Verbose Output\fR +.sp +.nf +\f3% ls\fP +.fi +.nf +\f31\&.au Animator\&.class monkey\&.jpg\fP +.fi +.nf +\f32\&.au Wave\&.class spacemusic\&.au\fP +.fi +.nf +\f33\&.au at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% jar cvf bundle\&.jar *\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: 1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: 2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: 3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3adding: monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Adding Files From Subdirectories\fR +.sp +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ classes/ images/\fP +.fi +.nf +\f3% jar cvf bundle\&.jar audio classes images\fP +.fi +.nf +\f3added manifest\fP +.fi +.nf +\f3adding: audio/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: audio/1\&.au(in = 2324) (out= 67)(deflated 97%)\fP +.fi +.nf +\f3adding: audio/2\&.au(in = 6970) (out= 90)(deflated 98%)\fP +.fi +.nf +\f3adding: audio/3\&.au(in = 11616) (out= 108)(deflated 99%)\fP +.fi +.nf +\f3adding: audio/spacemusic\&.au(in = 3079) (out= 73)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: classes/Animator\&.class(in = 2266) (out= 66)(deflated 97%)\fP +.fi +.nf +\f3adding: classes/Wave\&.class(in = 3778) (out= 81)(deflated 97%)\fP +.fi +.nf +\f3adding: images/(in = 0) (out= 0)(stored 0%)\fP +.fi +.nf +\f3adding: images/monkey\&.jpg(in = 7667) (out= 91)(deflated 98%)\fP +.fi +.nf +\f3adding: images/at_work\&.gif(in = 6621) (out= 89)(deflated 98%)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3% ls \-F\fP +.fi +.nf +\f3audio/ bundle\&.jar classes/ images/\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Listing the Contents of JAR\fR +.sp +.nf +\f3% jar tf bundle\&.jar\fP +.fi +.sp +.sp +.nf +\f3META\-INF/\fP +.fi +.nf +\f3META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3audio/1\&.au\fP +.fi +.nf +\f3audio/2\&.au\fP +.fi +.nf +\f3audio/3\&.au\fP +.fi +.nf +\f3audio/spacemusic\&.au\fP +.fi +.nf +\f3classes/Animator\&.class\fP +.fi +.nf +\f3classes/Wave\&.class\fP +.fi +.nf +\f3images/monkey\&.jpg\fP +.fi +.nf +\f3images/at_work\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Adding an Index\fR +.PP +Use the \f3i\fR option when you split the interdependent classes for a stock trade application into three JAR files: \f3main\&.jar\fR, \f3buy\&.jar\fR, and \f3sell\&.jar\fR\&. If you specify the \f3Class-Path\fR attribute in the \f3main\&.jar\fR manifest, then you can use the \f3i\fR option to speed up the class loading time for your application: +.sp +.nf +\f3Class\-Path: buy\&.jar sell\&.jar\fP +.fi +.nf +\f3jar i main\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +An \f3INDEX\&.LIST\fR file is inserted to the \f3META-INF\fR directory\&. This enables the application class loader to download the specified JAR files when it is searching for classes or resources\&. +.PP +The application class loader uses the information stored in this file for efficient class loading\&. To copy directories, first compress files in \f3dir1\fR to \f3stdout\fR, then pipeline and extract from \f3stdin\fR to \f3dir2\fR (omitting the \f3-f\fR option from both \f3jar\fR commands): +.sp +.nf +\f3(cd dir1; jar c \&.) | (cd dir2; jar x)\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1)\&. +.TP 0.2i +\(bu +The JAR section of The Java Tutorials at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jarsigner.1 b/jdk/src/solaris/doc/sun/man/man1/jarsigner.1 index b2f7777af3c..9394a1079a9 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jarsigner.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jarsigner.1 @@ -1,1569 +1,985 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jarsigner 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: jarsigner.1 +.\" +.if n .pl 99999 +.TH jarsigner 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jarsigner \- JAR Signing and Verification Tool -.LP -.LP -Generates signatures for Java ARchive (JAR) files, and verifies the signatures of signed JAR files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jarsigner\fP [ options ] jar\-file alias -.fl -\f3jarsigner\fP \-verify [ options ] jar\-file [alias...] -.fl -.fi +.SH NAME +jarsigner \- Signs and verifies Java Archive (JAR) files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -The jarsigner \-verify command can take zero or more keystore alias names after the jar filename. When specified, jarsigner will check that the certificate used to verify each signed entry in the jar file matches one of the keystore aliases. The aliases are defined in the keystore specified by \-keystore, or the default keystore. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jarsigner\fP tool is used for two purposes: -.LP -.RS 3 -.TP 3 -1. -to sign Java ARchive (JAR) files, and -.TP 3 -2. -to verify the signatures and integrity of signed JAR files. -.RE +\fBjarsigner\fR [ \fIoptions\fR ] \fIjar\-file\fR \fIalias\fR +.fi +.nf -.LP -.LP -The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution. A tool named jar(1) enables developers to produce JAR files. (Technically, any zip file can also be considered a JAR file, although when created by \f3jar\fP or processed by \f3jarsigner\fP, JAR files also contain a META\-INF/MANIFEST.MF file.) -.LP -.LP -A \f2digital signature\fP is a string of bits that is computed from some data (the data being "signed") and the private key of an entity (a person, company, etc.). Like a handwritten signature, a digital signature has many useful characteristics: -.LP -.RS 3 -.TP 2 -o -Its authenticity can be verified, via a computation that uses the public key corresponding to the private key used to generate the signature. -.TP 2 -o -It cannot be forged, assuming the private key is kept secret. -.TP 2 -o -It is a function of the data signed and thus can't be claimed to be the signature for other data as well. -.TP 2 -o -The signed data cannot be changed; if it is, the signature will no longer verify as being authentic. -.RE +\fBjarsigner\fR \fB\-verify\fR [ \fIoptions\fR ] \fIjar\-file\fR [\fIalias \&.\&.\&.\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +-verify +.br +The \f3-verify\fR option can take zero or more keystore alias names after the JAR file name\&. When the \f3-verify\fR option is specified, the \f3jarsigner\fR command checks that the certificate used to verify each signed entry in the JAR file matches one of the keystore aliases\&. The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. -.LP -.LP -In order for an entity's signature to be generated for a file, the entity must first have a public/private key pair associated with it, and also one or more certificates authenticating its public key. A \f2certificate\fP is a digitally signed statement from one entity, saying that the public key of some other entity has a particular value. -.LP -.LP -\f3jarsigner\fP uses key and certificate information from a \f2keystore\fP to generate digital signatures for JAR files. A keystore is a database of private keys and their associated X.509 certificate chains authenticating the corresponding public keys. The keytool(1) utility is used to create and administer keystores. -.LP -.LP -\f3jarsigner\fP uses an entity's private key to generate a signature. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file. \f3jarsigner\fP can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file). -.LP -.LP -\f3jarsigner\fP can generate signatures that include a timestamp, thus enabling systems/deployer (including Java Plug\-in) to check whether the JAR file was signed while the signing certificate was still valid. In addition, APIs will allow applications to obtain the timestamp information. -.LP -.LP -At this time, \f3jarsigner\fP can only sign JAR files created by the SDK jar(1) tool or zip files. (JAR files are the same as zip files, except they also have a META\-INF/MANIFEST.MF file. Such a file will automatically be created when \f3jarsigner\fP signs a zip file.) -.LP -.LP -The default \f3jarsigner\fP behavior is to \f2sign\fP a JAR (or zip) file. Use the \f2\-verify\fP option to instead have it \f2verify\fP a signed JAR file. -.LP -.SS -Keystore Aliases -.LP -.LP -All keystore entities are accessed via unique \f2aliases\fP. -.LP -.LP -When using \f3jarsigner\fP to sign a JAR file, you must specify the alias for the keystore entry containing the private key needed to generate the signature. For example, the following will sign the JAR file named "MyJARFile.jar", using the private key associated with the alias "duke" in the keystore named "mystore" in the "working" directory. Since no output file is specified, it overwrites MyJARFile.jar with the signed JAR file. -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3 -.fl - \-keypass \fP\f4<private key password>\fP\f3 MyJARFile.jar duke -.fl -\fP -.fi +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar verified, with signer errors" is displayed\&. +.TP +\fIjar-file\fR +The JAR file to be signed\&. -.LP -.LP -Keystores are protected with a password, so the store password must be specified. You will be prompted for it if you don't specify it on the command line. Similarly, private keys are protected in a keystore with a password, so the private key's password must be specified, and you will be prompted for it if you don't specify it on the command line and it isn't the same as the store password. -.LP -.SS -Keystore Location -.LP -.LP -\f3jarsigner\fP has a \f2\-keystore\fP option for specifying the URL of the keystore to be used. The keystore is by default stored in a file named \f2.keystore\fP in the user's home directory, as determined by the \f2user.home\fP system property. On Solaris systems \f2user.home\fP defaults to the user's home directory. -.LP -.LP -Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based, for example, if it resides on a hardware token device. -.LP -.SS -Keystore Implementation -.LP -.LP -The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore. -.LP -.LP -Currently, there are two command\-line tools that make use of keystore implementations (\f3keytool\fP and \f3jarsigner\fP), and also a GUI\-based tool named \f3Policy Tool\fP. Since \f2KeyStore\fP is publicly available, Java 2 SDK users can write additional security applications that use it. -.LP -.LP -There is a built\-in default implementation, provided by Sun Microsystems. It implements the keystore as a file, utilizing a proprietary keystore type (format) named "JKS". It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password. -.LP -.LP -Keystore implementations are provider\-based. More specifically, the application interfaces supplied by \f2KeyStore\fP are implemented in terms of a "Service Provider Interface" (SPI). That is, there is a corresponding abstract \f2KeystoreSpi\fP class, also in the \f2java.security\fP package, which defines the Service Provider Interface methods that "providers" must implement. (The term "provider" refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API.) Thus, to provide a keystore implementation, clients must implement a provider and supply a KeystoreSpi subclass implementation, as described in -.na -\f2How to Implement a Provider for the Java Cryptography Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html. -.LP -.LP -Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible. -.LP -.LP -\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL. -.LP -.LP -For \f3jarsigner\fP and \f3keytool\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Change Keystore" command in the Edit menu. -.LP -.LP -If you don't explicitly specify a keystore type, the tools choose a keystore implementation based simply on the value of the \f2keystore.type\fP property specified in the security properties file. The security properties file is called \f2java.security\fP, and it resides in the SDK security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -.LP -Each tool gets the \f2keystore.type\fP value and then examines all the currently\-installed providers until it finds one that implements keystores of that type. It then uses the keystore implementation from that provider. -.LP -.LP -The \f2KeyStore\fP class defines a static method named \f2getDefaultType\fP that lets applications and applets retrieve the value of the \f2keystore.type\fP property. The following line of code creates an instance of the default keystore type (as specified in the \f2keystore.type\fP property): -.LP -.nf -\f3 -.fl - KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); -.fl -\fP -.fi +If you also specified the \f3-strict\fR option, and the \f3jarsigner\fR command detected severe warnings, the message, "jar signed, with signer errors" is displayed\&. +.TP +\fIalias\fR +The aliases are defined in the keystore specified by \f3-keystore\fR or the default keystore\&. +.SH DESCRIPTION +The \f3jarsigner\fR tool has two purposes: +.TP 0.2i +\(bu +To sign Java Archive (JAR) files\&. +.TP 0.2i +\(bu +To verify the signatures and integrity of signed JAR files\&. +.PP +The JAR feature enables the packaging of class files, images, sounds, and other digital data in a single file for faster and easier distribution\&. A tool named \f3jar\fR enables developers to produce JAR files\&. (Technically, any zip file can also be considered a JAR file, although when created by the \f3jar\fR command or processed by the \f3jarsigner\fR command, JAR files also contain a \f3META-INF/MANIFEST\&.MF\fR file\&.) +.PP +A digital signature is a string of bits that is computed from some data (the data being signed) and the private key of an entity (a person, company, and so on)\&. Similar to a handwritten signature, a digital signature has many useful characteristics: +.TP 0.2i +\(bu +Its authenticity can be verified by a computation that uses the public key corresponding to the private key used to generate the signature\&. +.TP 0.2i +\(bu +It cannot be forged, assuming the private key is kept secret\&. +.TP 0.2i +\(bu +It is a function of the data signed and thus cannot be claimed to be the signature for other data as well\&. +.TP 0.2i +\(bu +The signed data cannot be changed\&. If the data is changed, then the signature cannot be verified as authentic\&. +.PP +To generate an entity\&'s signature for a file, the entity must first have a public/private key pair associated with it and one or more certificates that authenticate its public key\&. A certificate is a digitally signed statement from one entity that says that the public key of another entity has a particular value\&. +.PP +The \f3jarsigner\fR command uses key and certificate information from a keystore to generate digital signatures for JAR files\&. A keystore is a database of private keys and their associated X\&.509 certificate chains that authenticate the corresponding public keys\&. The \f3keytool\fR command is used to create and administer keystores\&. +.PP +The \f3jarsigner\fR command uses an entity\&'s private key to generate a signature\&. The signed JAR file contains, among other things, a copy of the certificate from the keystore for the public key corresponding to the private key used to sign the file\&. The \f3jarsigner\fR command can verify the digital signature of the signed JAR file using the certificate inside it (in its signature block file)\&. +.PP +The \f3jarsigner\fR command can generate signatures that include a time stamp that lets a systems or deployer (including Java Plug-in) to check whether the JAR file was signed while the signing certificate was still valid\&. In addition, APIs allow applications to obtain the timestamp information\&. +.PP +At this time, the \f3jarsigner\fR command can only sign JAR files created by the \f3jar\fR command or zip files\&. JAR files are the same as zip files, except they also have a \f3META-INF/MANIFEST\&.MF\fR file\&. A \f3META-INF/MANIFEST\&.MF\fR file is created when the \f3jarsigner\fR command signs a zip file\&. +.PP +The default \f3jarsigner\fR command behavior is to sign a JAR or zip file\&. Use the \f3-verify\fR option to verify a signed JAR file\&. +.PP +The \f3jarsigner\fR command also attempts to validate the signer\&'s certificate after signing or verifying\&. If there is a validation error or any other problem, the command generates warning messages\&. If you specify the \f3-strict\fR option, then the command treats severe warnings as errors\&. See Errors and Warnings\&. +.SS KEYSTORE\ ALIASES +All keystore entities are accessed with unique aliases\&. +.PP +When you use the \f3jarsigner\fR command to sign a JAR file, you must specify the alias for the keystore entry that contains the private key needed to generate the signature\&. For example, the following command signs the JAR file named \f3MyJARFile\&.jar\fR with the private key associated with the alias \f3duke\fR in the keystore named \f3mystore\fR in the \f3working\fR directory\&. Because no output file is specified, it overwrites \f3MyJARFile\&.jar\fR with the signed JAR file\&. +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password> MyJARFile\&.jar duke\fP +.fi +.nf +\f3\fR +.fi +.sp +Keystores are protected with a password, so the store password must be specified\&. You are prompted for it when you do not specify it on the command line\&. Similarly, private keys are protected in a keystore with a password, so the private key\&'s password must be specified, and you are prompted for the password when you do not specify it on the command line and it is not the same as the store password\&. +.SS KEYSTORE\ LOCATION +The \f3jarsigner\fR command has a \f3-keystore\fR option for specifying the URL of the keystore to be used\&. The keystore is by default stored in a file named \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. +.PP +On Oracle Solaris systems, \f3user\&.home\fR defaults to the user\&'s home directory\&. +.PP +The input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified when the \f3KeyStore\fR class is not file based, for example, when it resides on a hardware token device\&. +.SS KEYSTORE\ IMPLEMENTATION +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies a number of well-defined interfaces to access and modify the information in a keystore\&. You can have multiple different concrete implementations, where each implementation is for a particular type of keystore\&. +.PP +Currently, there are two command-line tools that use keystore implementations (\f3keytool\fR and \f3jarsigner\fR), and a GUI-based tool named Policy Tool\&. Because the \f3KeyStore\fR class is publicly available, JDK users can write additional security applications that use it\&. +.PP +There is a built-in default implementation provided by Oracle that implements the keystore as a file, that uses a proprietary keystore type (format) named JKS\&. The built-in implementation protects each private key with its individual password and protects the integrity of the entire keystore with a (possibly different) password\&. +.PP +Keystore implementations are provider-based, which means the application interfaces supplied by the \f3KeyStore\fR class are implemented in terms of a Service Provider Interface (SPI)\&. There is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, that defines the Service Provider Interface methods that providers must implement\&. The term provider refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html +.PP +Applications can choose different types of keystore implementations from different providers, with the \f3getInstance\fR factory method in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information and the algorithms used to protect private keys in the keystore and the integrity of the keystore itself\&. Keystore implementations of different types are not compatible\&. +.PP +The \f3jarsigner\fR and \f3policytool\fR commands can read file-based keystores from any location that can be specified using a URL\&. In addition, these commands can read non-file-based keystores such as those provided by MSCAPI on Windows and PKCS11 on all platforms\&. +.PP +For the \f3jarsigner\fR and \f3keytool\fR commands, you can specify a keystore type at the command line with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIEdit\fR command in the \fIKeyStore\fR menu\&. +.PP +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and it resides in the JDK security properties directory, \f3java\&.home/lib/security\fR, where \f3java\&.home\fR is the runtime environment\&'s directory\&. The \f3jre\fR directory in the JDK or the top-level directory of the Java Runtime Environment (JRE)\&. +.PP +Each tool gets the \f3keystore\&.type\fR value and then examines all the installed providers until it finds one that implements keystores of that type\&. It then uses the keystore implementation from that provider\&. +.PP +The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type property\fR: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fR +.fi +.sp +The default keystore type is \f3jks\fR (the proprietary type of the keystore implementation provided by Oracle)\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fR +.fi +.sp +Case does not matter in keystore type designations\&. For example, \f3JKS\fR is the same as \f3jks\fR\&. +.PP +To have the tools use a keystore implementation other than the default, change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR If you use the PKCS 11 provider package, then see "KeyTool" and "JarSigner" in Java PKCS #11 Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/p11guide\&.html +.SS SUPPORTED\ ALGORITHMS +By default, the \f3jarsigner\fR command signs a JAR file using one of the following algorithms: +.TP 0.2i +\(bu +Digital Signature Algorithm (DSA) with the SHA1 digest algorithm +.TP 0.2i +\(bu +RSA algorithm with the SHA256 digest algorithm +.TP 0.2i +\(bu +Elliptic Curve (EC) cryptography algorithm with the SHA256 with Elliptic Curve Digital Signature Algorithm (ECDSA)\&. +.PP +If the signer\&'s public and private keys are DSA keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA1withDSA\fR algorithm\&. If the signer\&'s keys are RSA keys, then \f3jarsigner\fR attempts to sign the JAR file with the \f3SHA256withRSA\fR algorithm\&. If the signer\&'s keys are EC keys, then \f3jarsigner\fR signs the JAR file with the \f3SHA256withECDSA\fR algorithm\&. +.PP +These default signature algorithms can be overridden using the \f3-sigalg\fR option\&. +.SS THE\ SIGNED\ JAR\ FILE +When the \f3jarsigner\fR command is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META-INF directory: +.TP 0.2i +\(bu +A signature file with an \f3\&.SF\fR extension +.TP 0.2i +\(bu +A signature block file with a \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR extension +.PP +The base file names for these two files come from the value of the \f3-sigFile\fR option\&. For example, when the option is \f3-sigFile MKSIGN\fR, the files are named \f3MKSIGN\&.SF\fR and \f3MKSIGN\&.DSA\fR +.PP +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to uppercase\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not allowed in a signature file name, then each such character is converted to an underscore (_) character in forming the file name\&. Valid characters include letters, digits, underscores, and hyphens\&. +.PP +Signature File -.LP -.LP -The default keystore type is "jks" (the proprietary type of the keystore implementation provided by Sun). This is specified by the following line in the security properties file: -.LP -.nf -\f3 -.fl - keystore.type=jks -.fl -\fP -.fi +A signature file (\f3\&.SF\fR file) looks similar to the manifest file that is always included in a JAR file when the \f3jarsigner\fR command is used to sign the file\&. For each source file included in the JAR file, the \f3\&.SF\fR file has three lines, such as in the manifest file, that list the following: +.TP 0.2i +\(bu +File name +.TP 0.2i +\(bu +Name of the digest algorithm (SHA) +.TP 0.2i +\(bu +SHA digest value +.PP +In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file\&. In the \f3\&.SF\fR file, the digest value for a specified source file is the hash of the three lines in the manifest file for the source file\&. +.PP +The signature file, by default, includes a header with a hash of the whole manifest file\&. The header also contains a hash of the manifest header\&. The presence of the header enables verification optimization\&. See JAR File Verification\&. +.PP +Signature Block File -.LP -.LP -Note: Case doesn't matter in keystore type designations. For example, "JKS" would be considered the same as "jks". -.LP -.LP -To have the tools utilize a keystore implementation other than the default, change that line to specify a different keystore type. For example, if you have a provider package that supplies a keystore implementation for a keystore type called "pkcs12", change the line to -.LP -.nf -\f3 -.fl - keystore.type=pkcs12 -.fl -\fP -.fi +The \f3\&.SF\fR file is signed and the signature is placed in the signature block file\&. This file also contains, encoded inside it, the certificate or certificate chain from the keystore that authenticates the public key corresponding to the private key used for signing\&. The file has the extension \f3\&.DSA\fR, \f3\&.RSA\fR, or \f3\&.EC\fR, depending on the digest algorithm used\&. +.SS SIGNATURE\ TIME\ STAMP +The \f3jarsigner\fR command can generate and store a signature time stamp when signing a JAR file\&. In addition, \f3jarsigner\fR supports alternative signing mechanisms\&. This behavior is optional and is controlled by the user at the time of signing through these options\&. See Options\&. +.sp +.nf +\f3\-tsa \fIurl\fR\fP +.fi +.nf +\f3\-tsacert \fIalias\fR\fP +.fi +.nf +\f3\-altsigner \fIclass\fR\fP +.fi +.nf +\f3\-altsignerpath \fIclasspathlist\fR\fP +.fi +.nf +\f3\-tsapolicyid \fIpolicyid\fR\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS JAR\ FILE\ VERIFICATION +A successful JAR file verification occurs when the signatures are valid, and none of the files that were in the JAR file when the signatures were generated have changed since then\&. JAR file verification involves the following steps: +.TP 0.4i +1\&. +Verify the signature of the \f3\&.SF\fR file\&. -.LP -.LP -Note that if you us the PKCS#11 provider package, you should refer to the -.na -\f2KeyTool and JarSigner\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#KeyToolJarSigner section of the Java PKCS#11 Reference Guide for details. -.LP -.SS -Supported Algorithms -.LP -.LP -By default, \f3jarsigner\fP signs a JAR file using one of the following: -.LP -.RS 3 -.TP 2 -o -DSA (Digital Signature Algorithm) with the SHA1 digest algorithm -.TP 2 -o -RSA algorithm with the SHA256 digest algorithm. -.TP 2 -o -EC (Elliptic Curve) cryptography algorithm with the SHA256 with ECDSA (Elliptic Curve Digital Signature Algorithm). -.RE +The verification ensures that the signature stored in each signature block (\f3\&.DSA\fR) file was generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the \f3\&.DSA\fR file\&. It also ensures that the signature is a valid signature of the corresponding signature (\f3\&.SF\fR) file, and thus the \f3\&.SF\fR file was not tampered with\&. +.TP 0.4i +2\&. +Verify the digest listed in each entry in the \f3\&.SF\fR file with each corresponding section in the manifest\&. -.LP -.LP -That is, if the signer's public and private keys are DSA keys, \f3jarsigner\fP will sign the JAR file using the "SHA1withDSA" algorithm. If the signer's keys are RSA keys, \f3jarsigner\fP will attempt to sign the JAR file using the "SHA256withRSA" algorithm. If the signer's keys are EC keys, \f3jarsigner\fP will sign the JAR file using the "SHA256withECDSA" algorithm. -.LP -.LP -These default signature algorithms can be overridden using the \f2\-sigalg\fP option. -.LP -.SS -The Signed JAR File -.LP -.LP -When \f3jarsigner\fP is used to sign a JAR file, the output signed JAR file is exactly the same as the input JAR file, except that it has two additional files placed in the META\-INF directory: -.LP -.RS 3 -.TP 2 -o -a signature file, with a .SF extension, and -.TP 2 -o -a signature block file, with a .DSA, .RSA, or .EC extension. -.RE +The \f3\&.SF\fR file by default includes a header that contains a hash of the entire manifest file\&. When the header is present, the verification can check to see whether or not the hash in the header matches the hash of the manifest file\&. If there is a match, then verification proceeds to the next step\&. -.LP -.LP -The base file names for these two files come from the value of the \f2\-sigFile\fP option. For example, if the option appears as -.LP -.nf -\f3 -.fl -\-sigFile MKSIGN -.fl -\fP -.fi +If there is no match, then a less optimized verification is required to ensure that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See Signature File\&. -.LP -.LP -The files are named "MKSIGN.SF" and "MKSIGN.DSA". -.LP -.LP -If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not allowed in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. Legal characters include letters, digits, underscores, and hyphens. -.LP -\f3The Signature (.SF) File\fP -.LP -.LP -A signature file (the .SF file) looks similar to the manifest file that is always included in a JAR file when \f3jarsigner\fP is used to sign the file. That is, for each source file included in the JAR file, the .SF file has three lines, just as in the manifest file, listing the following: -.LP -.RS 3 -.TP 2 -o -the file name, -.TP 2 -o -the name of the digest algorithm used (SHA), and -.TP 2 -o -a SHA digest value. -.RE +One reason the hash of the manifest file that is stored in the \f3\&.SF\fR file header might not equal the hash of the current manifest file is that one or more files were added to the JAR file (with the \f3jar\fR tool) after the signature and \f3\&.SF\fR file were generated\&. When the \f3jar\fR tool is used to add files, the manifest file is changed by adding sections to it for the new files, but the \f3\&.SF\fR file is not changed\&. A verification is still considered successful when none of the files that were in the JAR file when the signature was generated have been changed since then\&. This happens when the hashes in the non-header sections of the \f3\&.SF\fR file equal the hashes of the corresponding sections in the manifest file\&. +.TP 0.4i +3\&. +Read each file in the JAR file that has an entry in the \f3\&.SF\fR file\&. While reading, compute the file\&'s digest and compare the result with the digest for this file in the manifest section\&. The digests should be the same or verification fails\&. -.LP -.LP -In the manifest file, the SHA digest value for each source file is the digest (hash) of the binary data in the source file. In the .SF file, on the other hand, the digest value for a given source file is the hash of the three lines in the manifest file for the source file. -.LP -.LP -The signature file also, by default, includes a header containing a hash of the whole manifest file. The presence of the header enables verification optimization, as described in JAR File Verification. -.LP -\f3The Signature Block File\fP -.LP -The .SF file is signed and the signature is placed in the signature block file. This file also contains, encoded inside it, the certificate or certificate chain from the keystore which authenticates the public key corresponding to the private key used for signing. The file has the extension .DSA, .RSA, or .EC depending on the digest algorithm used. -.SS -Signature Timestamp -.LP -.LP -\f2jarsigner\fP tool can generate and store a signature timestamp when signing a JAR file. In addition, \f2jarsigner\fP supports alternative signing mechanisms. This behavior is optional and is controlled by the user at the time of signing through these options: -.LP -.RS 3 -.TP 2 -o -\f2\-tsa url\fP -.TP 2 -o -\f2\-tsacert alias\fP -.TP 2 -o -\f2\-altsigner class\fP -.TP 2 -o -\f2\-altsignerpath classpathlist\fP -.RE +If any serious verification failures occur during the verification process, then the process is stopped and a security exception is thrown\&. The \f3jarsigner\fR command catches and displays the exception\&. +.PP +\fINote:\fR You should read any addition warnings (or errors if you specified the \f3-strict\fR option), as well as the content of the certificate (by specifying the \f3-verbose\fR and \f3-certs\fR options) to determine if the signature can be trusted\&. +.SS MULTIPLE\ SIGNATURES\ FOR\ A\ JAR\ FILE +A JAR file can be signed by multiple people by running the \f3jarsigner\fR command on the file multiple times and specifying the alias for a different person each time, as follows: +.sp +.nf +\f3jarsigner myBundle\&.jar susan\fP +.fi +.nf +\f3jarsigner myBundle\&.jar kevin\fP +.fi +.nf +\f3\fR +.fi +.sp +When a JAR file is signed multiple times, there are multiple \f3\&.SF\fR and \f3\&.DSA\fR files in the resulting JAR file, one pair for each signature\&. In the previous example, the output JAR file includes files with the following names: +.sp +.nf +\f3SUSAN\&.SF\fP +.fi +.nf +\f3SUSAN\&.DSA\fP +.fi +.nf +\f3KEVIN\&.SF\fP +.fi +.nf +\f3KEVIN\&.DSA\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1\&.1 by the \f3javakey\fR command and others by \f3jarsigner\fR\&. The \f3jarsigner\fR command can be used to sign JAR files that are already signed with the \f3javakey\fR command\&. +.SH OPTIONS +The following sections describe the various \f3jarsigner\fR options\&. Be aware of the following standards: +.TP 0.2i +\(bu +All option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options can be provided in any order\&. +.TP 0.2i +\(bu +Items that are in italics or underlined (option values) represent the actual values that must be supplied\&. +.TP 0.2i +\(bu +The \f3-storepass\fR, \f3-keypass\fR, \f3-sigfile\fR, \f3-sigalg\fR, \f3-digestalg\fR, \f3-signedjar\fR, and TSA-related options are only relevant when signing a JAR file; they are not relevant when verifying a signed JAR file\&. The \f3-keystore\fR option is relevant for signing and verifying a JAR file\&. In addition, aliases are specified when signing and verifying a JAR file\&. +.TP +-keystore \fIurl\fR +.br +Specifies the URL that tells the keystore location\&. This defaults to the file \f3\&.keystore\fR in the user\&'s home directory, as determined by the \f3user\&.home\fR system property\&. -.LP -.LP -Each of these options is detailed in the Options section below. -.LP -.SS -JAR File Verification -.LP -.LP -A successful JAR file verification occurs if the signature(s) are valid, and none of the files that were in the JAR file when the signatures were generated have been changed since then. JAR file verification involves the following steps: -.LP -.RS 3 -.TP 3 -1. -Verify the signature of the .SF file itself. -.br -.br -That is, the verification ensures that the signature stored in each signature block (.DSA) file was in fact generated using the private key corresponding to the public key whose certificate (or certificate chain) also appears in the .DSA file. It also ensures that the signature is a valid signature of the corresponding signature (.SF) file, and thus the .SF file has not been tampered with. -.TP 3 -2. -Verify the digest listed in each entry in the .SF file with each corresponding section in the manifest. -.br -.br -The .SF file by default includes a header containing a hash of the entire manifest file. When the header is present, then the verification can check to see whether or not the hash in the header indeed matches the hash of the manifest file. If that is the case, verification proceeds to the next step. -.br -.br -If that is not the case, a less optimized verification is required to ensure that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file (see The Signature (.SF) File). -.br -.br -One reason the hash of the manifest file that is stored in the .SF file header may not equal the hash of the current manifest file would be because one or more files were added to the JAR file (using the \f2jar\fP tool) after the signature (and thus the .SF file) was generated. When the \f2jar\fP tool is used to add files, the manifest file is changed (sections are added to it for the new files), but the .SF file is not. A verification is still considered successful if none of the files that were in the JAR file when the signature was generated have been changed since then, which is the case if the hashes in the non\-header sections of the .SF file equal the hashes of the corresponding sections in the manifest file. -.TP 3 -3. -Read each file in the JAR file that has an entry in the .SF file. While reading, compute the file's digest, and then compare the result with the digest for this file in the manifest section. The digests should be the same, or verification fails. -.RE +A keystore is required when signing\&. You must explicitly specify a keystore when the default keystore does not exist or if you want to use one other than the default\&. -.LP -.LP -If any serious verification failures occur during the verification process, the process is stopped and a security exception is thrown. It is caught and displayed by \f3jarsigner\fP. -.LP -.SS -Multiple Signatures for a JAR File -.LP -.LP -A JAR file can be signed by multiple people simply by running the \f3jarsigner\fP tool on the file multiple times, specifying the alias for a different person each time, as in: -.LP -.nf -\f3 -.fl - jarsigner myBundle.jar susan -.fl - jarsigner myBundle.jar kevin -.fl -\fP -.fi +A keystore is not required when verifying, but if one is specified or the default exists and the \f3-verbose\fR option was also specified, then additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore\&. -.LP -.LP -When a JAR file is signed multiple times, there are multiple .SF and .DSA files in the resulting JAR file, one pair for each signature. Thus, in the example above, the output JAR file includes files with the following names: -.LP -.nf -\f3 -.fl - SUSAN.SF -.fl - SUSAN.DSA -.fl - KEVIN.SF -.fl - KEVIN.DSA -.fl -\fP -.fi +The \f3-keystore\fR argument can be a file name and path specification rather than a URL, in which case it is treated the same as a file: URL, for example, the following are equivalent: +.sp +.nf +\f3\-keystore \fIfilePathAndName\fR\fP +.fi +.nf +\f3\-keystore file:\fIfilePathAndName\fR\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.LP -Note: It is also possible for a JAR file to have mixed signatures, some generated by the JDK 1.1 \f3javakey\fP tool and others by \f3jarsigner\fP. That is, \f3jarsigner\fP can be used to sign JAR files already previously signed using \f3javakey\fP. -.LP -.SH "OPTIONS" -.LP -.LP -The various \f3jarsigner\fP options are listed and described below. Note: -.LP -.RS 3 -.TP 2 -o -All option names are preceded by a minus sign (\-). -.TP 2 -o -The options may be provided in any order. -.TP 2 -o -Items in italics (option values) represent the actual values that must be supplied. -.TP 2 -o -The \f2\-keystore\fP, \f2\-storepass\fP, \f2\-keypass\fP, \f2\-sigfile\fP, \f2\-sigalg\fP, \f2\-digestalg\fP, and \f2\-signedjar\fP options are only relevant when signing a JAR file, not when verifying a signed JAR file. Similarly, an alias is only specified on the command line when signing a JAR file. -.RE -.LP -.RS 3 -.TP 3 -\-keystore url -Specifies the URL that tells the keystore location. This defaults to the file \f2.keystore\fP in the user's home directory, as determined by the "user.home" system property. -.br -.br -A keystore is required when signing, so you must explicitly specify one if the default keystore does not exist (or you want to use one other than the default). -.br -.br -A keystore is \f2not\fP required when verifying, but if one is specified, or the default exists, and the \f2\-verbose\fP option was also specified, additional information is output regarding whether or not any of the certificates used to verify the JAR file are contained in that keystore. -.br -.br -Note: the \f2\-keystore\fP argument can actually be a file name (and path) specification rather than a URL, in which case it will be treated the same as a "file:" URL. That is, -.nf -\f3 -.fl - \-keystore \fP\f4filePathAndName\fP\f3 -.fl -\fP -.fi -is treated as equivalent to -.nf -\f3 -.fl - \-keystore file:\fP\f4filePathAndName\fP\f3 -.fl -\fP -.fi -If the Sun PKCS#11 provider has been configured in the \f2java.security\fP security properties file (located in the JRE's \f2$JAVA_HOME/lib/security\fP directory), then keytool and jarsigner can operate on the PKCS#11 token by specifying these options: -.RS 3 -.TP 2 -o -\f2\-keystore NONE\fP -.TP 2 -o -\f2\-storetype PKCS11\fP -.RE -For example, this command lists the contents of the configured PKCS#11 token: -.nf -\f3 -.fl - jarsigner \-keystore NONE \-storetype PKCS11 \-list -.fl -\fP -.fi -.TP 3 -\-storetype storetype -Specifies the type of keystore to be instantiated. The default keystore type is the one that is specified as the value of the "keystore.type" property in the security properties file, which is returned by the static \f2getDefaultType\fP method in \f2java.security.KeyStore\fP. -.br -.br -The PIN for a PCKS#11 token can also be specified using the \f2\-storepass\fP option. If none has been specified, keytool and jarsigner will prompt for the token PIN. If the token has a protected authentication path (such as a dedicated PIN\-pad or a biometric reader), then the \f2\-protected\fP option must be specified and no password options can be specified. -.TP 3 -\-storepass[:env | :file] argument -Specifies the password which is required to access the keystore. This is only needed when signing (not verifying) a JAR file. In that case, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for the password. -.br -.br -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. -.TP 3 -\-keypass[:env | :file] argument -Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line. The password is required when using \f3jarsigner\fP to sign a JAR file. If no password is provided on the command line, and the required password is different from the store password, the user is prompted for it. -.br -.br -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -Note: The password shouldn't be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system. -.TP 3 -\-sigfile file -Specifies the base file name to be used for the generated .SF and .DSA files. For example, if \f2file\fP is "DUKESIGN", the generated .SF and .DSA files will be named "DUKESIGN.SF" and "DUKESIGN.DSA", and will be placed in the "META\-INF" directory of the signed JAR file. -.br -.br -The characters in \f2file\fP must come from the set "a\-zA\-Z0\-9_\-". That is, only letters, numbers, underscore, and hyphen characters are allowed. Note: All lowercase characters will be converted to uppercase for the .SF and .DSA file names. -.br -.br -If no \f2\-sigfile\fP option appears on the command line, the base file name for the .SF and .DSA files will be the first 8 characters of the alias name specified on the command line, all converted to upper case. If the alias name has fewer than 8 characters, the full alias name is used. If the alias name contains any characters that are not legal in a signature file name, each such character is converted to an underscore ("_") character in forming the file name. -.TP 3 -\-sigalg algorithm -Specifies the name of the signature algorithm to use to sign the JAR file. -.br -.br -See -.na -\f2Appendix A\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard signature algorithm names. This algorithm must be compatible with the private key used to sign the JAR file. If this option is not specified, SHA1withDSA, SHA256withRSA, or SHA256withECDSA will be used depending on the type of private key. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed. -.TP 3 -\-digestalg algorithm -Specifies the name of the message digest algorithm to use when digesting the entries of a jar file. -.br -.br -See -.na -\f2Appendix A\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA of the Java Cryptography Architecture for a list of standard message digest algorithm names. If this option is not specified, SHA256 will be used. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f2\-providerClass\fP option, otherwise the command will not succeed. -.TP 3 -\-signedjar file -Specifies the name to be used for the signed JAR file. -.br -.br -If no name is specified on the command line, the name used is the same as the input JAR file name (the name of the JAR file to be signed); in other words, that file is overwritten with the signed JAR file. -.TP 3 -\-verify -If this appears on the command line, the specified JAR file will be verified, not signed. If the verification is successful, "jar verified" will be displayed. If you try to verify an unsigned JAR file, or a JAR file signed with an unsupported algorithm (e.g., RSA when you don't have an RSA provider installed), the following is displayed: "jar is unsigned. (signatures missing or not parsable)" -.br -.br -It is possible to verify JAR files signed using either \f3jarsigner\fP or the JDK 1.1 \f3javakey\fP tool, or both. -.br -.br -For further information on verification, see JAR File Verification. -.TP 3 -\-certs -If this appears on the command line, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file. This information includes -.RS 3 -.TP 2 -o -the name of the type of certificate (stored in the .DSA file) that certifies the signer's public key -.TP 2 -o -if the certificate is an X.509 certificate (more specifically, an instance of \f2java.security.cert.X509Certificate\fP): the distinguished name of the signer -.RE -The keystore is also examined. If no keystore value is specified on the command line, the default keystore file (if any) will be checked. If the public key certificate for a signer matches an entry in the keystore, then the following information will also be displayed: -.RS 3 -.TP 2 -o -in parentheses, the alias name for the keystore entry for that signer. If the signer actually comes from a JDK 1.1 identity database instead of from a keystore, the alias name will appear in brackets instead of parentheses. -.RE -.TP 3 -\-certchain file -Specifies the certificate chain to be used, if the certificate chain associated with the private key of the keystore entry, addressed by the alias specified on the command line, is not complete. This may happen if the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain. The file can be a sequence of X.509 certificates concatenated together, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as BASE64 encoding) as defined by the Internet RFC 1421 standard. -.TP 3 -\-verbose -If this appears on the command line, it indicates "verbose" mode, which causes \f3jarsigner\fP to output extra information as to the progress of the JAR signing or verification. -.TP 3 -\-internalsf -In the past, the .DSA (signature block) file generated when a JAR file was signed used to include a complete encoded copy of the .SF file (signature file) also generated. This behavior has been changed. To reduce the overall size of the output JAR file, the .DSA file by default doesn't contain a copy of the .SF file anymore. But if \f2\-internalsf\fP appears on the command line, the old behavior is utilized. \f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP -.TP 3 -\-sectionsonly -If this appears on the command line, the .SF file (signature file) generated when a JAR file is signed does \f2not\fP include a header containing a hash of the whole manifest file. It just contains information and hashes related to each individual source file included in the JAR file, as described in The Signature (.SF) File . -.br -.br -By default, this header is added, as an optimization. When the header is present, then whenever the JAR file is verified, the verification can first check to see whether or not the hash in the header indeed matches the hash of the whole manifest file. If so, verification proceeds to the next step. If not, it is necessary to do a less optimized verification that the hash in each source file information section in the .SF file equals the hash of its corresponding section in the manifest file. -.br -.br -For further information, see JAR File Verification. -.br -.br -\f3This option is mainly useful for testing; in practice, it should not be used, since doing so eliminates a useful optimization.\fP -.TP 3 -\-protected -Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader. -.TP 3 -\-providerClass provider\-class\-name -Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file, \f2java.security\fP. -.br -.br -Used in conjunction with the \f2\-providerArg\fP \f2ConfigFilePath\fP option, keytool and jarsigner will install the provider dynamically (where \f2ConfigFilePath\fP is the path to the token configuration file). Here's an example of a command to list a PKCS#11 keystore when the Sun PKCS#11 provider has not been configured in the security properties file. -.nf -\f3 -.fl -jarsigner \-keystore NONE \-storetype PKCS11 \\ -.fl - \-providerClass sun.security.pkcs11.SunPKCS11 \\ -.fl - \-providerArg /foo/bar/token.config \\ -.fl - \-list -.fl -\fP -.fi -.TP 3 -\-providerName providerName -If more than one provider has been configured in the \f2java.security\fP security properties file, you can use the \f2\-providerName\fP option to target a specific provider instance. The argument to this option is the name of the provider. -.br -.br -For the Sun PKCS#11 provider, \f2providerName\fP is of the form \f2SunPKCS11\-\fP\f2TokenName\fP, where \f2TokenName\fP is the name suffix that the provider instance has been configured with, as detailed in the -.na -\f2configuration attributes table\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/p11guide.html#ATTRS. For example, the following command lists the contents of the PKCS#11 keystore provider instance with name suffix \f2SmartCard\fP: -.nf -\f3 -.fl -jarsigner \-keystore NONE \-storetype PKCS11 \\ -.fl - \-providerName SunPKCS11\-SmartCard \\ -.fl - \-list -.fl -\fP -.fi -.TP 3 -\-Jjavaoption -Passes through the specified \f2javaoption\fP string directly to the Java interpreter. (\f3jarsigner\fP is actually a "wrapper" around the interpreter.) This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line. -.TP 3 -\-tsa url -If \f2"\-tsa http://example.tsa.url"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The URL, \f2http://example.tsa.url\fP, identifies the location of the Time Stamping Authority (TSA). It overrides any URL found via the \f2\-tsacert\fP option. The \f2\-tsa\fP option does not require the TSA's public key certificate to be present in the keystore. -.br -.br -To generate the timestamp, \f2jarsigner\fP communicates with the TSA using the Time\-Stamp Protocol (TSP) defined in -.na -\f2RFC 3161\fP @ -.fi -http://www.ietf.org/rfc/rfc3161.txt. If successful, the timestamp token returned by the TSA is stored along with the signature in the signature block file. -.TP 3 -\-tsacert alias -If \f2"\-tsacert alias"\fP appears on the command line when signing a JAR file then a timestamp is generated for the signature. The \f2alias\fP identifies the TSA's public key certificate in the keystore that is currently in effect. The entry's certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA. -.br -.br -The TSA's public key certificate must be present in the keystore when using \f2\-tsacert\fP. -.TP 3 -\-altsigner class -Specifies that an alternative signing mechanism be used. The fully\-qualified class name identifies a class file that extends the \f2com.sun.jarsigner.ContentSigner abstract class\fP. The path to this class file is defined by the \f2\-altsignerpath\fP option. If the \f2\-altsigner\fP option is used, \f2jarsigner\fP uses the signing mechanism provided by the specified class. Otherwise, \f2jarsigner\fP uses its default signing mechanism. -.br -.br -For example, to use the signing mechanism provided by a class named \f2com.sun.sun.jarsigner.AuthSigner\fP, use the \f2jarsigner\fP option \f2"\-altsigner com.sun.jarsigner.AuthSigner"\fP -.TP 3 -\-altsignerpath classpathlist -Specifies the path to the class file (the class file name is specified with the \f2\-altsigner\fP option described above) and any JAR files it depends on. If the class file is in a JAR file, then this specifies the path to that JAR file, as shown in the example below. -.br -.br -An absolute path or a path relative to the current directory may be specified. If \f2classpathlist\fP contains multiple paths or JAR files, they should be separated with a colon (\f2:\fP) on Solaris and a semi\-colon (\f2;\fP) on Windows. This option is not necessary if the class is already in the search path. -.br -.br -Example of specifying the path to a jar file that contains the class file: -.nf -\f3 -.fl -\-altsignerpath /home/user/lib/authsigner.jar -.fl -\fP -.fi -Note that the JAR file name is included. -.br -.br -Example of specifying the path to the jar file that contains the class file: -.nf -\f3 -.fl -\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/ -.fl -\fP -.fi -Note that the JAR file name is omitted. -.TP 3 -\-strict -During the signing or verifying process, some warning messages may be shown. If this option appears on the command line, the exit code of the tool will reflect the warning messages that are found. Read the "WARNINGS" section for details. -.TP 3 -\-verbose:sub\-options -For the verifying process, the \f2\-verbose\fP option takes sub\-options to determine how much information will be shown. If \f2\-certs\fP is also specified, the default mode (or sub\-option all) displays each entry as it is being processed and following that, the certificate information for each signer of the JAR file. If \f2\-certs\fP and the \f2\-verbose:grouped\fP sub\-option are specified, entries with the same signer info are grouped and displayed together along with their certificate information. If \f2\-certs\fP and the \f2\-verbose:summary\fP sub\-option are specified, then entries with the same signer info are grouped and displayed together along with their certificate information but details about each entry are summarized and displayed as "one entry (and more)". See the examples section for more information. -.RE +If the Sun PKCS #11 provider was configured in the \f3java\&.security\fR security properties file (located in the JRE\&'s \f3$JAVA_HOME/lib/security directory\fR), then the \f3keytool\fR and \f3jarsigner\fR tools can operate on the PKCS #11 token by specifying these options: +.sp +.nf +\f3\-keystore NONE\fP +.fi +.nf +\f3\-storetype PKCS11\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.SH "EXAMPLES" -.LP -.SS -Signing a JAR File -.LP -.LP -Suppose you have a JAR file named "bundle.jar" and you'd like to sign it using the private key of the user whose keystore alias is "jane" in the keystore named "mystore" in the "working" directory. You can use the following to sign the JAR file and name the signed JAR file "sbundle.jar": -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-storepass \fP\f4<keystore password>\fP\f3 -.fl - \-keypass \fP\f4<private key password>\fP\f3 \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi -.LP -.LP -Note that there is no \f2\-sigfile\fP specified in the command above, so the generated .SF and .DSA files to be placed in the signed JAR file will have default names based on the alias name. That is, they will be named \f2JANE.SF\fP and \f2JANE.DSA\fP. -.LP -.LP -If you want to be prompted for the store password and the private key password, you could shorten the above command to -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore -.fl - \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi +For example, the following command lists the contents of the configured PKCS#11 token: +.sp +.nf +\f3keytool \-keystore NONE \-storetype PKCS11 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp -.LP -.LP -If the keystore to be used is the default keystore (the one named ".keystore" in your home directory), you don't need to specify a keystore, as in: -.LP -.nf -\f3 -.fl - jarsigner \-signedjar sbundle.jar bundle.jar jane -.fl -\fP -.fi - -.LP -.LP -Finally, if you want the signed JAR file to simply overwrite the input JAR file (\f2bundle.jar\fP), you don't need to specify a \f2\-signedjar\fP option: -.LP -.nf -\f3 -.fl - jarsigner bundle.jar jane -.fl -\fP -.fi - -.LP -.SS -Verifying a Signed JAR File -.LP -.LP -To verify a signed JAR file, that is, to verify that the signature is valid and the JAR file has not been tampered with, use a command such as the following: -.LP -.nf -\f3 -.fl - jarsigner \-verify sbundle.jar -.fl -\fP -.fi - -.LP -.LP -If the verification is successful, -.LP -.nf -\f3 -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -is displayed. Otherwise, an error message appears. -.LP -.LP -You can get more information if you use the \f2\-verbose\fP option. A sample use of \f3jarsigner\fP with the \f2\-verbose\fP option is shown below, along with sample output: -.LP -.nf -\f3 -.fl - jarsigner \-verify \-verbose sbundle.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx.class -.fl - smk 849 Fri Sep 26 16:12:46 PDT 1997 test.class -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.SS -Verification with Certificate Information -.LP -.LP -If you specify the \f2\-certs\fP option when verifying, along with the \f2\-verify\fP and \f2\-verbose\fP options, the output includes certificate information for each signer of the JAR file, including the certificate type, the signer distinguished name information (if and only if it's an X.509 certificate), and, in parentheses, the keystore alias for the signer if the public key certificate in the JAR file matches that in a keystore entry. For example, -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST.SF -.fl - 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST.DSA -.fl - smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst.class -.fl - -.fl - X.509, CN=Test Group, OU=Java Software, O=Sun Microsystems, L=CUP, S=CA, C=US (javatest) -.fl - X.509, CN=Jane Smith, OU=Java Software, O=Sun, L=cup, S=ca, C=us (jane) -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -If the certificate for a signer is not an X.509 certificate, there is no distinguished name information. In that case, just the certificate type and the alias are shown. For example, if the certificate is a PGP certificate, and the alias is "bob", you'd get -.LP -.nf -\f3 -.fl - PGP, (bob) -.fl -\fP -.fi - -.LP -.SS -Verification of a JAR File that Includes Identity Database Signers -.LP -.LP -If a JAR file has been signed using the JDK 1.1 \f3javakey\fP tool, and thus the signer is an alias in an identity database, the verification output includes an "i" symbol. If the JAR file has been signed by both an alias in an identity database and an alias in a keystore, both "k" and "i" appear. -.LP -.LP -When the \f2\-certs\fP option is used, any identity database aliases are shown in square brackets rather than the parentheses used for keystore aliases. For example: -.LP -.nf -\f3 -.fl - jarsigner \-keystore /working/mystore \-verify \-verbose \-certs writeFile.jar -.fl - -.fl - 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST.MF -.fl - 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.SF -.fl - 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE.DSA -.fl - 199 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE.SF -.fl - 1013 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE.DSA -.fl - smki 2752 Fri Sep 26 16:12:30 PDT 1997 writeFile.html -.fl - -.fl - X.509, CN=Jane Smith, OU=Java Software, O=Sun, L=cup, S=ca, C=us (jane) -.fl - X.509, CN=Duke, OU=Java Software, O=Sun, L=cup, S=ca, C=us [duke] -.fl - -.fl - s = signature was verified -.fl - m = entry is listed in manifest -.fl - k = at least one certificate was found in keystore -.fl - i = at least one certificate was found in identity scope -.fl - -.fl - jar verified. -.fl -\fP -.fi - -.LP -.LP -Note that the alias "duke" is in brackets to denote that it is an identity database alias, not a keystore alias. -.LP -.SH "WARNINGS" -.LP -During the signing/verifying process, jarsigner may display various warnings. These warning codes are defined as follows: -.nf -\f3 -.fl - hasExpiringCert 2 -.fl - This jar contains entries whose signer certificate will expire within six months -.fl - -.fl - hasExpiredCert 4 -.fl - This jar contains entries whose signer certificate has expired. -.fl - -.fl - notYetValidCert 4 -.fl - This jar contains entries whose signer certificate is not yet valid. -.fl - -.fl - chainNotValidated 4 -.fl - This jar contains entries whose certificate chain cannot be correctly validated. -.fl - -.fl - badKeyUsage 8 -.fl - This jar contains entries whose signer certificate's KeyUsage extension doesn't allow code signing. -.fl - -.fl - badExtendedKeyUsage 8 -.fl - This jar contains entries whose signer certificate's ExtendedKeyUsage extension -.fl - doesn't allow code signing. -.fl - -.fl - badNetscapeCertType 8 -.fl - This jar contains entries whose signer certificate's NetscapeCertType extension -.fl - doesn't allow code signing. -.fl - -.fl - hasUnsignedEntry 16 -.fl - This jar contains unsigned entries which have not been integrity\-checked. -.fl - -.fl - notSignedByAlias 32 -.fl - This jar contains signed entries which are not signed by the specified alias(es) -.fl - -.fl - aliasNotInStore 32 -.fl - This jar contains signed entries that are not signed by alias in this keystore -.fl - -.fl -\fP -.fi - -.LP -.LP -When the \f2\-strict\fP option is provided, an OR\-value of warnings detected will be returned as the exit code of the tool. For example, if a certificate used to sign an entry is expired and has a keyUsage extension that does not allow it to sign a file, an exit code 12 (=4+8) will be returned. -.LP -.LP -\f3Note\fP: Exit codes are reused because only 0\-255 is legal for Unix. In any case, if the signing/verifying process fails, the following exit code will be returned: -.LP -.nf -\f3 -.fl -failure 1 -.fl -\fP -.fi - -.LP -.SS -Compatibility with JDK 1.1 -.LP -.LP -The \f3keytool\fP and \f3jarsigner\fP tools completely replace the \f3javakey\fP tool provided in JDK 1.1. These new tools provide more features than \f3javakey\fP, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them. -.LP -.LP -The new keystore architecture replaces the identity database that \f3javakey\fP created and managed. There is no backwards compatibility between the keystore format and the database format used by \f3javakey\fP in 1.1. However, -.LP -.RS 3 -.TP 2 -o -It is possible to import the information from an identity database into a keystore, via the \f3keytool\fP \f2\-identitydb\fP command. -.TP 2 -o -\f3jarsigner\fP can sign JAR files also previously signed using \f3javakey\fP. -.TP 2 -o -\f3jarsigner\fP can verify JAR files signed using \f3javakey\fP. Thus, it recognizes and can work with signer aliases that are from a JDK 1.1 identity database rather than a Java 2 SDK keystore. -.RE - -.LP -.LP -The following table explains how JAR files that were signed in JDK 1.1.x are treated in the Java 2 platform. -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 83 84 -.nr 34 \n(.lu -.eo -.am 82 +.TP +-storetype \fIstoretype\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f3Trusted Identity imported into Java 2 Platform keystore from 1.1 database (4)\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 83 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(83 .ll \n(83u -.in 0 -\f3Policy File grants privileges to Identity/Alias\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. (3) -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code. (1,3) -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code plus privileges granted in policy file. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 84 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/6u -.if \n(.l<\n(84 .ll \n(84u -.in 0 -Default privileges granted to all code plus privileges granted in policy file. (2) -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3JAR File Type\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wUnsigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSigned JAR -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Identity in 1.1 database\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Untrusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Untrusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNO -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wYES/Trusted -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 82 0 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wYES -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \wNO -.if \n(82<\n(38 .nr 82 \n(38 -.82 -.rm 82 -.nr 38 \n(a- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 83 0 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wNO -.if \n(83<\n(38 .nr 83 \n(38 -.nr 38 \wYES -.if \n(83<\n(38 .nr 83 \n(38 -.83 -.rm 83 -.nr 38 \n(b- -.if \n(83<\n(38 .nr 83 \n(38 -.nr 84 0 -.nr 38 \w\f3Privileges Granted\fP -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges (1) -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \wAll privileges (1) -.if \n(84<\n(38 .nr 84 \n(38 -.84 -.rm 84 -.nr 38 \n(c- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(d- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(e- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(f- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(g- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(h- -.if \n(84<\n(38 .nr 84 \n(38 -.nr 38 \n(i- -.if \n(84<\n(38 .nr 84 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr 43 \n(82+(3*\n(38) -.nr 83 +\n(43 -.nr 44 \n(83+(3*\n(38) -.nr 84 +\n(44 -.nr TW \n(84 -.if t .if \n(TW>\n(.li .tm Table at line 1082 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.ne \n(b|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3JAR File Type\fP\h'|\n(41u'\f3Identity in 1.1 database\fP\h'|\n(42u'\h'|\n(43u'\h'|\n(44u'\f3Privileges Granted\fP -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(43u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Unsigned JAR\h'|\n(41u'NO\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'YES\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Untrusted\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Untrusted\h'|\n(42u'NO\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'NO\h'|\n(42u'YES\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'YES\h'|\n(43u'YES\h'|\n(44u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(44u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'NO\h'|\n(43u'NO\h'|\n(44u'All privileges -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'YES\h'|\n(43u'NO\h'|\n(44u'All privileges (1) -.ta \n(80u \n(81u \n(82u \n(83u \n(84u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Signed JAR\h'|\n(41u'YES/Trusted\h'|\n(42u'NO\h'|\n(43u'YES\h'|\n(44u'All privileges (1) -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-42 +Specifies the type of keystore to be instantiated\&. The default keystore type is the one that is specified as the value of the \f3keystore\&.type\fR property in the security properties file, which is returned by the static \f3getDefaultType\fR method in \f3java\&.security\&.KeyStore\fR\&. -.LP -.LP -Notes: -.LP -.RS 3 -.TP 3 -1. -If an identity/alias is mentioned in the policy file, it must be imported into the keystore for the policy file to have any effect on privileges granted. -.TP 3 -2. -The policy file/keystore combination has precedence over a trusted identity in the identity database. -.TP 3 -3. -Untrusted identities are ignored in the Java 2 platform. -.TP 3 -4. -Only trusted identities can be imported into Java 2 SDK keystores. -.RE +The PIN for a PCKS #11 token can also be specified with the \f3-storepass\fR option\&. If none is specified, then the \f3keytool\fR and \f3jarsigner\fR commands prompt for the token PIN\&. If the token has a protected authentication path (such as a dedicated PIN-pad or a biometric reader), then the \f3-protected\fR option must be specified and no password options can be specified\&. +.TP +-storepass[:env | :file] \fIargument\fR +.br +Specifies the password that is required to access the keystore\&. This is only needed when signing (not verifying) a JAR file\&. In that case, if a \f3-storepass\fR option is not provided at the command line, then the user is prompted for the password\&. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jar(1) tool documentation -.TP 2 -o -keytool(1) tool documentation -.TP 2 -o -the -.na -\f4Security\fP @ -.fi -http://download.oracle.com/javase/tutorial/security/index.html trail of the -.na -\f4Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/index.html for examples of the use of the \f3jarsigner\fP tool -.RE +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \fIargument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE -.LP - + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-keypass [:env | :file] \fIargument\fR +.br +Specifies the password used to protect the private key of the keystore entry addressed by the alias specified on the command line\&. The password is required when using \f3jarsigner\fR to sign a JAR file\&. If no password is provided on the command line, and the required password is different from the store password, then the user is prompted for it\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the value \f3argument\fR\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named \f3argument\fR\&. +.RE + + +\fINote:\fR The password should not be specified on the command line or in a script unless it is for testing purposes, or you are on a secure system\&. +.TP +-sigfile \fIfile\fR +.br +Specifies the base file name to be used for the generated \f3\&.SF\fR and \f3\&.DSA\fR files\&. For example, if file is \f3DUKESIGN\fR, then the generated \f3\&.SF\fR and \f3\&.DSA\fR files are named \f3DUKESIGN\&.SF\fR and \f3DUKESIGN\&.DSA\fR, and placed in the \f3META-INF\fR directory of the signed JAR file\&. + +The characters in the file must come from the set \f3a-zA-Z0-9_-\fR\&. Only letters, numbers, underscore, and hyphen characters are allowed\&. All lowercase characters are converted to uppercase for the \f3\&.SF\fR and \f3\&.DSA\fR file names\&. + +If no \f3-sigfile\fR option appears on the command line, then the base file name for the \f3\&.SF\fR and \f3\&.DSA\fR files is the first 8 characters of the alias name specified on the command line, all converted to upper case\&. If the alias name has fewer than 8 characters, then the full alias name is used\&. If the alias name contains any characters that are not valid in a signature file name, then each such character is converted to an underscore (_) character to form the file name\&. +.TP +-sigalg \fIalgorithm\fR +.br +Specifies the name of the signature algorithm to use to sign the JAR file\&. + +For a list of standard signature algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +This algorithm must be compatible with the private key used to sign the JAR file\&. If this option is not specified, then \f3SHA1withDSA\fR, \f3SHA256withRSA\fR, or \f3SHA256withECDSA\fR are used depending on the type of private key\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-digestalg \fIalgorithm\fR +.br +Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file\&. + +For a list of standard message digest algorithm names, see "Appendix A: Standard Names" in the Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA + +If this option is not specified, then \f3SHA256\fR is used\&. There must either be a statically installed provider supplying an implementation of the specified algorithm or the user must specify one with the \f3-providerClass\fR option; otherwise, the command will not succeed\&. +.TP +-certs +.br +If the \f3-certs\fR option appears on the command line with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. This information includes the name of the type of certificate (stored in the \f3\&.DSA\fR file) that certifies the signer\&'s public key, and if the certificate is an X\&.509 certificate (an instance of the \f3java\&.security\&.cert\&.X509Certificate\fR), then the distinguished name of the signer\&. + +The keystore is also examined\&. If no keystore value is specified on the command line, then the default keystore file (if any) is checked\&. If the public key certificate for a signer matches an entry in the keystore, then the alias name for the keystore entry for that signer is displayed in parentheses\&. If the signer comes from a JDK 1\&.1 identity database instead of from a keystore, then the alias name displays in brackets instead of parentheses\&. +.TP +-certchain \fIfile\fR +.br +Specifies the certificate chain to be used when the certificate chain associated with the private key of the keystore entry that is addressed by the alias specified on the command line is not complete\&. This can happen when the keystore is located on a hardware token where there is not enough capacity to hold a complete certificate chain\&. The file can be a sequence of concatenated X\&.509 certificates, or a single PKCS#7 formatted data block, either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. See Internet RFC 1421 Certificate Encoding Standard and http://tools\&.ietf\&.org/html/rfc1421\&. +.TP +-verbose +.br +When the \f3-verbose\fR option appears on the command line, it indicates verbose mode, which causes \f3jarsigner\fR to output extra information about the progress of the JAR signing or verification\&. +.TP +-internalsf +.br +In the past, the \f3\&.DSA\fR (signature block) file generated when a JAR file was signed included a complete encoded copy of the \f3\&.SF\fR file (signature file) also generated\&. This behavior has been changed\&. To reduce the overall size of the output JAR file, the \f3\&.DSA\fR file by default does not contain a copy of the \f3\&.SF\fR file anymore\&. If \f3-internalsf\fR appears on the command line, then the old behavior is utilized\&. This option is useful for testing\&. In practice, do not use the \f3-internalsf\fR option because it incurs higher overhead\&. +.TP +-sectionsonly +.br +If the \f3-sectionsonly\fR option appears on the command line, then the \f3\&.SF\fR file (signature file) generated when a JAR file is signed does not include a header that contains a hash of the whole manifest file\&. It contains only the information and hashes related to each individual source file included in the JAR file\&. See Signature File\&. + +By default, this header is added, as an optimization\&. When the header is present, whenever the JAR file is verified, the verification can first check to see whether the hash in the header matches the hash of the whole manifest file\&. When there is a match, verification proceeds to the next step\&. When there is no match, it is necessary to do a less optimized verification that the hash in each source file information section in the \f3\&.SF\fR file equals the hash of its corresponding section in the manifest file\&. See JAR File Verification\&. + +The \f3-sectionsonly\fR option is primarily used for testing\&. It should not be used other than for testing because using it incurs higher overhead\&. +.TP +-protected +.br +Values can be either \f3true\fR or \f3false\fR\&. Specify \f3true\fR when a password must be specified through a protected authentication path such as a dedicated PIN reader\&. +.TP +-providerClass \fIprovider-class-name\fR +.br +Used to specify the name of cryptographic service provider\&'s master class file when the service provider is not listed in the \f3java\&.security\fR security properties file\&. + +Used with the \f3-providerArg ConfigFilePath\fR option, the \f3keytool\fR and \f3jarsigner\fR tools install the provider dynamically and use \fIConfigFilePath\fR for the path to the token configuration file\&. The following example shows a command to list a \f3PKCS #11\fR keystore when the Oracle PKCS #11 provider was not configured in the security properties file\&. +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerClass sun\&.security\&.pkcs11\&.SunPKCS11 \e\fP +.fi +.nf +\f3 \-providerArg /mydir1/mydir2/token\&.config \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-providerName \fIproviderName\fR +.br +If more than one provider was configured in the \f3java\&.security\fR security properties file, then you can use the \f3-providerName\fR option to target a specific provider instance\&. The argument to this option is the name of the provider\&. + +For the Oracle PKCS #11 provider, \fIproviderName\fR is of the form \f3SunPKCS11-\fR\fITokenName\fR, where \fITokenName\fR is the name suffix that the provider instance has been configured with, as detailed in the configuration attributes table\&. For example, the following command lists the contents of the \f3PKCS #11\fR keystore provider instance with name suffix \f3SmartCard\fR: +.sp +.nf +\f3jarsigner \-keystore NONE \-storetype PKCS11 \e\fP +.fi +.nf +\f3 \-providerName SunPKCS11\-SmartCard \e\fP +.fi +.nf +\f3 \-list\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-J\fIjavaoption\fR +.br +Passes through the specified \fIjavaoption\fR string directly to the Java interpreter\&. The \f3jarsigner\fR command is a wrapper around the interpreter\&. This option should not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.TP +-tsa \fIurl\fR +.br +If \f3-tsa http://example\&.tsa\&.url\fR appears on the command line when signing a JAR file then a time stamp is generated for the signature\&. The URL, \f3http://example\&.tsa\&.url\fR, identifies the location of the Time Stamping Authority (TSA) and overrides any URL found with the \f3-tsacert\fR option\&. The \f3-tsa\fR option does not require the TSA public key certificate to be present in the keystore\&. + +To generate the time stamp, \f3jarsigner\fR communicates with the TSA with the Time-Stamp Protocol (TSP) defined in RFC 3161\&. When successful, the time stamp token returned by the TSA is stored with the signature in the signature block file\&. +.TP +-tsacert \fIalias\fR +.br +When \f3-tsacert alias\fR appears on the command line when signing a JAR file, a time stamp is generated for the signature\&. The alias identifies the TSA public key certificate in the keystore that is in effect\&. The entry\&'s certificate is examined for a Subject Information Access extension that contains a URL identifying the location of the TSA\&. + +The TSA public key certificate must be present in the keystore when using the \f3-tsacert\fR option\&. +.TP +-tsapolicyid \fIpolicyid\fR +.br +Specifies the object identifier (OID) that identifies the policy ID to be sent to the TSA server\&. If this option is not specified, no policy ID is sent and the TSA server will choose a default policy ID\&. + +Object identifiers are defined by X\&.696, which is an ITU Telecommunication Standardization Sector (ITU-T) standard\&. These identifiers are typically period-separated sets of non-negative digits like \f31\&.2\&.3\&.4\fR, for example\&. +.TP +-altsigner \fIclass\fR +.br +This option specifies an alternative signing mechanism\&. The fully qualified class name identifies a class file that extends the \f3com\&.sun\&.jarsigner\&.ContentSigner\fR abstract class\&. The path to this class file is defined by the \f3-altsignerpath\fR option\&. If the \f3-altsigner\fR option is used, then the \f3jarsigner\fR command uses the signing mechanism provided by the specified class\&. Otherwise, the \f3jarsigner\fR command uses its default signing mechanism\&. + +For example, to use the signing mechanism provided by a class named \f3com\&.sun\&.sun\&.jarsigner\&.AuthSigner\fR, use the jarsigner option \f3-altsigner com\&.sun\&.jarsigner\&.AuthSigner\fR\&. +.TP +-altsignerpath \fIclasspathlist\fR +.br +Specifies the path to the class file and any JAR file it depends on\&. The class file name is specified with the \f3-altsigner\fR option\&. If the class file is in a JAR file, then this option specifies the path to that JAR file\&. + +An absolute path or a path relative to the current directory can be specified\&. If \fIclasspathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semicolon (;) on Windows\&. This option is not necessary when the class is already in the search path\&. + +The following example shows how to specify the path to a JAR file that contains the class file\&. The JAR file name is included\&. +.sp +.nf +\f3\-altsignerpath /home/user/lib/authsigner\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The following example shows how to specify the path to the JAR file that contains the class file\&. The JAR file name is omitted\&. +.sp +.nf +\f3\-altsignerpath /home/user/classes/com/sun/tools/jarsigner/\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-strict +.br +During the signing or verifying process, the command may issue warning messages\&. If you specify this option, the exit code of the tool reflects the severe warning messages that this command found\&. See Errors and Warnings\&. +.TP +-verbose \fIsuboptions\fR +.br +For the verifying process, the \f3-verbose\fR option takes suboptions to determine how much information is shown\&. If the \f3-certs\fR option is also specified, then the default mode (or suboption \f3all\fR) displays each entry as it is being processed, and after that, the certificate information for each signer of the JAR file\&. If the \f3-certs\fR and the \f3-verbose:grouped\fR suboptions are specified, then entries with the same signer info are grouped and displayed together with their certificate information\&. If \f3-certs\fR and the \f3-verbose:summary\fR suboptions are specified, then entries with the same signer information are grouped and displayed together with their certificate information\&. Details about each entry are summarized and displayed as \fIone entry (and more)\fR\&. See Examples\&. +.SH ERRORS\ AND\ WARNINGS +During the signing or verifying process, the \f3jarsigner\fR command may issue various errors or warnings\&. +.PP +If there is a failure, the \f3jarsigner\fR command exits with code 1\&. If there is no failure, but there are one or more severe warnings, the \f3jarsigner\fR command exits with code 0 when the \f3-strict\fR option is \fInot\fR specified, or exits with the OR-value of the warning codes when the \f3-strict\fR is specified\&. If there is only informational warnings or no warning at all, the command always exits with code 0\&. +.PP +For example, if a certificate used to sign an entry is expired and has a KeyUsage extension that does not allow it to sign a file, the \f3jarsigner\fR command exits with code 12 (=4+8) when the \f3-strict\fR option is specified\&. +.PP +\fINote:\fR Exit codes are reused because only the values from 0 to 255 are legal on Unix-based operating systems\&. +.PP +The following sections describes the names, codes, and descriptions of the errors and warnings that the \f3jarsigner\fR command can issue\&. +.SS FAILURE +Reasons why the \f3jarsigner\fR command fails include (but are not limited to) a command line parsing error, the inability to find a keypair to sign the JAR file, or the verification of a signed JAR fails\&. +.TP +failure +Code 1\&. The signing or verifying fails\&. +.SS SEVERE\ WARNINGS +\fINote:\fR Severe warnings are reported as errors if you specify the \f3-strict\fR option\&. +.PP +Reasons why the \f3jarsigner\fR command issues a severe warning include the certificate used to sign the JAR file has an error or the signed JAR file has other problems\&. +.TP +hasExpiredCert +Code 4\&. This jar contains entries whose signer certificate has expired\&. +.TP +notYetValidCert +Code 4\&. This jar contains entries whose signer certificate is not yet valid\&. +.TP +chainNotValidated +Code 4\&. This jar contains entries whose certificate chain cannot be correctly validated\&. +.TP +badKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s KeyUsage extension doesn\&'t allow code signing\&. +.TP +badExtendedKeyUsage +Code 8\&. This jar contains entries whose signer certificate\&'s ExtendedKeyUsage extension doesn\&'t allow code signing\&. +.TP +badNetscapeCertType +Code 8\&. This jar contains entries whose signer certificate\&'s NetscapeCertType extension doesn\&'t allow code signing\&. +.TP +hasUnsignedEntry +Code 16\&. This jar contains unsigned entries which have not been integrity-checked\&. +.TP +notSignedByAlias +Code 32\&. This jar contains signed entries which are not signed by the specified alias(es)\&. +.TP +aliasNotInStore +Code 32\&. This jar contains signed entries that are not signed by alias in this keystore\&. +.SS INFORMATIONAL\ WARNINGS +Informational warnings include those that are not errors but regarded as bad practice\&. They do not have a code\&. +.TP +hasExpiringCert +This jar contains entries whose signer certificate will expire within six months\&. +.TP +noTimestamp +This jar contains signatures that does not include a timestamp\&. Without a timestamp, users may not be able to validate this JAR file after the signer certificate\&'s expiration date (\f3YYYY-MM-DD\fR) or after any future revocation date\&. +.SH EXAMPLES +.SS SIGN\ A\ JAR\ FILE +Use the following command to sign bundle\&.jar with the private key of a user whose keystore alias is \f3jane\fR in a keystore named \f3mystore\fR in the \f3working\fR directory and name the signed JAR file \f3sbundle\&.jar\fR: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-storepass <keystore password>\fP +.fi +.nf +\f3 \-keypass <private key password>\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +There is no \f3-sigfile\fR specified in the previous command so the generated \f3\&.SF\fR and \f3\&.DSA\fR files to be placed in the signed JAR file have default names based on the alias name\&. They are named \f3JANE\&.SF\fR and \f3JANE\&.DSA\fR\&. +.PP +If you want to be prompted for the store password and the private key password, then you could shorten the previous command to the following: +.sp +.nf +\f3jarsigner \-keystore /working/mystore\fP +.fi +.nf +\f3 \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If the keystore is the default keystore (\&.keystore in your home directory), then you do not need to specify a keystore, as follows: +.sp +.nf +\f3jarsigner \-signedjar sbundle\&.jar bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +If you want the signed JAR file to overwrite the input JAR file (bundle\&.jar), then you do not need to specify a \f3-signedjar\fR option, as follows: +.sp +.nf +\f3jarsigner bundle\&.jar jane\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFY\ A\ SIGNED\ JAR\ FILE +To verify a signed JAR file to ensure that the signature is valid and the JAR file was not been tampered with, use a command such as the following: +.sp +.nf +\f3jarsigner \-verify sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.sp +When the verification is successful, \f3jar verified\fR is displayed\&. Otherwise, an error message is displayed\&. You can get more information when you use the \f3-verbose\fR option\&. A sample use of \f3jarsigner\fR with the\f3-verbose\fR option follows: +.sp +.nf +\f3jarsigner \-verify \-verbose sbundle\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 AclEx\&.class\fP +.fi +.nf +\f3 smk 849 Fri Sep 26 16:12:46 PDT 1997 test\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS VERIFICATION\ WITH\ CERTIFICATE\ INFORMATION +If you specify the \f3-certs\fR option with the \f3-verify\fR and \f3-verbose\fR options, then the output includes certificate information for each signer of the JAR file\&. The information includes the certificate type, the signer distinguished name information (when it is an X\&.509 certificate), and in parentheses, the keystore alias for the signer when the public key certificate in the JAR file matches the one in a keystore entry, for example: +.sp +.nf +\f3jarsigner \-keystore /working/mystore \-verify \-verbose \-certs myTest\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 208 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.SF\fP +.fi +.nf +\f3 1087 Fri Sep 26 16:23:30 PDT 1997 META\-INF/JAVATEST\&.DSA\fP +.fi +.nf +\f3 smk 2752 Fri Sep 26 16:12:30 PDT 1997 Tst\&.class\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Test Group, OU=Java Software, O=Oracle, L=CUP, S=CA, C=US (javatest)\fP +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +If the certificate for a signer is not an X\&.509 certificate, then there is no distinguished name information\&. In that case, just the certificate type and the alias are shown\&. For example, if the certificate is a PGP certificate, and the alias is \f3bob\fR, then you would get: \f3PGP, (bob)\fR\&. +.SS VERIFICATION\ THAT\ INCLUDES\ IDENTITY\ DATABASE\ SIGNERS +If a JAR file was signed with the JDK 1\&.1 \f3javakey\fR tool, and the signer is an alias in an identity database, then the verification output includes an \f3i\fR\&. If the JAR file was signed by both an alias in an identity database and an alias in a keystore, then both \f3k\fR and \f3i\fR appear\&. +.PP +When the \f3-certs\fR option is used, any identity database aliases are shown in brackets rather than the parentheses used for keystore aliases, for example: +.sp +.nf +\f3 jarsigner \-keystore /working/mystore \-verify \-verbose \-certs writeFile\&.jar\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 198 Fri Sep 26 16:14:06 PDT 1997 META\-INF/MANIFEST\&.MF\fP +.fi +.nf +\f3 199 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 26 16:22:10 PDT 1997 META\-INF/JANE\&.DSA\fP +.fi +.nf +\f3 199 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE\&.SF\fP +.fi +.nf +\f3 1013 Fri Sep 27 12:22:30 PDT 1997 META\-INF/DUKE\&.DSA\fP +.fi +.nf +\f3 smki 2752 Fri Sep 26 16:12:30 PDT 1997 writeFile\&.html\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 X\&.509, CN=Jane Smith, OU=Java Software, O=Oracle, L=cup, S=ca, C=us (jane)\fP +.fi +.nf +\f3 X\&.509, CN=Duke, OU=Java Software, O=Oracle, L=cup, S=ca, C=us [duke]\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 s = signature was verified\fP +.fi +.nf +\f3 m = entry is listed in manifest\fP +.fi +.nf +\f3 k = at least one certificate was found in keystore\fP +.fi +.nf +\f3 i = at least one certificate was found in identity scope\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3 jar verified\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR The alias \f3duke\fR is in brackets to denote that it is an identity database alias, and not a keystore alias\&. +.SH JDK\ 1\&.1\ COMPATIBILITY +The \f3keytool\fR and \f3jarsigner\fR tools replace the \f3javakey\fR tool in JDK 1\&.1\&. These new tools provide more features than \f3javakey\fR, including the ability to protect the keystore and private keys with passwords, and the ability to verify signatures in addition to generating them\&. +.PP +The new keystore architecture replaces the identity database that \f3javakey\fR created and managed\&. There is no backward compatibility between the keystore format and the database format used by \f3javakey\fR in JDK 1\&.1\&. However, be aware of the following: +.TP 0.2i +\(bu +It is possible to import the information from an identity database into a keystore through the \f3keytool -identitydb\fR command\&. +.TP 0.2i +\(bu +The \f3jarsigner\fR command can sign JAR files that were signed with the \f3javakey\fR command\&. +.TP 0.2i +\(bu +The \f3jarsigner\fR command can verify JAR files signed with \f3javakey\fR\&. The \f3jarsigner\fR command recognizes and can work with signer aliases that are from a JDK 1\&.1 identity database rather than a JDK keystore\&. +.SS UNSIGNED\ JARS +Unsigned JARs have the default privileges that are granted to all code\&. +.SS SIGNED\ JARS +Signed JARs have the privilege configurations based on their JDK 1\&.1\&.\fIn\fR identity and policy file status as described\&. Only trusted identities can be imported into the JDK keystore\&. +.PP +Default Privileges Granted to All Code + +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: Yes/Untrusted +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.br +See 3 in Notes Regarding Privileges of Signed JARs\&. +.PP + +.PP +Identity in 1\&.1 database: Yes/Untrusted +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 1 and 3 in Notes Regarding Privileges of Signed JARs\&. +.PP +Default Privileges and Policy File Privileges Granted + +Identity in 1\&.1 database: \fINo\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.PP + +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 2 in Notes Regarding Privileges of Signed JARs\&. +.PP +All Privileges Granted + +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.PP + +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fIYes\fR +.br +Policy file grants privileges to identity/alias: \fINo\fR +.br +See 1 in Notes Regarding Privileges of Signed JARs\&. +.PP +Identity in 1\&.1 database: \fIYes/Trusted\fR +.br +Trusted identity imported into Java keystore from 1\&.1\&. database: \fINo\fR +.br +Policy file grants privileges to identity/alias: \fIYes\fR +.br +See 1 in Notes Regarding Privileges of Signed JARs\&. +.PP +Notes Regarding Privileges of Signed JARs +.TP 0.4i +1\&. +If an identity or alias is mentioned in the policy file, then it must be imported into the keystore for the policy file to have any effect on privileges granted\&. +.TP 0.4i +2\&. +The policy file/keystore combination has precedence over a trusted identity in the identity database\&. +.TP 0.4i +3\&. +Untrusted identities are ignored in the Java platform\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +keytool(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/java.1 b/jdk/src/solaris/doc/sun/man/man1/java.1 index 2e885083a8b..250396d33c4 100644 --- a/jdk/src/solaris/doc/sun/man/man1/java.1 +++ b/jdk/src/solaris/doc/sun/man/man1/java.1 @@ -1,517 +1,1991 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH java 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: java.1 +.\" +.if n .pl 99999 +.TH java 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -java \- the Java application launcher -.LP -.SH "SYNOPSIS" -.LP +.SH NAME +java \- Launches a Java application\&. +.SH SYNOPSIS +.sp +.nf + +\fBjava\fR [\fIoptions\fR] \fIclassname\fR [\fIargs\fR] +.fi +.nf + +\fBjava\fR [\fIoptions\fR] \fB\-jar\fR \fIfilename\fR [\fIargs\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options separated by spaces\&. See Options\&. +.TP +\fIclassname\fR +The name of the class to be launched\&. +.TP +\fIfilename\fR +The name of the Java Archive (JAR) file to be called\&. Used only with the \f3-jar\fR option\&. +.TP +\fIargs\fR +The arguments passed to the \f3main()\fR method separated by spaces\&. +.SH DESCRIPTION +The \f3java\fR command starts a Java application\&. It does this by starting the Java Runtime Environment (JRE), loading the specified class, and calling that class\&'s \f3main()\fR method\&. The method must be declared \fIpublic\fR and \fIstatic\fR, it must not return any value, and it must accept a \f3String\fR array as a parameter\&. The method declaration has the following form: +.sp +.nf +\f3public static void main(String[] args)\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3java\fR command can be used to launch a JavaFX application by loading a class that either has a \f3main()\fR method or that extends \f3javafx\&.application\&.Application\fR\&. In the latter case, the launcher constructs an instance of the \f3Application\fR class, calls its \f3init()\fR method, and then calls the \f3start(javafx\&.stage\&.Stage)\fR method\&. +.PP +By default, the first argument that is not an option of the \f3java\fR command is the fully qualified name of the class to be called\&. If the \f3-jar\fR option is specified, its argument is the name of the JAR file containing class and resource files for the application\&. The startup class must be indicated by the \f3Main-Class\fR manifest header in its source code\&. +.PP +The JRE searches for the startup class (and other classes used by the application) in three sets of locations: the bootstrap class path, the installed extensions, and the user\(cqs class path\&. +.PP +Arguments after the class file name or the JAR file name are passed to the \f3main()\fR method\&. +.SH OPTIONS +The \f3java\fR command supports a wide range of options that can be divided into the following categories: +.TP 0.2i +\(bu +Standard Options +.TP 0.2i +\(bu +Non-Standard Options +.TP 0.2i +\(bu +Advanced Runtime Options +.TP 0.2i +\(bu +Advanced JIT Compiler Options +.TP 0.2i +\(bu +Advanced Serviceability Options +.TP 0.2i +\(bu +Advanced Garbage Collection Options +.PP +Standard options are guaranteed to be supported by all implementations of the Java Virtual Machine (JVM)\&. They are used for common actions, such as checking the version of the JRE, setting the class path, enabling verbose output, and so on\&. +.PP +Non-standard options are general purpose options that are specific to the Java HotSpot Virtual Machine, so they are not guaranteed to be supported by all JVM implementations, and are subject to change\&. These options start with \f3-X\fR\&. +.PP +Advanced options are not recommended for casual use\&. These are developer options used for tuning specific areas of the Java HotSpot Virtual Machine operation that often have specific system requirements and may require privileged access to system configuration parameters\&. They are also not guaranteed to be supported by all JVM implementations, and are subject to change\&. Advanced options start with \f3-XX\fR\&. +.PP +To keep track of the options that were deprecated or removed in the latest release, there is a section named Deprecated and Removed Options at the end of the document\&. +.PP +Boolean options are used to either enable a feature that is disabled by default or disable a feature that is enabled by default\&. Such options do not require a parameter\&. Boolean \f3-XX\fR options are enabled using the plus sign (\f3-XX:+\fR\fIOptionName\fR) and disabled using the minus sign (\f3-XX:-\fR\fIOptionName\fR)\&. +.PP +For options that require an argument, the argument may be separated from the option name by a space, a colon (:), or an equal sign (=), or the argument may directly follow the option (the exact syntax differs for each option)\&. If you are expected to specify the size in bytes, you can use no suffix, or use the suffix \f3k\fR or \f3K\fR for kilobytes (KB), \f3m\fR or \f3M\fR for megabytes (MB), \f3g\fR or \f3G\fR for gigabytes (GB)\&. For example, to set the size to 8 GB, you can specify either \f38g\fR, \f38192m\fR, \f38388608k\fR, or \f38589934592\fR as the argument\&. If you are expected to specify the percentage, use a number from 0 to 1 (for example, specify \f30\&.25\fR for 25%)\&. +.SS STANDARD\ OPTIONS +These are the most commonly used options that are supported by all implementations of the JVM\&. +.TP +-agentlib:\fIlibname\fR[=\fIoptions\fR] +.br +Loads the specified native agent library\&. After the library name, a comma-separated list of options specific to the library can be used\&. + +If the option \f3-agentlib:foo\fR is specified, then the JVM attempts to load the library named \f3libfoo\&.so\fR in the location specified by the \f3LD_LIBRARY_PATH\fR system variable (on OS X this variable is \f3DYLD_LIBRARY_PATH\fR)\&. + +The following example shows how to load the heap profiling tool (HPROF) library and get sample CPU information every 20 ms, with a stack depth of 3: +.sp +.nf +\f3\-agentlib:hprof=cpu=samples,interval=20,depth=3\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example shows how to load the Java Debug Wire Protocol (JDWP) library and listen for the socket connection on port 8000, suspending the JVM before the main class loads: +.sp +.nf +\f3\-agentlib:jdwp=transport=dt_socket,server=y,address=8000\fP +.fi +.nf +\f3\fP +.fi +.sp + + +For more information about the native agent libraries, refer to the following: +.RS +.TP 0.2i +\(bu +The \f3java\&.lang\&.instrument\fR package description at http://docs\&.oracle\&.com/javase/8/docs/api/java/lang/instrument/package-summary\&.html +.TP 0.2i +\(bu +Agent Command Line Options in the JVM Tools Interface guide at http://docs\&.oracle\&.com/javase/8/docs/platform/jvmti/jvmti\&.html#starting +.RE + +.TP +-agentpath:\fIpathname\fR[=\fIoptions\fR] +.br +Loads the native agent library specified by the absolute path name\&. This option is equivalent to \f3-agentlib\fR but uses the full path and file name of the library\&. +.TP +-client +.br +Selects the Java HotSpot Client VM\&. The 64-bit version of the Java SE Development Kit (JDK) currently ignores this option and instead uses the Server JVM\&. + +For default JVM selection, see Server-Class Machine Detection at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/server-class\&.html +.TP +-D\fIproperty\fR=\fIvalue\fR +.br +Sets a system property value\&. The \fIproperty\fR variable is a string with no spaces that represents the name of the property\&. The \fIvalue\fR variable is a string that represents the value of the property\&. If \fIvalue\fR is a string with spaces, then enclose it in quotation marks (for example \f3-Dfoo="foo bar"\fR)\&. +.TP +-d32 +.br +Runs the application in a 32-bit environment\&. If a 32-bit environment is not installed or is not supported, then an error will be reported\&. By default, the application is run in a 32-bit environment unless a 64-bit system is used\&. +.TP +-d64 +.br +Runs the application in a 64-bit environment\&. If a 64-bit environment is not installed or is not supported, then an error will be reported\&. By default, the application is run in a 32-bit environment unless a 64-bit system is used\&. + +Currently only the Java HotSpot Server VM supports 64-bit operation, and the \f3-server\fR option is implicit with the use of \f3-d64\fR\&. The \f3-client\fR option is ignored with the use of \f3-d64\fR\&. This is subject to change in a future release\&. +.TP .nf -\f3 -.fl - \fP\f3java\fP [ options ] class [ argument ... ] -.fl - \f3java\fP [ options ] \f3\-jar\fP file.jar [ argument ... ] -.fl +-disableassertions[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR], -da[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR] +.br .fi +Disables assertions\&. By default, assertions are disabled in all packages and classes\&. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -class -Name of the class to be invoked. -.TP 3 -file.jar -Name of the jar file to be invoked. Used only with \f2\-jar\fP. -.TP 3 -argument -Argument passed to the \f3main\fP function. +With no arguments, \f3-disableassertions\fR (\f3-da\fR) disables assertions in all packages and classes\&. With the \fIpackagename\fR argument ending in \f3\&.\&.\&.\fR, the switch disables assertions in the specified package and any subpackages\&. If the argument is simply \f3\&.\&.\&.\fR, then the switch disables assertions in the unnamed package in the current working directory\&. With the \fIclassname\fR argument\f3\fR, the switch disables assertions in the specified class\&. + +The \f3-disableassertions\fR (\f3-da\fR) option applies to all class loaders and to system classes (which do not have a class loader)\&. There is one exception to this rule: if the option is provided with no arguments, then it does not apply to system classes\&. This makes it easy to disable assertions in all classes except for system classes\&. The \f3-disablesystemassertions\fR option enables you to disable assertions in all system classes\&. + +To explicitly enable assertions in specific packages or classes, use the \f3-enableassertions\fR (\f3-ea\fR) option\&. Both options can be used at the same time\&. For example, to run the \f3MyClass\fR application with assertions enabled in package \f3com\&.wombat\&.fruitbat\fR (and any subpackages) but disabled in class \f3com\&.wombat\&.fruitbat\&.Brickbat\fR, use the following command: +.sp +.nf +\f3java \-ea:com\&.wombat\&.fruitbat\&.\&.\&. \-da:com\&.wombat\&.fruitbat\&.Brickbat MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-disablesystemassertions, -dsa +.br +Disables assertions in all system classes\&. +.TP +.nf +-enableassertions[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR], -ea[:[\fIpackagename\fR]\&.\&.\&.|:\fIclassname\fR] +.br +.fi +Enables assertions\&. By default, assertions are disabled in all packages and classes\&. + +With no arguments, \f3-enableassertions\fR (\f3-ea\fR) enables assertions in all packages and classes\&. With the \fIpackagename\fR argument ending in \f3\&.\&.\&.\fR, the switch enables assertions in the specified package and any subpackages\&. If the argument is simply \f3\&.\&.\&.\fR, then the switch enables assertions in the unnamed package in the current working directory\&. With the \fIclassname\fR argument\f3\fR, the switch enables assertions in the specified class\&. + +The \f3-enableassertions\fR (\f3-ea\fR) option applies to all class loaders and to system classes (which do not have a class loader)\&. There is one exception to this rule: if the option is provided with no arguments, then it does not apply to system classes\&. This makes it easy to enable assertions in all classes except for system classes\&. The \f3-enablesystemassertions\fR option provides a separate switch to enable assertions in all system classes\&. + +To explicitly disable assertions in specific packages or classes, use the \f3-disableassertions\fR (\f3-da\fR) option\&. If a single command contains multiple instances of these switches, then they are processed in order before loading any classes\&. For example, to run the \f3MyClass\fR application with assertions enabled only in package \f3com\&.wombat\&.fruitbat\fR (and any subpackages) but disabled in class \f3com\&.wombat\&.fruitbat\&.Brickbat\fR, use the following command: +.sp +.nf +\f3java \-ea:com\&.wombat\&.fruitbat\&.\&.\&. \-da:com\&.wombat\&.fruitbat\&.Brickbat MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-enablesystemassertions, -esa +.br +Enables assertions in all system classes\&. +.TP +-help, -? +.br +Displays usage information for the \f3java\fR command without actually running the JVM\&. +.TP +-jar \fIfilename\fR +.br +Executes a program encapsulated in a JAR file\&. The \fIfilename\fR argument is the name of a JAR file with a manifest that contains a line in the form \f3Main-Class:\fR\fIclassname\fR that defines the class with the \f3public static void main(String[] args)\fR method that serves as your application\&'s starting point\&. + +When you use the \f3-jar\fR option, the specified JAR file is the source of all user classes, and other class path settings are ignored\&. + +For more information about JAR files, see the following resources: +.RS +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +The Java Archive (JAR) Files guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jar/index\&.html +.TP 0.2i +\(bu +Lesson: Packaging Programs in JAR Files at http://docs\&.oracle\&.com/javase/tutorial/deployment/jar/index\&.html +.RE + +.TP +-javaagent:\fIjarpath\fR[=\fIoptions\fR] +.br +Loads the specified Java programming language agent\&. For more information about instrumenting Java applications, see the \f3java\&.lang\&.instrument\fR package description in the Java API documentation at http://docs\&.oracle\&.com/javase/8/docs/api/java/lang/instrument/package-summary\&.html +.TP +-jre-restrict-search +.br +Includes user-private JREs in the version search\&. +.TP +-no-jre-restrict-search +.br +Excludes user-private JREs from the version search\&. +.TP +-server +.br +Selects the Java HotSpot Server VM\&. The 64-bit version of the JDK supports only the Server VM, so in that case the option is implicit\&. + +For default JVM selection, see Server-Class Machine Detection at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/server-class\&.html +.TP +-showversion +.br +Displays version information and continues execution of the application\&. This option is equivalent to the \f3-version\fR option except that the latter instructs the JVM to exit after displaying version information\&. +.TP +-splash:\fIimgname\fR +.br +Shows the splash screen with the image specified by \fIimgname\fR\&. For example, to show the \f3splash\&.gif\fR file from the \f3images\fR directory when starting your application, use the following option: +.sp +.nf +\f3\-splash:images/splash\&.gif\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-verbose:class +.br +Displays information about each loaded class\&. +.TP +-verbose:gc +.br +Displays information about each garbage collection (GC) event\&. +.TP +-verbose:jni +.br +Displays information about the use of native methods and other Java Native Interface (JNI) activity\&. +.TP +-version +.br +Displays version information and then exits\&. This option is equivalent to the \f3-showversion\fR option except that the latter does not instruct the JVM to exit after displaying version information\&. +.TP +-version:\fIrelease\fR +.br +Specifies the release version to be used for running the application\&. If the version of the \f3java\fR command called does not meet this specification and an appropriate implementation is found on the system, then the appropriate implementation will be used\&. + +The \fIrelease\fR argument specifies either the exact version string, or a list of version strings and ranges separated by spaces\&. A \fIversion string\fR is the developer designation of the version number in the following form: \f31\&.\fR\fIx\fR\f3\&.0_\fR\fIu\fR (where \fIx\fR is the major version number, and \fIu\fR is the update version number)\&. A \fIversion range\fR is made up of a version string followed by a plus sign (\f3+\fR) to designate this version or later, or a part of a version string followed by an asterisk (\f3*\fR) to designate any version string with a matching prefix\&. Version strings and ranges can be combined using a space for a logical \fIOR\fR combination, or an ampersand (\f3&\fR) for a logical \fIAND\fR combination of two version strings/ranges\&. For example, if running the class or JAR file requires either JRE 6u13 (1\&.6\&.0_13), or any JRE 6 starting from 6u10 (1\&.6\&.0_10), specify the following: +.sp +.nf +\f3\-version:"1\&.6\&.0_13 1\&.6* & 1\&.6\&.0_10+"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Quotation marks are necessary only if there are spaces in the \fIrelease\fR parameter\&. + +For JAR files, the preference is to specify version requirements in the JAR file manifest rather than on the command line\&. +.SS NON-STANDARD\ OPTIONS +These options are general purpose options that are specific to the Java HotSpot Virtual Machine\&. +.TP +-X +.br +Displays help for all available \f3-X\fR options\&. +.TP +-Xbatch +.br +Disables background compilation\&. By default, the JVM compiles the method as a background task, running the method in interpreter mode until the background compilation is finished\&. The \f3-Xbatch\fR flag disables background compilation so that compilation of all methods proceeds as a foreground task until completed\&. + +This option is equivalent to \f3-XX:-BackgroundCompilation\fR\&. +.TP +-Xbootclasspath:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to search for boot class files\&. These are used in place of the boot class files included in the JDK\&. + +\fI\fRDo not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to append to the end of the default bootstrap class path\&. + +Do not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Specifies a list of directories, JAR files, and ZIP archives separated by colons (:) to prepend to the front of the default bootstrap class path\&. + +Do not deploy applications that use this option to override a class in \f3rt\&.jar\fR, because this violates the JRE binary code license\&. +.TP +-Xboundthreads +.br +Binds user-level threads to kernel threads\&. +.TP +-Xcheck:jni +.br +Performs additional checks for Java Native Interface (JNI) functions\&. Specifically, it validates the parameters passed to the JNI function and the runtime environment data before processing the JNI request\&. Any invalid data encountered indicates a problem in the native code, and the JVM will terminate with an irrecoverable error in such cases\&. Expect a performance degradation when this option is used\&. +.TP +-Xcomp +.br +Disables interpretation of Java code and compile methods on first invocation\&. By default, the JIT compiler performs 10,000 interpreted method invocations to gather information for efficient compilation\&. To increase compilation performance at the expense of efficiency, use the \f3-Xcomp\fR flag to disable interpreted method invocations\&. + +You can also change the number of interpreted method invocations before compilation using the \f3-XX:CompileThreshold\fR option\&. +.TP +-Xdebug +.br +Does nothing\&. Provided for backward compatibility\&. +.TP +-Xdiag +.br +Shows additional diagnostic messages\&. +.TP +-Xfuture +.br +Enables strict class-file format checks that enforce close conformance to the class-file format specification\&. Developers are encouraged to use this flag when developing new code because the stricter checks will become the default in future releases\&. +.TP +-Xincgc +.br +Enables incremental GC\&. +.TP +-Xint +.br +Runs the application in interpreted-only mode\&. Compilation to native code is disabled, and all bytecode is executed by the interpreter\&. The performance benefits offered by the just in time (JIT) compiler are not present in this mode\&. +.TP +-Xinternalversion +.br +Displays more detailed JVM version information than the \f3-version\fR option, and then exits\&. +.TP +-Xloggc:\fIfilename\fR +.br +Sets the file to which verbose GC events information should be redirected for logging\&. The information written to this file is similar to the output of \f3-verbose:gc\fR with the time elapsed since the first GC event preceding each logged event\&. The \f3-Xloggc\fR option overrides \f3-verbose:gc\fR if both are given with the same \f3java\fR command\&. + +Example: +.sp +.nf +\f3\-Xloggc:garbage\-collection\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xmaxjitcodesize=\fIsize\fR +.br +Specifies the maximum code cache size (in bytes) for JIT-compiled code\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the value is set to 48 MB: +.sp +.nf +\f3\-Xmaxjitcodesize=48m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This option is equivalent to \f3-XX:ReservedCodeCacheSize\fR\&. +.TP +-Xmixed +.br +Executes all bytecode by the interpreter except for hot methods, which are compiled to native code\&. +.TP +-Xmn\fIsize\fR +.br +Sets the initial and maximum size (in bytes) of the heap for the young generation (nursery)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The young generation region of the heap is used for new objects\&. GC is performed in this region more often than in other regions\&. If the size for the young generation is too small, then a lot of minor garbage collections will be performed\&. If the size is too large, then only full garbage collections will be performed, which can take a long time to complete\&. Oracle recommends that you keep the size for the young generation between a half and a quarter of the overall heap size\&. + +The following examples show how to set the initial and maximum size of young generation to 256 MB using various units: +.sp +.nf +\f3\-Xmn256m\fP +.fi +.nf +\f3\-Xmn262144k\fP +.fi +.nf +\f3\-Xmn268435456\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Instead of the \f3-Xmn\fR option to set both the initial and maximum size of the heap for the young generation, you can use \f3-XX:NewSize\fR to set the initial size and \f3-XX:MaxNewSize\fR to set the maximum size\&. +.TP +-Xms\fIsize\fR +.br +Sets the initial size (in bytes) of the heap\&. This value must be a multiple of 1024 and greater than 1 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The following examples show how to set the size of allocated memory to 6 MB using various units: +.sp +.nf +\f3\-Xms6291456\fP +.fi +.nf +\f3\-Xms6144k\fP +.fi +.nf +\f3\-Xms6m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If you do not set this option, then the initial size will be set as the sum of the sizes allocated for the old generation and the young generation\&. The initial size of the heap for the young generation can be set using the \f3-Xmn\fR option or the \f3-XX:NewSize\fR option\&. +.TP +-Xmx\fIsize\fR +.br +Specifies the maximum size (in bytes) of the memory allocation pool in bytes\&. This value must be a multiple of 1024 and greater than 2 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For server deployments, \f3-Xms\fR and \f3-Xmx\fR are often set to the same value\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the maximum allowed size of allocated memory to 80 MB using various units: +.sp +.nf +\f3\-Xmx83886080\fP +.fi +.nf +\f3\-Xmx81920k\fP +.fi +.nf +\f3\-Xmx80m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The \f3-Xmx\fR option is equivalent to \f3-XX:MaxHeapSize\fR\&. +.TP +-Xnoclassgc +.br +Disables garbage collection (GC) of classes\&. This can save some GC time, which shortens interruptions during the application run\&. + +When you specify \f3-Xnoclassgc\fR at startup, the class objects in the application will be left untouched during GC and will always be considered live\&. This can result in more memory being permanently occupied which, if not used carefully, will throw an out of memory exception\&. +.TP +-Xprof +.br +Profiles the running program and sends profiling data to standard output\&. This option is provided as a utility that is useful in program development and is not intended to be used in production systems\&. +.TP +-Xrs +.br +Reduces the use of operating system signals by the JVM\&. + +Shutdown hooks enable orderly shutdown of a Java application by running user cleanup code (such as closing database connections) at shutdown, even if the JVM terminates abruptly\&. + +The JVM catches signals to implement shutdown hooks for unexpected termination\&. The JVM uses \f3SIGHUP\fR, \f3SIGINT\fR, and \f3SIGTERM\fR to initiate the running of shutdown hooks\&. + +The JVM uses a similar mechanism to implement the feature of dumping thread stacks for debugging purposes\&. The JVM uses \f3SIGQUIT\fR to perform thread dumps\&. + +Applications embedding the JVM frequently need to trap signals such as \f3SIGINT\fR or \f3SIGTERM\fR, which can lead to interference with the JVM signal handlers\&. The \f3-Xrs\fR option is available to address this issue\&. When \f3-Xrs\fR is used, the signal masks for \f3SIGINT\fR, \f3SIGTERM\fR, \f3SIGHUP\fR, and \f3SIGQUIT\fR are not changed by the JVM, and signal handlers for these signals are not installed\&. + +There are two consequences of specifying \f3-Xrs\fR: +.RS +.TP 0.2i +\(bu +\f3SIGQUIT\fR thread dumps are not available\&. +.TP 0.2i +\(bu +User code is responsible for causing shutdown hooks to run, for example, by calling \f3System\&.exit()\fR when the JVM is to be terminated\&. +.RE + +.TP +-Xshare:\fImode\fR +.br +Sets the class data sharing mode\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +auto +Use shared class data if possible\&. This is the default value for Java HotSpot 32-Bit Client VM\&. +.TP +on +Require the use of class data sharing\&. Print an error message and exit if class data sharing cannot be used\&. +.TP +off +Do not use shared class data\&. This is the default value for Java HotSpot 32-Bit Server VM, Java HotSpot 64-Bit Client VM, and Java HotSpot 64-Bit Server VM\&. +.TP +dump +Manually generate the class data sharing archive\&. +.RE + +.TP +-XshowSettings:\fIcategory\fR +.br +Shows settings and continues\&. Possible \fIcategory\fR arguments for this option include the following: +.RS +.TP +all +Shows all categories of settings\&. This is the default value\&. +.TP +locale +Shows settings related to locale\&. +.TP +properties +Shows settings related to system properties\&. +.TP +vm +Shows the settings of the JVM\&. +.RE + +.TP +-Xss\fIsize\fR +.br +Sets the thread stack size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate KB, \f3m\fR or \f3M\fR to indicate MB, \f3g\fR or \f3G\fR to indicate GB\&. The default value depends on the platform: +.RS +.TP 0.2i +\(bu +Linux/ARM (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +OS X (64-bit): 1024 KB +.TP 0.2i +\(bu +Oracle Solaris/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Oracle Solaris/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +Windows: depends on virtual memory .RE +.RS +The following examples set the thread stack size to 1024 KB in different units: +.sp +.nf +\f3\-Xss1m\fP +.fi +.nf +\f3\-Xss1024k\fP +.fi +.nf +\f3\-Xss1048576\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3java\fP tool launches a Java application. It does this by starting a Java runtime environment, loading a specified class, and invoking that class's \f3main\fP method. -.LP -.LP -The method must be declared public and static, it must not return any value, and it must accept a \f2String\fP array as a parameter. The method declaration must look like the following: -.LP -.nf -\f3 -.fl -public static void main(String args[]) -.fl -\fP -.fi -.LP -.LP -By default, the first non\-option argument is the name of the class to be invoked. A fully\-qualified class name should be used. If the \f3\-jar\fP option is specified, the first non\-option argument is the name of a \f3JAR\fP archive containing class and resource files for the application, with the startup class indicated by the \f3Main\-Class\fP manifest header. -.LP -.LP -The Java runtime searches for the startup class, and other classes used, in three sets of locations: the bootstrap class path, the installed extensions, and the user class path. -.LP -.LP -Non\-option arguments after the class name or JAR file name are passed to the \f3main\fP function. -.LP -.SH "OPTIONS" -.LP -.LP -The launcher has a set of standard options that are supported on the current runtime environment and will be supported in future releases. In addition, the current implementations of the virtual machines support a set of non\-standard options that are subject to change in future releases. -.LP -.SH "Standard Options" -.LP -.RS 3 -.TP 3 -\-client -Select the Java HotSpot Client VM. A 64\-bit capable jdk currently ignores this option and instead uses the Java Hotspot Server VM. -.br -.br -For default VM selection, see -.na -\f2Server\-Class Machine Detection\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html -.TP 3 -\-server -Select the Java HotSpot Server VM. On a 64\-bit capable jdk only the Java Hotspot Server VM is supported so the \-server option is implicit. -.br -.br -For default VM selection, see -.na -\f2Server\-Class Machine Detection\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/server\-class.html -.TP 3 -\-agentlib:libname[=options] -Load native agent library \f2libname\fP, e.g. -.br -.br -\-agentlib:hprof -.br -.br -\-agentlib:jdwp=help -.br -.br -\-agentlib:hprof=help -.br -.br -For more information, see -.na -\f2JVMTI Agent Command Line Options\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting. -.TP 3 -\-agentpath:pathname[=options] -Load a native agent library by full pathname. For more information, see -.na -\f2JVMTI Agent Command Line Options\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/jvmti/jvmti.html#starting. -.TP 3 -\-classpath classpath -.TP 3 -\-cp classpath -Specify a list of directories, JAR archives, and ZIP archives to search for class files. Class path entries are separated by colons (\f3:\fP). Specifying \f3\-classpath\fP or \f3\-cp\fP overrides any setting of the \f3CLASSPATH\fP environment variable. -.br -.br -If \f3\-classpath\fP and \f3\-cp\fP are not used and \f3CLASSPATH\fP is not set, the user class path consists of the current directory (\f4.\fP). -.br -.br -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations). -.br -.br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.br -.br -For more information on class paths, see -.na -\f2Setting the Class Path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath. -.TP 3 -\-Dproperty=value -Set a system property value. -.TP 3 -\-d32 -.TP 3 -\-d64 -Request that the program to be run in a 32\-bit or 64\-bit environment, respectively. If the requested environment is not installed or is not supported, an error is reported. -.br -.br -Currently only the Java HotSpot Server VM supports 64\-bit operation, and the "\-server" option is implicit with the use of \-d64. And the "\-client" option is ignored with the use of \-d64. This is subject to change in a future release. -.br -.br -If neither \f3\-d32\fP nor \f3\-d64\fP is specified, the default is to run in a 32\-bit environment, except for 64\-bit only systems. This is subject to change in a future release. -.TP 3 -\-enableassertions[:<package name>"..." | :<class name> ] -.TP 3 -\-ea[:<package name>"..." | :<class name> ] -Enable assertions. Assertions are disabled by default. -.br -.br -With no arguments, \f3enableassertions\fP or \f3\-ea\fP enables assertions. With one argument ending in \f2"..."\fP, the switch enables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch enables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch enables assertions in the specified class. -.br -.br -If a single command line contains multiple instances of these switches, they are processed in order before loading any classes. So, for example, to run a program with assertions enabled only in package \f2com.wombat.fruitbat\fP (and any subpackages), the following command could be used: -.nf -\f3 -.fl -java \-ea:com.wombat.fruitbat... <Main Class> -.fl -\fP -.fi -The \f3\-enableassertions\fP and \f3\-ea\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-enablesystemassertions\fP below. -.TP 3 -\-disableassertions[:<package name>"..." | :<class name> ] -.TP 3 -\-da[:<package name>"..." | :<class name> ] -Disable assertions. This is the default. -.br -.br -With no arguments, \f3disableassertions\fP or \f3\-da\fP disables assertions. With one argument ending in \f2"..."\fP, the switch disables assertions in the specified package and any subpackages. If the argument is simply \f2"..."\fP, the switch disables assertions in the unnamed package in the current working directory. With one argument not ending in \f2"..."\fP, the switch disables assertions in the specified class. -.br -.br -To run a program with assertions enabled in package \f2com.wombat.fruitbat\fP but disabled in class \f2com.wombat.fruitbat.Brickbat\fP, the following command could be used: -.nf -\f3 -.fl -java \-ea:com.wombat.fruitbat... \-da:com.wombat.fruitbat.Brickbat \fP\f4<Main Class>\fP\f3 -.fl -\fP -.fi -The \f3\-disableassertions\fP and \f3\-da\fP switches apply to \f2all\fP class loaders and to system classes (which do not have a class loader). There is one exception to this rule: in their no\-argument form, the switches do \f2not\fP apply to system. This makes it easy to turn on asserts in all classes except for system classes. A separate switch is provided to enable asserts in all system classes; see \f3\-disablesystemassertions\fP below. -.TP 3 -\-enablesystemassertions -.TP 3 -\-esa -Enable asserts in all system classes (sets the \f2default assertion status\fP for system classes to \f2true\fP). -.TP 3 -\-disablesystemassertions -.TP 3 -\-dsa -Disables asserts in all system classes. -.TP 3 -\-jar -Execute a program encapsulated in a JAR file. The first argument is the name of a JAR file instead of a startup class name. In order for this option to work, the manifest of the JAR file must contain a line of the form \f3Main\-Class: \fP\f4classname\fP. Here, \f2classname\fP identifies the class having the \f2public\ static\ void\ main(String[]\ args)\fP method that serves as your application's starting point. See the jar(1) and the Jar trail of the -.na -\f2Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/deployment/jar for information about working with Jar files and Jar\-file manifests. -.br -.br -When you use this option, the JAR file is the source of all user classes, and other user class path settings are ignored. -.br -.br -Note that JAR files that can be run with the "java \-jar" option can have their execute permissions set so they can be run without using "java \-jar". Refer to -.na -\f2Java Archive (JAR) Files\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jar/index.html. -.TP 3 -\-javaagent:jarpath[=options] -Load a Java programming language agent, see -.na -\f2java.lang.instrument\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/lang/instrument/package\-summary.html. -.TP 3 -\-jre\-restrict\-search -Include user\-private JREs in the version search. -.TP 3 -\-no\-jre\-restrict\-search -Exclude user\-private JREs in the version search. -.TP 3 -\-verbose -.TP 3 -\-verbose:class -Display information about each class loaded. -.TP 3 -\-verbose:gc -Report on each garbage collection event. -.TP 3 -\-verbose:jni -Report information about use of native methods and other Java Native Interface activity. -.TP 3 -\-version -Display version information and exit. -.TP 3 -\-version:release -Specifies that the version specified by \f2release\fP is required by the class or jar file specified on the command line. If the version of the java command invoked does not meet this specification and an appropriate implementation is found on the system, the appropriate implementation will be used. -.br -.br -\f2release\fP not only can specify an exact version, but can also specify a list of versions called a version string. A version string is an ordered list of version ranges separated by spaces. A version range is either a version\-id, a version\-id followed by a star (*), a version\-id followed by a plus sign (+) , or two version\-ranges combined using an ampersand (&). The star means prefix match, the plus sign means this version or greater, and the ampersand means the logical anding of the two version\-ranges. For example: -.nf -\f3 -.fl -\-version:"1.6.0_13 1.6*&1.6.0_10+" -.fl -\fP -.fi -The meaning of the above is that the class or jar file requires either version 1.6.0_13, or a version with 1.6 as a version\-id prefix and that is not less than 1.6.0_10.. The exact syntax and definition of version strings may be found in Appendix A of the Java Network Launching Protocol & API Specification (JSR\-56). -.br -.br -For jar files, the usual preference is to specify version requirements in the jar file manifest rather than on the command line. -.br -.br -See the following NOTES section for important policy information on the use of this option. -.TP 3 -\-showversion -Display version information and continue. -.TP 3 -\-? -.TP 3 -\-help -Display usage information and exit. -.TP 3 -\-splash:imagepath -Show splash screen with image specified by \f2imagepath\fP. -.TP 3 -\-X -Display information about non\-standard options and exit. +This option is equivalent to \f3-XX:ThreadStackSize\fR\&. + .RE +.TP +-Xusealtsigs +.br +Use alternative signals instead of \f3SIGUSR1\fR and \f3SIGUSR2\fR for JVM internal signals\&. This option is equivalent to \f3-XX:+UseAltSigs\fR\&. +.TP +-Xverify:\fImode\fR +.br +Sets the mode of the bytecode verifier\&. Bytecode verification helps to troubleshoot some problems, but it also adds overhead to the running application\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +none +Do not verify the bytecode\&. This reduces startup time and also reduces the protection provided by Java\&. +.TP +remote +Verify only those classes that are loaded remotely over the network\&. This is the default behavior if you do not specify the \f3-Xverify\fR option\&. +.TP +all +Verify all classes\&. +.RE -.LP -.SS -Non\-Standard Options -.LP -.RS 3 -.TP 3 -\-Xint -Operate in interpreted\-only mode. Compilation to native code is disabled, and all bytecodes are executed by the interpreter. The performance benefits offered by the Java HotSpot VMs' adaptive compiler will not be present in this mode. -.TP 3 -\-Xbatch -Disable background compilation. Normally the VM will compile the method as a background task, running the method in interpreter mode until the background compilation is finished. The \f2\-Xbatch\fP flag disables background compilation so that compilation of all methods proceeds as a foreground task until completed. -.TP 3 -\-Xbootclasspath:bootclasspath -Specify a colon\-separated list of directories, JAR archives, and ZIP archives to search for boot class files. These are used in place of the boot class files included in the Java platform JDK. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java Runtime Environment binary code license.\fP -.TP 3 -\-Xbootclasspath/a:path -Specify a colon\-separated path of directires, JAR archives, and ZIP archives to append to the default bootstrap class path. -.TP 3 -\-Xbootclasspath/p:path -Specify a colon\-separated path of directires, JAR archives, and ZIP archives to prepend in front of the default bootstrap class path. \f2Note: Applications that use this option for the purpose of overriding a class in rt.jar should not be deployed as doing so would contravene the Java Runtime Environment binary code license.\fP -.TP 3 -\-Xcheck:jni -Perform additional checks for Java Native Interface (JNI) functions. Specifically, the Java Virtual Machine validates the parameters passed to the JNI function as well as the runtime environment data before processing the JNI request. Any invalid data encountered indicates a problem in the native code, and the Java Virtual Machine will terminate with a fatal error in such cases. Expect a performance degradation when this option is used. -.TP 3 -\-Xfuture -Perform strict class\-file format checks. For purposes of backwards compatibility, the default format checks performed by the JDK's virtual machine are no stricter than the checks performed by 1.1.x versions of the JDK software. The \f3\-Xfuture\fP flag turns on stricter class\-file format checks that enforce closer conformance to the class\-file format specification. Developers are encouraged to use this flag when developing new code because the stricter checks will become the default in future releases of the Java application launcher. -.TP 3 -\-Xnoclassgc -Disable class garbage collection. Use of this option will prevent memory recovery from loaded classes thus increasing overall memory usage. This could cause OutOfMemoryError to be thrown in some applications. -.TP 3 -\-Xincgc -Enable the incremental garbage collector. The incremental garbage collector, which is off by default, will reduce the occasional long garbage\-collection pauses during program execution. The incremental garbage collector will at times execute concurrently with the program and during such times will reduce the processor capacity available to the program. -.TP 3 -\-Xloggc:file -Report on each garbage collection event, as with \-verbose:gc, but log this data to \f2file\fP. In addition to the information \f2\-verbose:gc\fP gives, each reported event will be preceeded by the time (in seconds) since the first garbage\-collection event. +.SS ADVANCED\ RUNTIME\ OPTIONS +These options control the runtime behavior of the Java HotSpot VM\&. +.TP +-XX:+DisableAttachMechanism .br +Enables the option that disables the mechanism that lets tools attach to the JVM\&. By default, this option is disabled, meaning that the attach mechanism is enabled and you can use tools such as \f3jcmd\fR, \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR\&. +.TP +-XX:ErrorFile=\fIfilename\fR .br -Always use a local file system for storage of this file to avoid stalling the JVM due to network latency. The file may be truncated in the case of a full file system and logging will continue on the truncated file. This option overrides \f2\-verbose:gc\fP if both are given on the command line. -.TP 3 -\-Xmsn -Specify the initial size, in bytes, of the memory allocation pool. This value must be a multiple of 1024 greater than 1MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see -.na -\f2HotSpot Ergonomics\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html -.br -.br -Examples: -.nf -\f3 -.fl - \-Xms6291456 -.fl - \-Xms6144k -.fl - \-Xms6m -.fl +Specifies the path and file name to which error data is written when an irrecoverable error occurs\&. By default, this file is created in the current working directory and named \f3hs_err_pid\fR\fIpid\fR\f3\&.log\fR where \fIpid\fR is the identifier of the process that caused the error\&. The following example shows how to set the default log file (note that the identifier of the process is specified as \f3%p\fR): +.sp +.nf +\f3\-XX:ErrorFile=\&./hs_err_pid%p\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -\fP -.fi -.TP 3 -\-Xmxn -Specify the maximum size, in bytes, of the memory allocation pool. This value must a multiple of 1024 greater than 2MB. Append the letter \f2k\fP or \f2K\fP to indicate kilobytes, or \f2m\fP or \f2M\fP to indicate megabytes. The default value is chosen at runtime based on system configuration. For more information, see -.na -\f2HotSpot Ergonomics\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/vm/gc\-ergonomics.html -.br -.br -Examples: -.nf -\f3 -.fl - \-Xmx83886080 -.fl - \-Xmx81920k -.fl - \-Xmx80m -.fl -.fl -\fP -.fi -On Solaris 7 and Solaris 8 SPARC platforms, the upper limit for this value is approximately 4000m minus overhead amounts. On Solaris 2.6 and x86 platforms, the upper limit is approximately 2000m minus overhead amounts. On Linux platforms, the upper limit is approximately 2000m minus overhead amounts. -.TP 3 -\-Xprof -Profiles the running program, and sends profiling data to standard output. This option is provided as a utility that is useful in program development and is not intended to be used in production systems. -.TP 3 -\-Xrs -Reduces use of operating\-system signals by the Java virtual machine (JVM). +The following example shows how to set the error log to \f3/var/log/java/java_error\&.log\fR: +.sp +.nf +\f3\-XX:ErrorFile=/var/log/java/java_error\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the file cannot be created in the specified directory (due to insufficient space, permission problem, or another issue), then the file is created in the temporary directory for the operating system\&. The temporary directory is \f3/tmp\fR\&. +.TP +-XX:LargePageSizeInBytes=\fIsize\fR .br +Sets the maximum size (in bytes) for large pages used for Java heap\&. The \fIsize\fR argument must be a power of 2 (2, 4, 8, 16, \&.\&.\&.)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the size is set to 0, meaning that the JVM chooses the size for large pages automatically\&. + +The following example illustrates how to set the large page size to 4 megabytes (MB): +.sp +.nf +\f3\-XX:LargePageSizeInBytes=4m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxDirectMemorySize=\fIsize\fR .br -In a previous release, the Shutdown Hooks facility was added to allow orderly shutdown of a Java application. The intent was to allow user cleanup code (such as closing database connections) to run at shutdown, even if the JVM terminates abruptly. +Sets the maximum total size (in bytes) of the New I/O (the \f3java\&.nio\fR package) direct-buffer allocations\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the size is set to 0, meaning that the JVM chooses the size for NIO direct-buffer allocations automatically\&. + +The following examples illustrate how to set the NIO size to 1024 KB in different units: +.sp +.nf +\f3\-XX:MaxDirectMemorySize=1m\fP +.fi +.nf +\f3\-XX:MaxDirectMemorySize=1024k\fP +.fi +.nf +\f3\-XX:MaxDirectMemorySize=1048576\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NativeMemoryTracking=\fImode\fR .br +Specifies the mode for tracking JVM native memory usage\&. Possible \fImode\fR arguments for this option include the following: +.RS +.TP +off +Do not track JVM native memory usage\&. This is the default behavior if you do not specify the \f3-XX:NativeMemoryTracking\fR option\&. +.TP +summary +Only track memory usage by JVM subsystems, such as Java heap, class, code, and thread\&. +.TP +detail +In addition to tracking memory usage by JVM subsystems, track memory usage by individual \f3CallSite\fR, individual virtual memory region and its committed regions\&. +.RE + +.TP +-XX:OnError=\fIstring\fR .br -Sun's JVM catches signals to implement shutdown hooks for abnormal JVM termination. The JVM uses SIGHUP, SIGINT, and SIGTERM to initiate the running of shutdown hooks. +Sets a custom command or a series of semicolon-separated commands to run when an irrecoverable error occurs\&. If the string contains spaces, then it must be enclosed in quotation marks\&. + +\fI\fRThe following example shows how the \f3-XX:OnError\fR option can be used to run the \f3gcore\fR command to create the core image, and the debugger is started to attach to the process in case of an irrecoverable error (the \f3%p\fR designates the current process): +.sp +.nf +\f3\-XX:OnError="gcore %p;dbx \- %p"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:OnOutOfMemoryError=\fIstring\fR .br +Sets a custom command or a series of semicolon-separated commands to run when an \f3OutOfMemoryError\fR exception is first thrown\&. If the string contains spaces, then it must be enclosed in quotation marks\&. For an example of a command string, see the description of the \f3-XX:OnError\fR option\&. +.TP +-XX:+PrintCommandLineFlags .br -The JVM uses a similar mechanism to implement the pre\-1.2 feature of dumping thread stacks for debugging purposes. Sun's JVM uses SIGQUIT to perform thread dumps. +Enables printing of ergonomically selected JVM flags that appeared on the command line\&. It can be useful to know the ergonomic values set by the JVM, such as the heap space size and the selected garbage collector\&. By default, this option is disabled and flags are not printed\&. +.TP +-XX:+PrintNMTStatistics .br +Enables printing of collected native memory tracking data at JVM exit when native memory tracking is enabled (see \f3-XX:NativeMemoryTracking\fR)\&. By default, this option is disabled and native memory tracking data is not printed\&. +.TP +-XX:+ShowMessageBoxOnError .br -Applications embedding the JVM frequently need to trap signals like SIGINT or SIGTERM, which can lead to interference with the JVM's own signal handlers. The \f3\-Xrs\fP command\-line option is available to address this issue. When \f3\-Xrs\fP is used on Sun's JVM, the signal masks for SIGINT, SIGTERM, SIGHUP, and SIGQUIT are not changed by the JVM, and signal handlers for these signals are not installed. +Enables displaying of a dialog box when the JVM experiences an irrecoverable error\&. This prevents the JVM from exiting and keeps the process active so that you can attach a debugger to it to investigate the cause of the error\&. By default, this option is disabled\&. +.TP +-XX:ThreadStackSize=\fIsize\fR .br -.br -There are two consequences of specifying \f3\-Xrs\fP: -.RS 3 -.TP 2 -o -SIGQUIT thread dumps are not available. -.TP 2 -o -User code is responsible for causing shutdown hooks to run, for example by calling System.exit() when the JVM is to be terminated. -.RE -.TP 3 -\-Xssn -Set thread stack size. -.TP 3 -\-XX:+UseAltSigs -The VM uses \f2SIGUSR1\fP and \f2SIGUSR2\fP by default, which can sometimes conflict with applications that signal\-chain \f2SIGUSR1\fP and \f2SIGUSR2\fP. The \f2\-XX:+UseAltSigs\fP option will cause the VM to use signals other than \f2SIGUSR1\fP and \f2SIGUSR2\fP as the default. +Sets the thread stack size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value depends on the platform: +.RS +.TP 0.2i +\(bu +Linux/ARM (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Linux/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +OS X (64-bit): 1024 KB +.TP 0.2i +\(bu +Oracle Solaris/i386 (32-bit): 320 KB +.TP 0.2i +\(bu +Oracle Solaris/x64 (64-bit): 1024 KB +.TP 0.2i +\(bu +Windows: depends on virtual memory .RE +.RS +The following examples show how to set the thread stack size to 1024 KB in different units: +.sp +.nf +\f3\-XX:ThreadStackSize=1m\fP +.fi +.nf +\f3\-XX:ThreadStackSize=1024k\fP +.fi +.nf +\f3\-XX:ThreadStackSize=1048576\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "NOTES" -.LP -.LP -The \f3\-version:\fP\f2release\fP command line option places no restrictions on the complexity of the release specification. However, only a restricted subset of the possible release specifications represent sound policy and only these are fully supported. These policies are: -.LP -.RS 3 -.TP 3 -1. -Any version, represented by not using this option. -.TP 3 -2. -Any version greater than an arbitrarily precise version\-id. For example: + +This option is equivalent to \f3-Xss\fR\&. + +.RE +.TP +-XX:+TraceClassLoading +.br +Enables tracing of classes as they are loaded\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceClassLoadingPreorder +.br +Enables tracing of all loaded classes in the order in which they are referenced\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceClassResolution +.br +Enables tracing of constant pool resolutions\&. By default, this option is disabled and constant pool resolutions are not traced\&. +.TP +-XX:+TraceClassUnloading +.br +Enables tracing of classes as they are unloaded\&. By default, this option is disabled and classes are not traced\&. +.TP +-XX:+TraceLoaderConstraints +.br +Enables tracing of the loader constraints recording\&. By default, this option is disabled and loader constraints recoding is not traced\&. +.TP +-XX:+UseAltSigs +.br +Enables the use of alternative signals instead of \f3SIGUSR1\fR and \f3SIGUSR2\fR for JVM internal signals\&. By default, this option is disabled and alternative signals are not used\&. This option is equivalent to \f3-Xusealtsigs\fR\&. +.TP +-XX:+UseBiasedLocking +.br +Enables the use of biased locking\&. Some applications with significant amounts of uncontended synchronization may attain significant speedups with this flag enabled, whereas applications with certain patterns of locking may see slowdowns\&. For more information about the biased locking technique, see the example in Java Tuning White Paper at http://www\&.oracle\&.com/technetwork/java/tuning-139912\&.html#section4\&.2\&.5 + +By default, this option is disabled and biased locking is not used\&. +.TP +-XX:+UseCompressedOops +.br +Enables the use of compressed pointers\&. When this option is enabled, object references are represented as 32-bit offsets instead of 64-bit pointers, which typically increases performance when running the application with Java heap sizes less than 32 GB\&. This option works only for 64-bit JVMs\&. + +By default, this option is disabled and compressed pointers are not used\&. +.TP +-XX:+UseLargePages +.br +Enables the use of large page memory\&. This option is enabled by default\&. To disable the use of large page memory, specify \f3-XX:-UseLargePages\fR\&. + +For more information, see Java Support for Large Memory Pages at http://www\&.oracle\&.com/technetwork/java/javase/tech/largememory-jsp-137182\&.html +.TP +-XX:+UseMembar +.br +Enables issuing of membars on thread state transitions\&. This option is disabled by default on all platforms except Power PC and ARM servers, where it is enabled\&. To disable issuing of membars on thread state transitions for Power PC and ARM, specify \f3-XX:-UseMembar\fR\&. +.TP +-XX:+UsePerfData +.br +Enables the \f3perfdata\fR feature\&. This option is enabled by default to allow JVM monitoring and performance testing\&. Disabling it suppresses the creation of the \f3hsperfdata_userid\fR directories\&. To disable the \f3perfdata\fR feature, specify \f3-XX:-UsePerfData\fR\&. +.TP +-XX:+AllowUserSignalHandlers +.br +Enables installation of signal handlers by the application\&. By default, this option is disabled and the application is not allowed to install signal handlers\&. +.SS ADVANCED\ JIT\ COMPILER\ OPTIONS +These options control the dynamic just-in-time (JIT) compilation performed by the Java HotSpot VM\&. +.TP +-XX:+AggressiveOpts +.br +Enables the use of aggressive performance optimization features, which are expected to become default in upcoming releases\&. By default, this option is disabled and experimental performance features are not used\&. +.TP +-XX:AllocateInstancePrefetchLines=\fIlines\fR +.br +Sets the number of lines to prefetch ahead of the instance allocation pointer\&. By default, the number of lines to prefetch is set to 1: +.sp +.nf +\f3\-XX:AllocateInstancePrefetchLines=1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchInstr=\fIinstruction\fR +.br +Sets the prefetch instruction to prefetch ahead of the allocation pointer\&. Possible values are from 0 to 3\&. The actual instructions behind the values depend on the platform\&. By default, the prefetch instruction is set to 0: +.sp +.nf +\f3\-XX:AllocatePrefetchInstr=0\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchStepSize=\fIsize\fR +.br +Sets the step size (in bytes) for sequential prefetch instructions\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the step size is set to 16 bytes: +.sp +.nf +\f3\-XX:AllocatePrefetchStepSize=16\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+BackgroundCompilation +.br +Enables background compilation\&. This option is enabled by default\&. To disable background compilation, specify \f3-XX:-BackgroundCompilation\fR (this is equivalent to specifying \f3-Xbatch\fR)\&. +.TP +-XX:CICompilerCount=\fIthreads\fR +.br +Sets the number of compiler threads to use for compilation\&. By default, the number of threads is set to 2 for the server JVM, to 1 for the client JVM, and it scales to the number of cores if tiered compilation is used\&. The following example shows how to set the number of threads to 2: +.sp +.nf +\f3\-XX:CICompilerCount=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CodeCacheMinimumFreeSpace=\fIsize\fR +.br +Sets the minimum free space (in bytes) required for compilation\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. When less than the minimum free space remains, compiling stops\&. By default, this option is set to 500 KB\&. The following example shows how to set the minimum free space to 1024 MB: +.sp +.nf +\f3\-XX:CodeCacheMinimumFreeSpace=1024m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP .nf -\f3 -.fl -"1.6.0_10+" -.fl -\fP +-XX:CompileCommand=\fIcommand\fR,\fIclass\fR\&.\fImethod\fR[,\fIoption\fR] +.br .fi -This would utilize any version greater than \f21.6.0_10\fP. This is useful for a case where an interface was introduced (or a bug fixed) in the release specified. -.TP 3 -3. -A version greater than an arbitrarily precise version\-id, bounded by the upper bound of that release family. For example: -.nf -\f3 -.fl -"1.6.0_10+&1.6*" -.fl -\fP -.fi -.TP 3 -4. -"Or" expressions of items 2. or 3. above. For example: -.nf -\f3 -.fl -"1.6.0_10+&1.6* 1.7+" -.fl -\fP -.fi -Similar to item 2. this is useful when a change was introduced in a release (1.7) but also made available in updates to previous releases. -.RE +Attaches a line to the \f3\&.hotspot_compiler\fR file with the command for the specific method of the class\&. For example, to exclude the \f3indexOf()\fR method of the \f3String\fR class from being compiled, use the following: +.sp +.nf +\f3\-XX:CompileCommand=exclude,java/lang/String\&.indexOf\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are generally returned by the launcher, typically when the launcher is called with the wrong arguments, serious errors, or exceptions thrown from the Java Virtual Machine. However, a Java application may choose to return any value using the API call \f2System.exit(exitValue)\fP. -.LP -.RS 3 -.TP 2 -o -\f20\fP: Successful completion -.TP 2 -o -\f2>0\fP: An error occurred -.RE -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -javac(1) -.TP 2 -o -jdb(1) -.TP 2 -o -javah(1) -.TP 2 -o -jar(1) -.TP 2 -o -.na -\f2The Java Extensions Framework\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html -.TP 2 -o -.na -\f2Security Features\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/index.html. -.TP 2 -o -.na -\f2HotSpot VM Specific Options\fP @ -.fi -http://java.sun.com/docs/hotspot/VMOptions.html. -.RE +Note that you must specify the full class name, including all packages and subpackages separated by a slash (\f3/\fR)\&. -.LP - +To add several commands, either specify this option multiple times, or separate each argument with the newline separator (\f3\en\fR)\&. To better understand the syntax of the JVM compiler commands, refer to the description of the \f3-XX:CompileCommandFile\fR option, which enables you to specify the file from which to read compiler commands\&. Notice how the syntax of the command file differs rom the syntax of the argument for the \f3-XX:CompileCommand\fR option\&. The commas and periods in the argument are aliases for spaces in the command file, making it easier to pass compiler commands through a shell\&. To pass arguments to \f3-XX:CompileCommand\fR with the same syntax as that used in the command file, you can enclose the argument in quotation marks: +.sp +.nf +\f3\-XX:CompileCommand="exclude java/lang/String indexOf"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +For easier cut and paste operations, it is also possible to use the method name format produced by the \f3-XX:+PrintCompilation\fR and \f3-XX:+LogCompilation\fR options: +.sp +.nf +\f3\-XX:CompileCommand="exclude java\&.lang\&.String::indexOf"\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands are available: +.RS +.TP +break +Set a breakpoint when debugging the JVM to stop at the beginning of compilation of the specified method\&. +.TP +compileonly +Exclude all methods from compilation except for the specified method\&. +.TP +dontinline +Prevent inlining of the specified method\&. +.TP +exclude +Exclude the specified method from compilation\&. +.TP +help +Print a help message for the \f3-XX:CompileCommand\fR option\&. +.TP +inline +Attempt to inline the specified method\&. +.TP +log +Exclude compilation logging (with the \f3-XX:+LogCompilation\fR option) for all methods except for the specified method\&. By default, logging is performed for all compiled methods\&. +.TP +print +Print generated assembler code after compilation of the specified method\&. +.TP +quiet +Do not print the compile commands\&. By default, the commands that you specify with the -\f3XX:CompileCommand\fR option are printed; for example, if you exclude from compilation the \f3indexOf()\fR method of the \f3String\fR class, then the following will be printed to standard output: +.sp +.nf +\f3CompilerOracle: exclude java/lang/String\&.indexOf\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can suppress this by specifying the \f3-XX:CompileCommand=quiet\fR option before other \f3-XX:CompileCommand\fR options\&. +.RE + + +.RS +The optional last argument (\fIoption\fR) can be used to pass a JIT compilation option to the specified method\&. The compilation option is set at the end, after the method name\&. For example, to enable the \f3BlockLayoutByFrequency\fR option for the \f3append()\fR method of the \f3StringBuffer\fR class, use the following: +.sp +.nf +\f3\-XX:CompileCommand=option,java/lang/StringBuffer\&.append,BlockLayoutByFrequency\fP +.fi +.nf +\f3\fP +.fi +.sp + + +.RE +.TP +-XX:CompileCommandFile=\fIfilename\fR +.br +Sets the file from which compiler commands are read\&. By default, the \f3\&.hotspot_compiler\fR file is used to store commands performed by the JVM compiler\&. + +Each line in the command file represents a command, a class name, and a method name for which the command is used (all three parts are separated by spaces)\&. For example, this line prints assembly code for the \f3toString()\fR method of the \f3String\fR class: +.sp +.nf +\f3print java/lang/String toString\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To add commands to the beginning of the \f3\&.hotspot_compiler\fR file, use the \f3-XX:CompileCommand\fR option\&. Note how the syntax of the command file is different from the syntax of the argument for the \f3-XX:CompileCommand\fR option\&. The commas and periods in the argument are aliases for spaces in the command file, making it easier to pass compiler commands through a shell\&. Although it is possible to pass arguments to \f3-XX:CompileCommand\fR with the same syntax as that used in the command file, you would have to enclose the string argument in quotation marks\&. +.TP +-XX:CompileOnly=\fImethods\fR +.br +Sets the list of methods (separated by commas) to which compilation should be restricted\&. Only the specified methods will be compiled\&. Specify each method with the full class name (including the packages and subpackages)\&. For example, to compile only the \f3length()\fR method of the \f3String\fR class and the \f3size()\fR method of the \f3List\fR class, use the following: +.sp +.nf +\f3\-XX:CompileOnly=java/lang/String\&.length,java/util/List\&.size\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CompileThreshold=\fIinvocations\fR +.br +Sets the number of interpreted method invocations before compilation\&. By default, in the server JVM, the JIT compiler performs 10,000 interpreted method invocations to gather information for efficient compilation\&. For the client JVM, the default setting is 1,500 invocations\&. The following example shows how to set the number of interpreted method invocations to 5,000: +.sp +.nf +\f3\-XX:CompileThreshold=5000\fP +.fi +.nf +\f3\fP +.fi +.sp + + +You can completely disable interpretation of Java methods before compilation by specifying the \f3-Xcomp\fR option\&. +.TP +-XX:+DoEscapeAnalysis +.br +Enables the use of escape analysis\&. This option is enabled by default\&. To disable the use of escape analysis, specify \f3-XX:-DoEscapeAnalysis\fR\&. +.TP +-XX:+FailOverToOldVerifier +.br +Enables automatic failover to the old verifier when the new type checker fails\&. By default, this option is disabled and it is ignored (that is, treated as disabled) for classes with a recent bytecode version\&. You can enable it for classes with older versions of the bytecode\&. +.TP +-XX:InitialCodeCacheSize=\fIsize\fR +.br +Sets the initial code cache size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is set to 500 KB\&. The following example shows how to set the initial code cache size to 32 KB: +.sp +.nf +\f3\-XX:InitialCodeCacheSize=32k\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+Inline +.br +Enables method inlining\&. This option is enabled by default to increase performance\&. To disable method inlining, specify \f3-XX:-Inline\fR\&. +.TP +-XX:InlineSmallCode=\fIsize\fR +.br +Sets the maximum code size (in bytes) for compiled methods that should be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. Only compiled methods with the size smaller than the specified size will be inlined\&. By default, the maximum code size is set to 1000 bytes: +.sp +.nf +\f3\-XX:InlineSmallCode=1000\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+LogCompilation +.br +Enables logging of compilation activity to a file named \f3hotspot\&.log\fR in the current working directory\&. You can specify a different log file path and name using the \f3-XX:LogFile\fR option\&. + +By default, this option is disabled and compilation activity is not logged\&. The \f3-XX:+LogCompilation\fR option has to be used together with the \f3-XX:UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. + +You can enable verbose diagnostic output with a message printed to the console every time a method is compiled by using the \f3-XX:+PrintCompilation\fR option\&. +.TP +-XX:MaxInlineSize=\fIsize\fR +.br +Sets the maximum bytecode size (in bytes) of a method to be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the maximum bytecode size is set to 35 bytes: +.sp +.nf +\f3\-XX:MaxInlineSize=35\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxNodeLimit=\fInodes\fR +.br +Sets the maximum number of nodes to be used during single method compilation\&. By default, the maximum number of nodes is set to 65,000: +.sp +.nf +\f3\-XX:MaxNodeLimit=65000\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxTrivialSize=\fIsize\fR +.br +Sets the maximum bytecode size (in bytes) of a trivial method to be inlined\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. By default, the maximum bytecode size of a trivial method is set to 6 bytes: +.sp +.nf +\f3\-XX:MaxTrivialSize=6\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+OptimizeStringConcat +.br +Enables the optimization of \f3String\fR concatenation operations\&. This option is enabled by default\&. To disable the optimization of \f3String\fR concatenation operations, specify \f3-XX:-OptimizeStringConcat\fR\&. +.TP +-XX:+PrintAssembly +.br +Enables printing of assembly code for bytecoded and native methods by using the external \f3disassembler\&.so\fR library\&. This enables you to see the generated code, which may help you to diagnose performance issues\&. + +By default, this option is disabled and assembly code is not printed\&. The \f3-XX:+PrintAssembly\fR option has to be used together with the \f3-XX:UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. +.TP +-XX:+PrintCompilation +.br +Enables verbose diagnostic output from the JVM by printing a message to the console every time a method is compiled\&. This enables you to see which methods actually get compiled\&. By default, this option is disabled and diagnostic output is not printed\&. + +You can also log compilation activity to a file by using the \f3-XX:+LogCompilation\fR option\&. +.TP +-XX:+PrintInlining +.br +Enables printing of inlining decisions\&. This enables you to see which methods are getting inlined\&. + +By default, this option is disabled and inlining information is not printed\&. The \f3-XX:+PrintInlining\fR option has to be used together with the \f3-XX:+UnlockDiagnosticVMOptions\fR option that unlocks diagnostic JVM options\&. +.TP +-XX:+RelaxAccessControlCheck +.br +Decreases the amount of access control checks in the verifier\&. By default, this option is disabled, and it is ignored (that is, treated as disabled) for classes with a recent bytecode version\&. You can enable it for classes with older versions of the bytecode\&. +.TP +-XX:ReservedCodeCacheSize=\fIsize\fR +.br +Sets the maximum code cache size (in bytes) for JIT-compiled code\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. This option is equivalent to \f3-Xmaxjitcodesize\fR\&. +.TP +-XX:+TieredCompilation +.br +Enables the use of tiered compilation\&. By default, this option is disabled and tiered compilation is not used\&. +.TP +-XX:+UseCodeCacheFlushing +.br +Enables flushing of the code cache before shutting down the compiler\&. This option is enabled by default\&. To disable flushing of the code cache before shutting down the compiler, specify \f3-XX:-UseCodeCacheFlushing\fR\&. +.TP +-XX:+UseCondCardMark +.br +Enables checking of whether the card is already marked before updating the card table\&. This option is disabled by default and should only be used on machines with multiple sockets, where it will increase performance of Java applications that rely heavily on concurrent operations\&. +.TP +-XX:+UseSuperWord +.br +Enables the transformation of scalar operations into superword operations\&. This option is enabled by default\&. To disable the transformation of scalar operations into superword operations, specify \f3-XX:-UseSuperWord\fR\&. +.SS ADVANCED\ SERVICEABILITY\ OPTIONS +These options provide the ability to gather system information and perform extensive debugging\&. +.TP +-XX:+ExtendedDTraceProbes +.br +Enables additional \f3dtrace\fR tool probes that impact the performance\&. By default, this option is disabled and \f3dtrace\fR performs only standard probes\&. +.TP +-XX:+HeapDumpOnOutOfMemory +.br +Enables the dumping of the Java heap to a file in the current directory by using the heap profiler (HPROF) when a \f3java\&.lang\&.OutOfMemoryError\fR exception is thrown\&. You can explicitly set the heap dump file path and name using the \f3-XX:HeapDumpPath\fR option\&. By default, this option is disabled and the heap is not dumped when an \f3OutOfMemoryError\fR exception is thrown\&. +.TP +-XX:HeapDumpPath=\fIpath\fR +.br +Sets the path and file name for writing the heap dump provided by the heap profiler (HPROF) when the \f3-XX:+HeapDumpOnOutOfMemoryError\fR option is set\&. By default, the file is created in the current working directory, and it is named \f3java_pid\fR\fIpid\fR\f3\&.hprof\fR where \fIpid\fR is the identifier of the process that caused the error\&. The following example shows how to set the default file explicitly (\f3%p\fR represents the current process identificator): +.sp +.nf +\f3\-XX:HeapDumpPath=\&./java_pid%p\&.hprof\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fI\fRThe following example shows how to set the heap dump file to \f3/var/log/java/java_heapdump\&.hprof\fR: +.sp +.nf +\f3\-XX:HeapDumpPath=/var/log/java/java_heapdump\&.hprof\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:LogFile=\fIpath\fR +.br +Sets the path and file name where log data is written\&. By default, the file is created in the current working directory, and it is named \f3hotspot\&.log\fR\&. + +\fI\fRThe following example shows how to set the log file to \f3/var/log/java/hotspot\&.log\fR: +.sp +.nf +\f3\-XX:LogFile=/var/log/java/hotspot\&.log\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+PrintClassHistogram +.br +\fI\fREnables printing of a class instance histogram after a \f3Control+C\fR event (\f3SIGTERM\fR)\&. By default, this option is disabled\&. + +Setting this option is equivalent to running the \f3jmap -histo\fR command, or the \f3jcmd\fR\fIpid\fR\f3GC\&.class_histogram\fR command, where \fIpid\fR is the current Java process identifier\&. +.TP +-XX:+PrintConcurrentLocks + + +Enables printing of j\f3ava\&.util\&.concurrent\fR locks after a \f3Control+C\fR event (\f3SIGTERM\fR)\&. By default, this option is disabled\&. + +Setting this option is equivalent to running the \f3jstack -l\fR command or the \f3jcmd\fR\fIpid\fR\f3Thread\&.print -l\fR command, where \fIpid\fR is the current Java process identifier\&. +.TP +-XX:+UnlockDiagnosticVMOptions +.br +Unlocks the options intended for diagnosing the JVM\&. By default, this option is disabled and diagnostic options are not available\&. +.SS ADVANCED\ GARBAGE\ COLLECTION\ OPTIONS +These options control how garbage collection (GC) is performed by the Java HotSpot VM\&. +.TP +-XX:+AggressiveHeap +.br +Enables Java heap optimization\&. This sets various parameters to be optimal for long-running jobs with intensive memory allocation, based on the configuration of the computer (RAM and CPU)\&. By default, the option is disabled and the heap is not optimized\&. +.TP +-XX:AllocatePrefetchDistance=\fIsize\fR +.br +Sets the size (in bytes) of the prefetch distance for object allocation\&. Memory about to be written with the value of new objects is prefetched up to this distance starting from the address of the last allocated object\&. Each Java thread has its own allocation point\&. + +Negative values denote that prefetch distance is chosen based on the platform\&. Positive values are bytes to prefetch\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is set to -1\&. + +The following example shows how to set the prefetch distance to 1024 bytes: +.sp +.nf +\f3\-XX:AllocatePrefetchDistance=1024\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchLines=\fIlines\fR +.br +Sets the number of cache lines to load after the last object allocation by using the prefetch instructions generated in compiled code\&. The default value is 1 if the last allocated object was an instance, and 3 if it was an array\&. + +The following example shows how to set the number of loaded cache lines to 5: +.sp +.nf +\f3\-XX:AllocatePrefetchLines=5\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:AllocatePrefetchStyle=\fIstyle\fR +.br +Sets the generated code style for prefetch instructions\&. The \fIstyle\fR argument is an integer from 0 to 3: +.RS +.TP +0 +Do not generate prefetch instructions\&. +.TP +1 +Execute prefetch instructions after each allocation\&. This is the default parameter\&. +.TP +2 +Use the thread-local allocation block (TLAB) watermark pointer to determine when prefetch instructions are executed\&. +.TP +3 +Use BIS instruction on SPARC for allocation prefetch\&. +.RE + +.TP +-XX:+AlwaysPreTouch +.br +Enables touching of every page on the Java heap during JVM initialization\&. This gets all pages into the memory before entering the \f3main()\fR method\&. The option can be used in testing to simulate a long-running system with all virtual memory mapped to physical memory\&. By default, this option is disabled and all pages are committed as JVM heap space fills\&. +.TP +-XX:+CMSClassUnloadingEnabled +.br +Enables class unloading when using the concurrent mark-sweep (CMS) garbage collector\&. This option is enabled by default\&. To disable class unloading for the CMS garbage collector, specify \f3-XX:-CMSClassUnloadingEnabled\fR\&. +.TP +-XX:CMSExpAvgFactor=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) used to weight the current sample when computing exponential averages for the concurrent collection statistics\&. By default, the exponential averages factor is set to 25%\&. The following example shows how to set the factor to 15%: +.sp +.nf +\f3\-XX:CMSExpAvgFactor=15\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSIncrementalDutyCycle=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) between minor collections that the concurrent collector is allowed to run\&. When \f3-XX:+CMSIncrementalPacing\fR is enabled, the duty cycle is set automatically, and this option sets only the initial value\&. + +By default, the duty cycle is set to 10%\&. The following example shows how to set the duty cycle to 20%: +.sp +.nf +\f3\-XX:CMSIncrementalDutyCycle=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSIncrementalDutyCycleMin=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) between minor collections that is the lower bound for the duty cycle when \f3-XX:+CMSIncrementalPacing\fR is enabled\&. By default, the lower bound for the duty cycle is set to 0%\&. The following example shows how to set the lower bound to 10%: +.sp +.nf +\f3\-XX:CMSIncrementalDutyCycleMin=10\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSIncrementalMode +.br +Enables the incremental mode for the CMS collector\&. This option is disabled by default and should only be enabled for configurations with no more than two GC threads\&. All options that start with \f3CMSIncremental\fR apply only when this option is enabled\&. +.TP +-XX:CMSIncrementalOffset=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) by which the incremental mode duty cycle is shifted to the right within the period between minor collections\&. By default, the offset is set to 0%\&. The following example shows how to set the duty cycle offset to 25%: +.sp +.nf +\f3\-XX:CMSIncrementalOffset=25\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSIncrementalPacing +.br +Enables automatic adjustment of the incremental mode duty cycle based on statistics collected while the JVM is running\&. This option is enabled by default\&. To disable automatic adjustment of the incremental mode duty cycle, specify \f3-XX:-CMSIncrementalPacing\fR\&. +.TP +-XX:CMSIncrementalSafetyFactor=\fIpercent\fR +.br +Sets the percentage of time (0 to 100) used to add conservatism when computing the duty cycle\&. By default, the safety factor is set to 10%\&. The example below shows how to set the safety factor to 5%: +.sp +.nf +\f3\-XX:CMSIncrementalSafetyFactor=5\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:CMSInitiatingOccupancyFraction=\fIpercent\fR +.br +Sets the percentage of the old generation occupancy (0 to 100) at which to start a CMS collection cycle\&. The default value is set to -1\&. Any negative value (including the default) implies that \f3-XX:CMSTriggerRatio\fR is used to define the value of the initiating occupancy fraction\&. + +The following example shows how to set the occupancy fraction to 20%: +.sp +.nf +\f3\-XX:CMSInitiatingOccupancyFraction=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+CMSScavengeBeforeRemark +.br +Enables scavenging attempts before the CMS remark step\&. By default, this option is disabled\&. +.TP +-XX:CMSTriggerRatio=\fIpercent\fR +.br +Sets the percentage (0 to 100) of the value specified by \f3-XX:MinHeapFreeRatio\fR that is allocated before a CMS collection cycle commences\&. The default value is set to 80%\&. + +The following example shows how to set the occupancy fraction to 75%: +.sp +.nf +\f3\-XX:CMSTriggerRatio=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:ConcGCThreads=\fIthreads\fR +.br +Sets the number of threads used for concurrent GC\&. The default value depends on the number of CPUs available to the JVM\&. + +For example, to set the number of threads for concurrent GC to 2, specify the following option: +.sp +.nf +\f3\-XX:ConcGCThreads=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+DisableExplicitGC +.br +Enables the option that disables processing of calls to \f3System\&.gc()\fR\&. This option is disabled by default, meaning that calls to \f3System\&.gc()\fR are processed\&. If processing of calls to \f3System\&.gc()\fR is disabled, the JVM still performs GC when necessary\&. +.TP +-XX:+ExplicitGCInvokesConcurrent +.br +Enables invoking of concurrent GC by using the \f3System\&.gc()\fR request\&. This option is disabled by default and can be enabled only together with the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:+ExplicitGCInvokesConcurrentAndUnloadsClasses +.br +Enables invoking of concurrent GC by using the \f3System\&.gc()\fR request and unloading of classes during the concurrent GC cycle\&. This option is disabled by default and can be enabled only together with the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:G1HeapRegionSize=\fIsize\fR +.br +Sets the size of the regions into which the Java heap is subdivided when using the garbage-first (G1) collector\&. The value can be between 1 MB and 32 MB\&. The default region size is determined ergonomically based on the heap size\&. + +The following example shows how to set the size of the subdivisions to 16 MB: +.sp +.nf +\f3\-XX:G1HeapRegionSize=16m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+G1PrintHeapRegions +.br +Enables the printing of information about which regions are allocated and which are reclaimed by the G1 collector\&. By default, this option is disabled\&. +.TP +-XX:G1ReservePercent=\fIpercent\fR +.br +Sets the percentage of the heap (0 to 50) that is reserved as a false ceiling to reduce the possibility of promotion failure for the G1 collector\&. By default, this option is set to 10%\&. + +The following example shows how to set the reserved heap to 20%: +.sp +.nf +\f3\-XX:G1ReservePercent=20\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:InitialHeapSize=\fIsize\fR +.br +Sets the initial size (in bytes) of the memory allocation pool\&. This value must be either 0, or a multiple of 1024 and greater than 1 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the size of allocated memory to 6 MB using various units: +.sp +.nf +\f3\-XX:InitialHeapSize=6291456\fP +.fi +.nf +\f3\-XX:InitialHeapSize=6144k\fP +.fi +.nf +\f3\-XX:InitialHeapSize=6m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If you set this option to 0, then the initial size will be set as the sum of the sizes allocated for the old generation and the young generation\&. The size of the heap for the young generation can be set using the \f3-XX:NewSize\fR option\&. +.TP +-XX:InitialSurvivorRatio=\fIratio\fR +.br +Sets the initial survivor space ratio used by the throughput garbage collector (which is enabled by the \f3-XX:+UseParallelGC\fR and/or -\f3XX:+UseParallelOldGC\fR options)\&. Adaptive sizing is enabled by default with the throughput garbage collector by using the \f3-XX:+UseParallelGC\fR and \f3-XX:+UseParallelOldGC\fR options, and survivor space is resized according to the application behavior, starting with the initial value\&. If adaptive sizing is disabled (using the \f3-XX:-UseAdaptiveSizePolicy\fR option), then the \f3-XX:SurvivorRatio\fR option should be used to set the size of the survivor space for the entire execution of the application\&. + +The following formula can be used to calculate the initial size of survivor space (S) based on the size of the young generation (Y), and the initial survivor space ratio (R): +.sp +.nf +\f3S=Y/(R+2)\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The 2 in the equation denotes two survivor spaces\&. The larger the value specified as the initial survivor space ratio, the smaller the initial survivor space size\&. + +By default, the initial survivor space ratio is set to 8\&. If the default value for the young generation space size is used (2 MB), the initial size of the survivor space will be 0\&.2 MB\&. + +The following example shows how to set the initial survivor space ratio to 4: +.sp +.nf +\f3\-XX:InitialSurvivorRatio=4\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:InitiatingHeapOccupancyPercent=\fIpercent\fR +.br +Sets the percentage of the heap occupancy (0 to 100) at which to start a concurrent GC cycle\&. It is used by garbage collectors that trigger a concurrent GC cycle based on the occupancy of the entire heap, not just one of the generations (for example, the G1 garbage collector)\&. + +By default, the initiating value is set to 45%\&. A value of 0 implies nonstop GC cycles\&. The following example shows how to set the initiating heap occupancy to 75%: +.sp +.nf +\f3\-XX:InitiatingHeapOccupancyPercent=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxGCPauseMillis=\fItime\fR +.br +Sets a target for the maximum GC pause time (in milliseconds)\&. This is a soft goal, and the JVM will make its best effort to achieve it\&. By default, there is no maximum pause time value\&. + +The following example shows how to set the maximum target pause time to 500 ms: +.sp +.nf +\f3\-XX:MaxGCPauseMillis=500\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxHeapSize=\fIsize\fR +.br +Sets the maximum size (in byes) of the memory allocation pool\&. This value must be a multiple of 1024 and greater than 2 MB\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. The default value is chosen at runtime based on system configuration\&. For server deployments, \f3-XX:InitialHeapSize\fR and \f3-XX:MaxHeapSize\fR are often set to the same value\&. For more information, see Garbage Collector Ergonomics at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/vm/gc-ergonomics\&.html + +The following examples show how to set the maximum allowed size of allocated memory to 80 MB using various units: +.sp +.nf +\f3\-XX:MaxHeapSize=83886080\fP +.fi +.nf +\f3\-XX:MaxHeapSize=81920k\fP +.fi +.nf +\f3\-XX:MaxHeapSize=80m\fP +.fi +.nf +\f3\fP +.fi +.sp + + +On Oracle Solaris 7 and Oracle Solaris 8 SPARC platforms, the upper limit for this value is approximately 4,000 MB minus overhead amounts\&. On Oracle Solaris 2\&.6 and x86 platforms, the upper limit is approximately 2,000 MB minus overhead amounts\&. On Linux platforms, the upper limit is approximately 2,000 MB minus overhead amounts\&. + +The \f3-XX:MaxHeapSize\fR option is equivalent to \f3-Xmx\fR\&. +.TP +-XX:MaxHeapFreeRatio=\fIpercent\fR +.br +Sets the maximum allowed percentage of free heap space (0 to 100) after a GC event\&. If free heap space expands above this value, then the heap will be shrunk\&. By default, this value is set to 70%\&. + +The following example shows how to set the maximum free heap ratio to 75%: +.sp +.nf +\f3\-XX:MaxHeapFreeRatio=75\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxMetaspaceSize=\fIsize\fR +.br +Sets the maximum amount of native memory that can be allocated for class metadata\&. By default, the size is not limited\&. The amount of metadata for an application depends on the application itself, other running applications, and the amount of memory available on the system\&. + +The following example shows how to set the maximum class metadata size to 256 MB: +.sp +.nf +\f3\-XX:MaxMetaspaceSize=256m\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MaxNewSize=\fIsize\fR +.br +Sets the maximum size (in bytes) of the heap for the young generation (nursery)\&. The default value is set ergonomically\&. +.TP +-XX:MaxTenuringThreshold=\fIthreshold\fR +.br +Sets the maximum tenuring threshold for use in adaptive GC sizing\&. The largest value is 15\&. The default value is 15 for the parallel (throughput) collector, and 6 for the CMS collector\&. + +The following example shows how to set the maximum tenuring threshold to 10: +.sp +.nf +\f3\-XX:MaxTenuringThreshold=10\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:MetaspaceSize=\fIsize\fR +.br +Sets the size of the allocated class metadata space that will trigger a garbage collection the first time it is exceeded\&. This threshold for a garbage collection is increased or decreased depending on the amount of metadata used\&. The default size depends on the platform\&. +.TP +-XX:MinHeapFreeRatio=\fIpercent\fR +.br +Sets the minimum allowed percentage of free heap space (0 to 100) after a GC event\&. If free heap space falls below this value, then the heap will be expanded\&. By default, this value is set to 40%\&. + +The following example shows how to set the minimum free heap ratio to 25%: +.sp +.nf +\f3\-XX:MinHeapFreeRatio=25\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NewRatio=\fIratio\fR +.br +Sets the ratio between young and old generation sizes\&. By default, this option is set to 2\&. The following example shows how to set the young/old ratio to 1: +.sp +.nf +\f3\-XX:NewRatio=1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:NewSize=\fIsize\fR +.br +Sets the initial size (in bytes) of the heap for the young generation (nursery)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. + +The young generation region of the heap is used for new objects\&. GC is performed in this region more often than in other regions\&. If the size for the young generation is too low, then a large number of minor GCs will be performed\&. If the size is too high, then only full GCs will be performed, which can take a long time to complete\&. Oracle recommends that you keep the size for the young generation between a half and a quarter of the overall heap size\&. + +The following examples show how to set the initial size of young generation to 256 MB using various units: +.sp +.nf +\f3\-XX:NewSize=256m\fP +.fi +.nf +\f3\-XX:NewSize=262144k\fP +.fi +.nf +\f3\-XX:NewSize=268435456\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The \f3-XX:NewSize\fR option is equivalent to \f3-Xmn\fR\&. +.TP +-XX:ParallelGCThreads=\fIthreads\fR +.br +Sets the number of threads used for parallel garbage collection in the young and old generations\&. The default value depends on the number of CPUs available to the JVM\&. + +For example, to set the number of threads for parallel GC to 2, specify the following option: +.sp +.nf +\f3\-XX:ParallelGCThreads=2\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+ParallelRefProcEnabled +.br +Enables parallel reference processing\&. By default, this option is disabled\&. +.TP +-XX:+PrintAdaptiveSizePolicy +.br +Enables printing of information about adaptive generation sizing\&. By default, this option is disabled\&. +.TP +-XX:+PrintGC +.br +Enables printing of messages at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCApplicationConcurrentTime +.br +Enables printing of how much time elapsed since the last pause (for example, a GC pause)\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCApplicationStoppedTime +.br +Enables printing of how much time the pause (for example, a GC pause) lasted\&. By default, this option is disabled\&. +.TP +-XX+PrintGCDateStamp +.br +Enables printing of a date stamp at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCDetails +.br +Enables printing of detailed messages at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCTaskTimeStamps +.br +Enables printing of time stamps for every individual GC worker thread task\&. By default, this option is disabled\&. +.TP +-XX:+PrintGCTimeStamp +.br +Enables printing of time stamps at every GC\&. By default, this option is disabled\&. +.TP +-XX:+PrintTenuringDistribution +.br +Enables printing of tenuring age information\&. The following is an example of the output: +.sp +.nf +\f3Desired survivor size 48286924 bytes, new threshold 10 (max 10)\fP +.fi +.nf +\f3\- age 1: 28992024 bytes, 28992024 total\fP +.fi +.nf +\f3\- age 2: 1366864 bytes, 30358888 total\fP +.fi +.nf +\f3\- age 3: 1425912 bytes, 31784800 total\fP +.fi +.nf +\f3\&.\&.\&.\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Age 1 objects are the youngest survivors (they were created after the previous scavenge, survived the latest scavenge, and moved from eden to survivor space)\&. Age 2 objects have survived two scavenges (during the second scavenge they were copied from one survivor space to the next)\&. And so on\&. + +In the preceding example, 28 992 024 bytes survived one scavenge and were copied from eden to survivor space, 1 366 864 bytes are occupied by age 2 objects, etc\&. The third value in each row is the cumulative size of objects of age n or less\&. + +By default, this option is disabled\&. +.TP +-XX:+ScavengeBeforeFullGC +.br +Enables GC of the young generation before each full GC\&. This option is enabled by default\&. Oracle recommends that you \fIdo not\fR disable it, because scavenging the young generation before a full GC can reduce the number of objects reachable from the old generation space into the young generation space\&. To disable GC of the young generation before each full GC, specify \f3-XX:-ScavengeBeforeFullGC\fR\&. +.TP +-XX:SoftRefLRUPolicyMSPerMB=\fItime\fR +.br +Sets the amount of time (in milliseconds) a softly reachable object is kept active on the heap after the last time it was referenced\&. The default value is one second of lifetime per free megabyte in the heap\&. The \f3-XX:SoftRefLRUPolicyMSPerMB\fR option accepts integer values representing milliseconds per one megabyte of the current heap size (for Java HotSpot Client VM) or the maximum possible heap size (for Java HotSpot Server VM)\&. This difference means that the Client VM tends to flush soft references rather than grow the heap, whereas the Server VM tends to grow the heap rather than flush soft references\&. In the latter case, the value of the \f3-Xmx\fR option has a significant effect on how quickly soft references are garbage collected\&. + +The following example shows how to set the value to 2\&.5 seconds: +.sp +.nf +\f3\-XX:SoftRefLRUPolicyMSPerMB=2500\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:SurvivorRatio=\fIratio\fR +.br +Sets the ratio between eden space size and survivor space size\&. By default, this option is set to 8\&. The following example shows how to set the eden/survivor space ratio to 4: +.sp +.nf +\f3\-XX:SurvivorRatio=4\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:TargetSurvivorRatio=\fIpercent\fR +.br +Sets the desired percentage of survivor space (0 to 100) used after young garbage collection\&. By default, this option is set to 50%\&. + +The following example shows how to set the target survivor space ratio to 30%: +.sp +.nf +\f3\-XX:TargetSurvivorRatio=30\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:TLABSize=\fIsize\fR +.br +Sets the initial size (in bytes) of a thread-local allocation buffer (TLAB)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes, \f3m\fR or \f3M\fR to indicate megabytes, \f3g\fR or \f3G\fR to indicate gigabytes\&. If this option is set to 0, then the JVM chooses the initial size automatically\&. + +The following example shows how to set the initial TLAB size to 512 KB: +.sp +.nf +\f3\-XX:TLABSize=512k\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-XX:+UseAdaptiveSizePolicy +.br +Enables the use of adaptive generation sizing\&. This option is enabled by default\&. To disable adaptive generation sizing, specify \f3-XX:-UseAdaptiveSizePolicy\fR and set the size of the memory allocation pool explicitly (see the \f3-XX:SurvivorRatio\fR option)\&. +.TP +-XX:+UseCMSInitiatingOccupancyOnly +.br +Enables the use of the occupancy value as the only criterion for initiating the CMS collector\&. By default, this option is disabled and other criteria may be used\&. +.TP +-XX:+UseConcMarkSweepGC +.br +Enables the use of the CMS garbage collector for the old generation\&. Oracle recommends that you use the CMS garbage collector when application latency requirements cannot be met by the throughput (\f3-XX:+UseParallelGC\fR) garbage collector\&. The G1 garbage collector (\f3-XX:+UseG1GC\fR) is another alternative\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. When this option is enabled, the \f3-XX:+UseParNewGC\fR option is automatically set\&. +.TP +-XX:+UseG1GC +.br +Enables the use of the G1 garbage collector\&. It is a server-style garbage collector, targeted for multiprocessor machines with a large amount of RAM\&. It meets GC pause time goals with high probability, while maintaining good throughput\&. The G1 collector is recommended for applications requiring large heaps (sizes of around 6 GB or larger) with limited GC latency requirements (stable and predictable pause time below 0\&.5 seconds)\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. +.TP +-XX:+UseGCOverheadLimit +.br +Enables the use of a policy that limits the proportion of time spent by the JVM on GC before an \f3OutOfMemoryError\fR exception is thrown\&. This option is enabled, by default and the parallel GC will throw an \f3OutOfMemoryError\fR if more than 98% of the total time is spent on garbage collection and less than 2% of the heap is recovered\&. When the heap is small, this feature can be used to prevent applications from running for long periods of time with little or no progress\&. To disable this option, specify \f3-XX:-UseGCOverheadLimit\fR\&. +.TP +-XX:+UseNUMA +.br +Enables performance optimization of an application on a machine with nonuniform memory architecture (NUMA) by increasing the application\&'s use of lower latency memory\&. By default, this option is disabled and no optimization for NUMA is made\&. The option is only available when the parallel garbage collector is used (\f3-XX:+UseParallelGC\fR)\&. +.TP +-XX:+UseParallelGC +.br +Enables the use of the parallel scavenge garbage collector (also known as the throughput collector) to improve the performance of your application by leveraging multiple processors\&. + +By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. If it is enabled, then the \f3-XX:+UseParallelOldGC\fR option is automatically enabled, unless you explicitly disable it\&. +.TP +-XX:+UseParallelOldGC +.br +Enables the use of the parallel garbage collector for full GCs\&. By default, this option is disabled\&. Enabling it automatically enables the \f3-XX:+UseParallelGC\fR option\&. +.TP +-XX:+UseParNewGC +.br +Enables the use of parallel threads for collection in the young generation\&. By default, this option is disabled\&. It is automatically enabled when you set the \f3-XX:+UseConcMarkSweepGC\fR option\&. +.TP +-XX:+UseSerialGC +.br +Enables the use of the serial garbage collector\&. This is generally the best choice for small and simple applications that do not require any special functionality from garbage collection\&. By default, this option is disabled and the collector is chosen automatically based on the configuration of the machine and type of the JVM\&. +.TP +-XX:+UseTLAB +.br +Enables the use of thread-local allocation blocks (TLABs) in the young generation space\&. This option is enabled by default\&. To disable the use of TLABs, specify \f3-XX:-UseTLAB\fR\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +These options were included in the previous release, but have since been considered unnecessary\&. +.TP +-Xrun\fIlibname\fR +.br +Loads the specified debugging/profiling library\&. This option was superseded by the \f3-agentlib\fR option\&. +.TP +-XX:CMSInitiatingPermOccupancyFraction=\fIpercent\fR +.br +Sets the percentage of the permanent generation occupancy (0 to 100) at which to start a GC\&. This option was deprecated in JDK 8 with no replacement\&. +.TP +-XX:MaxPermSize=\fIsize\fR +.br +Sets the maximum permanent generation space size (in bytes)\&. This option was deprecated in JDK 8, and superseded by the \f3-XX:MaxMetaspaceSize\fR option\&. +.TP +-XX:PermSize=\fIsize\fR +.br +Sets the space (in bytes) allocated to the permanent generation that triggers a garbage collection if it is exceeded\&. This option was deprecated un JDK 8, and superseded by the \f3-XX:MetaspaceSize\fR option\&. +.TP +-XX:+UseSplitVerifier +.br +Enables splitting of the verification process\&. By default, this option was enabled in the previous releases, and verification was split into two phases: type referencing (performed by the compiler) and type checking (performed by the JVM runtime)\&. This option was deprecated in JDK 8, and verification is now split by default without a way to disable it\&. +.TP +-XX:+UseStringCache +.br +Enables caching of commonly allocated strings\&. This option was removed from JDK 8 with no replacement\&. +.SH PERFORMANCE\ TUNING\ EXAMPLES +The following examples show how to use experimental tuning flags to either optimize throughput or to provide lower response time\&. +.PP +\f3Example 1 Tuning for Higher Throughput\fR +.sp +.nf +\f3java \-d64 \-server \-XX:+AggressiveOpts \-XX:+UseLargePages \-Xmn10g \-Xms26g \-Xmx26g\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Tuning for Lower Response Time\fR +.sp +.nf +\f3java \-d64 \-XX:+UseG1GC \-Xms26g Xmx26g \-XX:MaxGCPauseMillis=500 \-XX:+PrintGCTimeStamp\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH EXIT\ STATUS +The following exit values are typically returned by the launcher when the launcher is called with the wrong arguments, serious errors, or exceptions thrown by the JVM\&. However, a Java application may choose to return any value by using the API call \f3System\&.exit(exitValue)\fR\&. The values are: +.TP 0.2i +\(bu +\f30\fR: Successful completion +.TP 0.2i +\(bu +\f3>0\fR: An error occurred +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +jar(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/javac.1 b/jdk/src/solaris/doc/sun/man/man1/javac.1 index 3f3b5733f0a..3cbc97614b8 100644 --- a/jdk/src/solaris/doc/sun/man/man1/javac.1 +++ b/jdk/src/solaris/doc/sun/man/man1/javac.1 @@ -1,1205 +1,1364 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javac 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javac.1 +.\" +.if n .pl 99999 +.TH javac 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javac \- Java programming language compiler -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl - \fP\f3javac\fP [ options ] [ sourcefiles ] [ classes ] [ @argfiles ] -.fl +.SH NAME +javac \- Reads Java class and interface definitions and compiles them into bytecode and class files\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi +\fBjavac\fR [ \fIoptions\fR ] [ \fIsourcefiles\fR ] [ \fIclasses\fR] [ \fI@argfiles\fR ] +.fi +.sp +Arguments can be in any order: +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIsourcefiles\fR +One or more source files to be compiled (such as \f3MyClass\&.java\fR)\&. +.TP +\fIclasses\fR +One or more classes to be processed for annotations (such as \f3MyPackage\&.MyClass\fR)\&. +.TP +\fI@argfiles\fR +One or more files that list options and source files\&. The \f3-J\fR options are not allowed in these files\&. See Command-Line Argument Files\&. +.SH DESCRIPTION +The \f3javac\fR command reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files\&. The \f3javac\fR command can also process annotations in Java source files and classes\&. +.PP +There are two ways to pass source code file names to \f3javac\fR\&. +.TP 0.2i +\(bu +For a small number of source files, list the file names on the command line\&. +.TP 0.2i +\(bu +For a large number of source files, list the file names in a file that is separated by blanks or line breaks\&. Use the list file name preceded by an at sign (@) with the \f3javac\fR command\&. +.PP +Source code file names must have \&.java suffixes, class file names must have \&.class suffixes, and both source and class files must have root names that identify the class\&. For example, a class called \f3MyClass\fR would be written in a source file called \f3MyClass\&.java\fR and compiled into a bytecode class file called \f3MyClass\&.class\fR\&. +.PP +Inner class definitions produce additional class files\&. These class files have names that combine the inner and outer class names, such as \f3MyClass$MyInnerClass\&.class\fR\&. +.PP +Arrange source files in a directory tree that reflects their package tree\&. For example, if all of your source files are in \f3/workspace\fR, then put the source code for \f3com\&.mysoft\&.mypack\&.MyClass\fR in \f3/workspace/com/mysoft/mypack/MyClass\&.java\fR\&. +.PP +By default, the compiler puts each class file in the same directory as its source file\&. You can specify a separate destination directory with the \f3-d\fR option\&. +.SH OPTIONS +The compiler has a set of standard options that are supported on the current development environment\&. An additional set of nonstandard options are specific to the current virtual machine and compiler implementations and are subject to change in the future\&. Nonstandard options begin with the \f3-X\fR option\&. +.TP 0.2i +\(bu +See also Cross-Compilation Options +.TP 0.2i +\(bu +See also Nonstandard Options +.SS STANDARD\ OPTIONS +.TP +-A\fIkey\fR[\fI=value\fR] +.br +Specifies options to pass to annotation processors\&. These options are not interpreted by \f3javac\fR directly, but are made available for use by individual processors\&. The \f3key\fR value should be one or more identifiers separated by a dot (\&.)\&. +.TP +-cp \fIpath\fR or -classpath \fIpath\fR +.br +Specifies where to find user class files, and (optionally) annotation processors and source files\&. This class path overrides the user class path in the \f3CLASSPATH\fR environment variable\&. If neither \f3CLASSPATH\fR, \f3-cp\fR nor \f3-classpath\fR is specified, then the user \fIclass path\fR is the current directory\&. See Setting the Class Path\&. -.LP -.LP -Arguments may be in any order. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -sourcefiles -One or more source files to be compiled (such as MyClass.java). -.TP 3 -classes -One or more classes to be processed for annotations (such as MyPackage.MyClass). -.TP 3 -@argfiles -One or more files that lists options and source files. The \f2\-J\fP options are not allowed in these files. -.RE +If the \f3-sourcepath\fR option is not specified, then the user class path is also searched for source files\&. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3javac\fP tool reads class and interface definitions, written in the Java programming language, and compiles them into bytecode class files. It can also process annotations in Java source files and classes. -.LP -.LP -There are two ways to pass source code file names to \f3javac\fP: -.LP -.RS 3 -.TP 2 -o -For a small number of source files, simply list the file names on the command line. -.TP 2 -o -For a large number of source files, list the file names in a file, separated by blanks or line breaks. Then use the list file name on the \f3javac\fP command line, preceded by an \f3@\fP character. -.RE +If the \f3-processorpath\fR option is not specified, then the class path is also searched for annotation processors\&. +.TP +-Djava\&.ext\&.dirs=\fIdirectories\fR +.br +Overrides the location of installed extensions\&. +.TP +-Djava\&.endorsed\&.dirs=\fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-d \fIdirectory\fR +.br +Sets the destination directory for class files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then \f3javac\fR puts the class file in a subdirectory that reflects the package name and creates directories as needed\&. -.LP -.LP -Source code file names must have \f2.java\fP suffixes, class file names must have \f2.class\fP suffixes, and both source and class files must have root names that identify the class. For example, a class called \f2MyClass\fP would be written in a source file called \f2MyClass.java\fP and compiled into a bytecode class file called \f2MyClass.class\fP. -.LP -.LP -Inner class definitions produce additional class files. These class files have names combining the inner and outer class names, such as \f2MyClass$MyInnerClass.class\fP. -.LP -.LP -You should arrange source files in a directory tree that reflects their package tree. For example, if you keep all your source files in \f3/workspace\fP, the source code for \f2com.mysoft.mypack.MyClass\fP should be in \f3/workspace/com/mysoft/mypack/MyClass.java\fP. -.LP -.LP -By default, the compiler puts each class file in the same directory as its source file. You can specify a separate destination directory with \f3\-d\fP (see Options, below). -.LP -.SH "OPTIONS" -.LP -.LP -The compiler has a set of standard options that are supported on the current development environment and will be supported in future releases. An additional set of non\-standard options are specific to the current virtual machine and compiler implementations and are subject to change in the future. Non\-standard options begin with \f3\-X\fP. -.LP -.SS -Standard Options -.LP -.RS 3 -.TP 3 -\-Akey[=value] -Options to pass to annotation processors. These are not interpreted by javac directly, but are made available for use by individual processors. \f2key\fP should be one or more identifiers separated by ".". -.TP 3 -\-cp path or \-classpath path -Specify where to find user class files, and (optionally) annotation processors and source files. This class path overrides the user class path in the \f3CLASSPATH\fP environment variable. If neither \f3CLASSPATH\fP, \f3\-cp\fP nor \f3\-classpath\fP is specified, the user class path consists of the current directory. See Setting the Class Path for more details. -.br -.br ->If the \f3\-sourcepath\fP option is not specified, the user class path is also searched for source files. -.br -.br -If the \f3\-processorpath\fP option is not specified, the class path is also searched for annotation processors. -.TP 3 -\-Djava.ext.dirs=directories -Override the location of installed extensions. -.TP 3 -\-Djava.endorsed.dirs=directories -Override the location of endorsed standards path. -.TP 3 -\-d directory -Set the destination directory for class files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, \f3javac\fP puts the class file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-d /home/myclasses\fP and the class is called \f2com.mypackage.MyClass\fP, then the class file is called \f2/home/myclasses/com/mypackage/MyClass.class\fP. -.br -.br -If \f3\-d\fP is not specified, \f3javac\fP puts each class files in the same directory as the source file from which it was generated. -.br -.br -\f3Note:\fP The directory specified by \f3\-d\fP is not automatically added to your user class path. -.TP 3 -\-deprecation -Show a description of each use or override of a deprecated member or class. Without \f3\-deprecation\fP, \f3javac\fP shows a summary of the source files that use or override deprecated members or classes. \f3\-deprecation\fP is shorthand for \f3\-Xlint:deprecation\fP. -.TP 3 -\-encoding encoding -Set the source file encoding name, such as \f2EUC\-JP and UTF\-8\fP. If \f3\-encoding\fP is not specified, the platform default converter is used. -.TP 3 -\-endorseddirs directories -Override the location of endorsed standards path. -.TP 3 -\-extdirs directories -Overrides the location of the \f2ext\fP directory. The \f2directories\fP variable is a colon\-separated list of directories. Each JAR archive in the specified directories is searched for class files. All JAR archives found are automatically part of the class path. -.br -.br -If you are cross\-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), this option specifies the directories that contain the extension classes. See Cross\-Compilation Options for more information. -.TP 3 -\-g -Generate all debugging information, including local variables. By default, only line number and source file information is generated. -.TP 3 -\-g:none -Do not generate any debugging information. -.TP 3 -\-g:{keyword list} -Generate only some kinds of debugging information, specified by a comma separated list of keywords. Valid keywords are: -.RS 3 -.TP 3 -source -Source file debugging information -.TP 3 -lines -Line number debugging information -.TP 3 -vars -Local variable debugging information -.RE -.TP 3 -\-help -Print a synopsis of standard options. -.TP 3 -\-implicit:{class,none} -Controls the generation of class files for implicitly loaded source files. To automatically generate class files, use \f3\-implicit:class\fP. To suppress class file generation, use \f3\-implicit:none\fP. If this option is not specified, the default is to automatically generate class files. In this case, the compiler will issue a warning if any such class files are generated when also doing annotation processing. The warning will not be issued if this option is set explicitly. See Searching For Types. -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.br -.br -\f3Note:\fP \f3CLASSPATH\fP, \f3\-classpath\fP, \f3\-bootclasspath\fP, and \f3\-extdirs\fP do \f2not\fP specify the classes used to run \f3javac\fP. Fiddling with the implementation of the compiler in this way is usually pointless and always risky. If you do need to do this, use the \f3\-J\fP option to pass through options to the underlying \f3java\fP launcher. -.TP 3 -\-nowarn -Disable warning messages. This has the same meaning as \f3\-Xlint:none\fP. -.TP 3 -\-proc: {none,only} -Controls whether annotation processing and/or compilation is done. \f3\-proc:none\fP means that compilation takes place without annotation processing. \f3\-proc:only\fP means that only annotation processing is done, without any subsequent compilation. -.TP 3 -\-processor class1[,class2,class3...] -Names of the annotation processors to run. This bypasses the default discovery process. -.TP 3 -\-processorpath path -Specify where to find annotation processors; if this option is not used, the class path will be searched for processors. -.TP 3 -\-s dir -Specify the directory where to place generated source files. The directory must already exist; \f3javac\fP will not create it. If a class is part of a package, the compiler puts the source file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify \f3\-s /home/mysrc\fP and the class is called \f2com.mypackage.MyClass\fP, then the source file will be placed in \f2/home/mysrc/com/mypackage/MyClass.java\fP. -.TP 3 -\-source release -Specifies the version of source code accepted. The following values for \f2release\fP are allowed: -.RS 3 -.TP 3 -1.3 -The compiler does \f2not\fP support assertions, generics, or other language features introduced after JDK 1.3. -.TP 3 -1.4 -The compiler accepts code containing assertions, which were introduced in JDK 1.4. -.TP 3 -1.5 -The compiler accepts code containing generics and other language features introduced in JDK 5. -.TP 3 -5 -Synonym for 1.5. -.TP 3 -1.6 -This is the default value. No language changes were introduced in Java SE 6. However, encoding errors in source files are now reported as errors, instead of warnings, as previously. -.TP 3 -6 -Synonym for 1.6. -.TP 3 -1.7 -The compiler accepts code with features introduced in JDK 7. -.TP 3 -7 -Synonym for 1.7. -.RE -.TP 3 -\-sourcepath sourcepath -Specify the source code path to search for class or interface definitions. As with the user class path, source path entries are separated by colons (\f3:\fP) and can be directories, JAR archives, or ZIP archives. If packages are used, the local path name within the directory or archive must reflect the package name. -.br -.br -\f3Note:\fP Classes found through the class path may be subject to automatic recompilation if their sources are also found. See Searching For Types. -.TP 3 -\-verbose -Verbose output. This includes information about each class loaded and each source file compiled. -.TP 3 -\-version -Print version information. -.TP 3 -\-Werror -Terminate compilation if warnings occur. -.TP 3 -\-X -Display information about non\-standard options and exit. -.RE +If you specify \f3-d\fR\f3/home/myclasses\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the class file is \f3/home/myclasses/com/mypackage/MyClass\&.class\fR\&. -.LP -.SS -Cross\-Compilation Options -.LP -.LP -By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fP shipped with. But \f3javac\fP also supports \f2cross\-compiling\fP, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation. It is important to use \f3\-bootclasspath\fP and \f3\-extdirs\fP when cross\-compiling; see Cross\-Compilation Example below. -.LP -.RS 3 -.TP 3 -\-target version -Generate class files that target a specified version of the VM. Class files will run on the specified target and on later versions, but not on earlier versions of the VM. Valid targets are \f31.1\fP \f31.2\fP \f31.3\fP \f31.4\fP \f31.5\fP (also \f35\fP) \f31.6\fP (also \f36\fP) and \f31.7\fP (also \f37\fP). -.br -.br -The default for \f3\-target\fP depends on the value of \f3\-source\fP: -.RS 3 -.TP 2 -o -If \-source is \f3not specified\fP, the value of \-target is \f31.7\fP -.TP 2 -o -If \-source is \f31.2\fP, the value of \-target is \f31.4\fP -.TP 2 -o -If \-source is \f31.3\fP, the value of \-target is \f31.4\fP -.TP 2 -o -For \f3all other values\fP of \-source, the value of \f3\-target\fP is the value of \f3\-source\fP. -.RE -.TP 3 -\-bootclasspath bootclasspath -Cross\-compile against the specified set of boot classes. As with the user class path, boot class path entries are separated by colons (\f3:\fP) and can be directories, JAR archives, or ZIP archives. -.RE +If the \fI-d\fR option is not specified, then \f3javac\fR puts each class file in the same directory as the source file from which it was generated\&. -.LP -.SS -Non\-Standard Options -.LP -.RS 3 -.TP 3 -\-Xbootclasspath/p:path -Prepend to the bootstrap class path. -.TP 3 -\-Xbootclasspath/a:path -Append to the bootstrap class path. -.TP 3 -\-Xbootclasspath/:path -Override location of bootstrap class files. -.TP 3 -\-Xlint -Enable all recommended warnings. In this release, enabling all available warnings is recommended. -.TP 3 -\-Xlint:all -Enable all recommended warnings. In this release, enabling all available warnings is recommended. -.TP 3 -\-Xlint:none -Disable all warnings. -.TP 3 -\-Xlint:name -Enable warning \f2name\fP. See the section Warnings That Can Be Enabled or Disabled with \-Xlint Option for a list of warnings you can enable with this option. -.TP 3 -\-Xlint:\-name -Disable warning \f2name\fP. See the section Warnings That Can Be Enabled or Disabled with \-Xlint Option for a list of warnings you can disable with this option. -.TP 3 -\-Xmaxerrs number -Set the maximum number of errors to print. -.TP 3 -\-Xmaxwarns number -Set the maximum number of warnings to print. -.TP 3 -\-Xstdout filename -Send compiler messages to the named file. By default, compiler messages go to \f2System.err\fP. -.TP 3 -\-Xprefer:{newer,source} -Specify which file to read when both a source file and class file are found for a type. (See Searching For Types). If \f2\-Xprefer:newer\fP is used, it reads the newer of the source or class file for a type (default). If the \f2\-Xprefer:source\fP option is used, it reads source file. Use \f2\-Xprefer:source\fP when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f2SOURCE\fP. -.TP 3 -\-Xpkginfo:{always,legacy,nonempty} -Specify handling of package\-info files -.TP 3 -\-Xprint -Print out textual representation of specified types for debugging purposes; perform neither annotation processing nor compilation. The format of the output may change. -.TP 3 -\-XprintProcessorInfo -Print information about which annotations a processor is asked to process. -.TP 3 -\-XprintRounds -Print information about initial and subsequent annotation processing rounds. -.RE +\fINote:\fR The directory specified by the \fI-d\fR option is not automatically added to your user class path\&. +.TP +-deprecation +.br +Shows a description of each use or override of a deprecated member or class\&. Without the \f3-deprecation\fR option, \f3javac\fR shows a summary of the source files that use or override deprecated members or classes\&. The \f3-deprecation\fR option is shorthand for \f3-Xlint:deprecation\fR\&. +.TP +-encoding \fIencoding\fR +.br +Sets the source file encoding name, such as EUC-JP and UTF-8\&. If the \f3-encoding\fR option is not specified, then the platform default converter is used\&. +.TP +-endorseddirs \fIdirectories\fR +.br +Overrides the location of the endorsed standards path\&. +.TP +-extdirs \fIdirectories\fR +.br +Overrides the location of the \f3ext\fR directory\&. The directories variable is a colon-separated list of directories\&. Each JAR file in the specified directories is searched for class files\&. All JAR files found become part of the class path\&. -.LP -.SS -Warnings That Can Be Enabled or Disabled with \-Xlint Option -.LP -.LP -Enable warning \f2name\fP with the option \f3\-Xlint:\fP\f2name\fP, where \f2name\fP is one of the following warning names. Similarly, you can disable warning \f2name\fP with the option \f3\-Xlint:\-\fP\f2name\fP: -.LP -.RS 3 -.TP 3 -cast -Warn about unnecessary and redundant casts. For example: -.nf -\f3 -.fl -String s = (String)"Hello!" -.fl -\fP -.fi -.TP 3 -classfile -Warn about issues related to classfile contents. -.TP 3 -deprecation -Warn about use of deprecated items. For example: -.nf -\f3 -.fl - java.util.Date myDate = new java.util.Date(); -.fl - int currentDay = myDate.getDay(); -.fl -\fP -.fi -The method \f2java.util.Date.getDay\fP has been deprecated since JDK 1.1. -.TP 3 -dep\-ann -Warn about items that are documented with an \f2@deprecated\fP Javadoc comment, but do not have a \f2@Deprecated\fP annotation. For example: -.nf -\f3 -.fl - /** -.fl - * @deprecated As of Java SE 7, replaced by {@link #newMethod()} -.fl - */ -.fl +If you are cross-compiling (compiling classes against bootstrap and extension classes of a different Java platform implementation), then this option specifies the directories that contain the extension classes\&. See Cross-Compilation Options for more information\&. +.TP +-g +.br +Generates all debugging information, including local variables\&. By default, only line number and source file information is generated\&. +.TP +-g:none +.br +Does not generate any debugging information\&. +.TP +-g:[\fIkeyword list\fR] +.br +Generates only some kinds of debugging information, specified by a comma separated list of keywords\&. Valid keywords are: +.RS +.TP +source +Source file debugging information\&. +.TP +lines +Line number debugging information\&. +.TP +vars +Local variable debugging information\&. +.RE -.fl - public static void deprecatedMethood() { } -.fl +.TP +-help +.br +Prints a synopsis of standard options\&. +.TP +-implicit:[\fIclass, none\fR] +.br +Controls the generation of class files for implicitly loaded source files\&. To automatically generate class files, use \f3-implicit:class\fR\&. To suppress class file generation, use \f3-implicit:none\fR\&. If this option is not specified, then the default is to automatically generate class files\&. In this case, the compiler issues a warning if any such class files are generated when also doing annotation processing\&. The warning is not issued when the \f3-implicit\fR option is set explicitly\&. See Searching for Types\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. -.fl - public static void newMethod() { } -.fl -\fP -.fi -.TP 3 -divzero -Warn about division by constant integer 0. For example: -.nf -\f3 -.fl - int divideByZero = 42 / 0; -.fl -\fP -.fi -.TP 3 -empty -Warn about empty statements after \f2if\fP statements. For example: -.nf -\f3 -.fl -class E { -.fl - void m() { -.fl - if (true) ; -.fl - } -.fl -} -.fl -\fP -.fi -.TP 3 -fallthrough -Check \f2switch\fP blocks for fall\-through cases and provide a warning message for any that are found. Fall\-through cases are cases in a \f2switch\fP block, other than the last case in the block, whose code does not include a \f2break\fP statement, allowing code execution to "fall through" from that case to the next case. For example, the code following the \f2case 1\fP label in this \f2switch\fP block does not end with a \f2break\fP statement: -.nf -\f3 -.fl -switch (x) { -.fl -case 1: -.fl - System.out.println("1"); -.fl - // No break statement here. -.fl -case 2: -.fl - System.out.println("2"); -.fl -} -.fl -\fP -.fi -If the \f2\-Xlint:fallthrough\fP flag were used when compiling this code, the compiler would emit a warning about "possible fall\-through into case," along with the line number of the case in question. -.TP 3 -finally -Warn about \f2finally\fP clauses that cannot complete normally. For example: -.nf -\f3 -.fl - public static int m() { -.fl - try { -.fl - throw new NullPointerException(); -.fl - } catch (NullPointerException e) { -.fl - System.err.println("Caught NullPointerException."); -.fl - return 1; -.fl - } finally { -.fl - return 0; -.fl - } -.fl - } -.fl -\fP -.fi -The compiler generates a warning for \f2finally\fP block in this example. When this method is called, it returns a value of \f20\fP, not \f21\fP. A \f2finally\fP block always executes when the \f2try\fP block exits. In this example, if control is transferred to the \f2catch\fP, then the method exits. However, the \f2finally\fP block must be executed, so it is executed, even though control has already been transferred outside the method. -.TP 3 -options -Warn about issues relating to the use of command line options. See Cross\-Compilation Example for an example of this kind of warning. -.TP 3 -overrides -Warn about issues regarding method overrides. For example, consider the following two classes: -.nf -\f3 -.fl -public class ClassWithVarargsMethod { -.fl - void varargsMethod(String... s) { } -.fl -} -.fl -\fP -.fi -.nf -\f3 -.fl -public class ClassWithOverridingMethod extends ClassWithVarargsMethod { -.fl - @Override -.fl - void varargsMethod(String[] s) { } -.fl -} -.fl -\fP -.fi -The compiler generates a warning similar to the following: +\fINote:\fR The \fICLASSPATH\fR, \f3-classpath\fR, \f3-bootclasspath\fR, and \f3-extdirs\fR options do not specify the classes used to run \f3javac\fR\&. Trying to customize the compiler implementation with these options and variables is risky and often does not accomplish what you want\&. If you must customize the complier implementation, then use the \f3-J\fR option to pass options through to the underlying \f3\fRJava launcher\&. +.TP +-nowarn .br +Disables warning messages\&. This option operates the same as the \f3-Xlint:none\fR option\&. +.TP +-parameters .br -\f2warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod overrides varargsMethod(String...) in ClassWithVarargsMethod; overriding method is missing '...'\fP +Stores formal parameter names of constructors and methods in the generated class file so that the method \f3java\&.lang\&.reflect\&.Executable\&.getParameters\fR from the Reflection API can retrieve them\&. +.TP +-proc: [\fInone\fR, \fIonly\fR] .br +Controls whether annotation processing and compilation are done\&. \f3-proc:none\fR means that compilation takes place without annotation processing\&. \f3-proc:only\fR means that only annotation processing is done, without any subsequent compilation\&. +.TP +-processor \fIclass1\fR [,\fIclass2\fR,\fIclass3\fR\&.\&.\&.] .br -When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. In the method \f2ClassWithVarargsMethod.varargsMethod\fP, the compiler translates the varargs formal parameter \f2String... s\fP to the formal parameter \f2String[] s\fP, an array, which matches the formal parameter of the method \f2ClassWithOverridingMethod.varargsMethod\fP. Consequently, this example compiles. -.TP 3 -path -Warn about invalid path elements and nonexistent path directories on the command line (with regards to the class path, the source path, and other paths). Such warnings cannot be suppressed with the \f2@SuppressWarnings\fP annotation. For example: -.nf -\f3 -.fl -javac \-Xlint:path \-classpath /nonexistentpath Example.java -.fl -\fP -.fi -.TP 3 -processing -Warn about issues regarding annotation processing. The compiler generates this warning if you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception. For example, the following is a simple annotation processor: +Names of the annotation processors to run\&. This bypasses the default discovery process\&. +.TP +-processorpath \fIpath\fR .br +Specifies where to find annotation processors\&. If this option is not used, then the class path is searched for processors\&. +.TP +-s \fIdir\fR .br -\f3Source file \fP\f4AnnoProc.java\fP: -.nf -\f3 -.fl -import java.util.*; -.fl -import javax.annotation.processing.*; -.fl -import javax.lang.model.*; -.fl -import javax.lang.model.element.*; -.fl +Specifies the directory where to place the generated source files\&. The directory must already exist because \f3javac\fR does not create it\&. If a class is part of a package, then the compiler puts the source file in a subdirectory that reflects the package name and creates directories as needed\&. -.fl -@SupportedAnnotationTypes("NotAnno") -.fl -public class AnnoProc extends AbstractProcessor { -.fl - public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv) { -.fl - return true; -.fl - } -.fl - -.fl - public SourceVersion getSupportedSourceVersion() { -.fl - return SourceVersion.latest(); -.fl - } -.fl -} -.fl -\fP -.fi -\f3Source file \fP\f4AnnosWithoutProcessors.java\fP\f3:\fP -.nf -\f3 -.fl -@interface Anno { } -.fl - -.fl -@Anno -.fl -class AnnosWithoutProcessors { } -.fl -\fP -.fi -The following commands compile the annotation processor \f2AnnoProc\fP, then run this annotation processor against the source file \f2AnnosWithoutProcessors.java\fP: -.nf -\f3 -.fl -% javac AnnoProc.java -.fl -% javac \-cp . \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors.java -.fl -\fP -.fi -When the compiler runs the annotation processor against the source file \f2AnnosWithoutProcessors.java\fP, it generates the following warning: +If you specify \f3-s /home/mysrc\fR and the class is called \f3com\&.mypackage\&.MyClass\fR, then the source file is put in \f3/home/mysrc/com/mypackage/MyClass\&.java\fR\&. +.TP +-source \fIrelease\fR .br -.br -\f2warning: [processing] No processor claimed any of these annotations: Anno\fP -.br -.br -To resolve this issue, you can rename the annotation defined and used in the class \f2AnnosWithoutProcessors\fP from \f2Anno\fP to \f2NotAnno\fP. -.TP 3 -rawtypes -Warn about unchecked operations on raw types. The following statement generates a \f2rawtypes\fP warning: -.nf -\f3 -.fl -void countElements(List l) { ... } -.fl -\fP -.fi -The following does not generate a \f2rawtypes\fP warning: -.nf -\f3 -.fl -void countElements(List<?> l) { ... } -.fl -\fP -.fi -\f2List\fP is a raw type. However, \f2List<?>\fP is a unbounded wildcard parameterized type. Because \f2List\fP is a parameterized interface, you should always specify its type argument. In this example, the \f2List\fP formal argument is specified with a unbounded wildcard (\f2?\fP) as its formal type parameter, which means that the \f2countElements\fP method can accept any instantiation of the \f2List\fP interface. -.TP 3 -serial -Warn about missing \f2serialVersionUID\fP definitions on serializable classes. For example: -.nf -\f3 -.fl -public class PersistentTime implements Serializable -.fl -{ -.fl - private Date time; -.fl +Specifies the version of source code accepted\&. The following values for \f3release\fR are allowed: +.RS +.TP +1\&.3 +The compiler does not support assertions, generics, or other language features introduced after Java SE 1\&.3\&. +.TP +1\&.4 +The compiler accepts code containing assertions, which were introduced in Java SE 1\&.4\&. +.TP +1\&.5 +The compiler accepts code containing generics and other language features introduced in Java SE 5\&. +.TP +5 +Synonym for 1\&.5\&. +.TP +1\&.6 +No language changes were introduced in Java SE 6\&. However, encoding errors in source files are now reported as errors instead of warnings as in earlier releases of Java Platform, Standard Edition\&. +.TP +6 +Synonym for 1\&.6\&. +.TP +1\&.7 +This is the default value\&. The compiler accepts code with features introduced in Java SE 7\&. +.TP +7 +Synonym for 1\&.7\&. +.RE + +.TP +-sourcepath \fIsourcepath\fR +.br +Specifies the source code path to search for class or interface definitions\&. As with the user class path, source path entries are separated by colons (:) on Oracle Solaris and semicolons on Windows and can be directories, JAR archives, or ZIP archives\&. If packages are used, then the local path name within the directory or archive must reflect the package name\&. + +\fINote:\fR Classes found through the class path might be recompiled when their source files are also found\&. See Searching for Types\&. +.TP +-verbose +.br +Uses verbose output, which includes information about each class loaded and each source file compiled\&. +.TP +-version +.br +Prints release information\&. +.TP +-werror +.br +Terminates compilation when warnings occur\&. +.TP +-X +.br +Displays information about nonstandard options and exits\&. +.SS CROSS-COMPILATION\ OPTIONS +By default, classes are compiled against the bootstrap and extension classes of the platform that \f3javac\fR shipped with\&. But \f3javac\fR also supports cross-compiling, where classes are compiled against a bootstrap and extension classes of a different Java platform implementation\&. It is important to use the \f3-bootclasspath\fR and \f3-extdirs\fR options when cross-compiling\&. +.TP +-target \fIversion\fR +.br +Generates class files that target a specified release of the virtual machine\&. Class files will run on the specified target and on later releases, but not on earlier releases of the JVM\&. Valid targets are 1\&.1, 1\&.2, 1\&.3, 1\&.4, 1\&.5 (also 5), 1\&.6 (also 6), and 1\&.7 (also 7)\&. + +The default for the \f3-target\fR option depends on the value of the \f3-source\fR option: +.RS +.TP 0.2i +\(bu +If the \f3-source\fR option is not specified, then the value of the \f3-target\fR option is 1\&.7 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.2, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.3, then the value of the \f3-target\fR option is 1\&.4 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.5, then the value of the \f3-target\fR option is 1\&.7 +.TP 0.2i +\(bu +If the \f3-source\fR option is 1\&.6, then the value of the \f3-target\fR is option 1\&.7 +.TP 0.2i +\(bu +For all other values of the \f3-source\fR option, the value of the \f3-target\fR option is the value of the \f3-source\fR option\&. +.RE + +.TP +-bootclasspath \fIbootclasspath\fR +.br +Cross-compiles against the specified set of boot classes\&. As with the user class path, boot class path entries are separated by colons (:) and can be directories, JAR archives, or ZIP archives\&. +.SS COMPACT\ PROFILE\ OPTION +Beginning with JDK 8, the \f3javac\fR compiler supports compact profiles\&. With compact profiles, applications that do not require the entire Java platform can be deployed and run with a smaller footprint\&. The compact profiles feature could be used to shorten the download time for applications from app stores\&. This feature makes for more compact deployment of Java applications that bundle the JRE\&. This feature is also useful in small devices\&. +.PP +The supported profile values are \f3compact1\fR, \f3compact2\fR, and \f3compact3\fR\&. These are additive layers\&. Each higher-numbered compact profile contains all of the APIs in profiles with smaller number names\&. +.TP +-profile +.br +When using compact profiles, this option specifies the profile name when compiling\&. For example: +.sp +.nf +\f3javac \-profile compact1 Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +javac does not compile source code that uses any Java SE APIs that is not in the specified profile\&. Here is an example of the error message that results from attempting to compile such source code: +.sp +.nf +\f3cd jdk1\&.8\&.0/bin\fP +.fi +.nf +\f3\&./javac \-profile compact1 Paint\&.java\fP +.fi +.nf +\f3Paint\&.java:5: error: Applet is not available in profile \&'compact1\&'\fP +.fi +.nf +\f3import java\&.applet\&.Applet;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +In this example, you can correct the error by modifying the source to not use the \f3Applet\fR class\&. You could also correct the error by compiling without the -profile option\&. Then the compilation would be run against the full set of Java SE APIs\&. (None of the compact profiles include the \f3Applet\fR class\&.) + +An alternative way to compile with compact profiles is to use the \f3-bootclasspath\fR option to specify a path to an \f3rt\&.jar\fR file that specifies a profile\&'s image\&. Using the \f3-profile\fR option instead does not require a profile image to be present on the system at compile time\&. This is useful when cross-compiling\&. +.SS NONSTANDARD\ OPTIONS +.TP +-Xbootclasspath/p:\fIpath\fR +.br +Adds a suffix to the bootstrap class path\&. +.TP +-Xbootclasspath/a:\fIpath\fR +.br +Adds a prefix to the bootstrap class path\&. +.TP +-Xbootclasspath/:\fIpath\fR +.br +Overrides the location of the bootstrap class files\&. +.TP +-Xdoclint:[-]\fIgroup\fR [\fI/access\fR] +.br +Enables or disables specific groups of checks, where \fIgroup\fR is one of the following values: \f3accessibility\fR, \f3syntax\fR, \f3reference\fR, \f3html\fR or \f3missing\fR\&. For more information about these groups of checks see the \f3-Xdoclint\fR option of the \f3javadoc\fR command\&. The \f3-Xdoclint\fR option is disabled by default in the \f3javac\fR command\&. + +The variable \fIaccess\fR specifies the minimum visibility level of classes and members that the \f3-Xdoclint\fR option checks\&. It can have one of the following values (in order of most to least visible) : \f3public\fR, \f3protected\fR, \f3package\fR and \f3private\fR\&. For example, the following option checks classes and members (with all groups of checks) that have the access level protected and higher (which includes protected, package and public): +.sp +.nf +\f3\-Xdoclint:all/protected\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following option enables all groups of checks for all access levels, except it will not check for HTML errors for classes and members that have access level package and higher (which includes package and public): +.sp +.nf +\f3\-Xdoclint:all,\-html/package\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-Xdoclint:none +.br +Disables all groups of checks\&. +.TP +-Xdoclint:all[\fI/access\fR] +.br +Enables all groups of checks\&. +.TP +-Xlint +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:all +.br +\fI\fREnables all recommended warnings\&. In this release, enabling all available warnings is recommended\&. +.TP +-Xlint:none +.br +Disables all warnings\&. +.TP +-Xlint:\fIname\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option for a list of warnings you can disable with this option\&. +.TP +-Xlint:\fI-name\fR +.br +Disables warning name\&. See Enable or Disable Warnings with the -Xlint Option with the \f3-Xlint\fR option to get a list of warnings that you can disable with this option\&. +.TP +-Xmaxerrs \fInumber\fR +.br +Sets the maximum number of errors to print\&. +.TP +-Xmaxwarns \fInumber\fR +.br +Sets the maximum number of warnings to print\&. +.TP +-Xstdout \fIfilename\fR +.br +Sends compiler messages to the named file\&. By default, compiler messages go to \f3System\&.err\fR\&. +.TP +-Xprefer:[\fInewer,source\fR] +.br +Specifies which file to read when both a source file and class file are found for a type\&. (See Searching for Types)\&. If the \f3-Xprefer:newer\fR option is used, then it reads the newer of the source or class file for a type (default)\&. If the \f3-Xprefer:source\fR option is used, then it reads the source file\&. Use -\f3Xprefer:source\fR when you want to be sure that any annotation processors can access annotations declared with a retention policy of \f3SOURCE\fR\&. +.TP +-Xpkginfo:[\fIalways\fR,\fIlegacy\fR,\fInonempty\fR] +.br +Control whether javac generates \f3package-info\&.class\fR files from package-info\&.java files\&. Possible mode arguments for this option include the following\&. +.RS +.TP +always +Always generate a \f3package-info\&.class\fR file for every \f3package-info\&.java\fR file\&. This option may be useful if you use a build system such as Ant, which checks that each \f3\&.java\fR file has a corresponding \f3\&.class\fR file\&. +.TP +legacy +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations\&. Don\&'t generate a \f3package-info\&.class\fR file if package-info\&.java only contains comments\&. + +\fINote:\fR A \f3package-info\&.class\fR file might be generated but be empty if all the annotations in the package-info\&.java file have \f3RetentionPolicy\&.SOURCE\fR\&. +.TP +nonempty +Generate a \f3package-info\&.class\fR file only if package-info\&.java contains annotations with \f3RetentionPolicy\&.CLASS\fR or \f3RetentionPolicy\&.RUNTIME\fR\&. +.RE + +.TP +-Xprint +.br +Prints a textual representation of specified types for debugging purposes\&. Perform neither annotation processing nor compilation\&. The format of the output could change\&. +.TP +-XprintProcessorInfo +.br +Prints information about which annotations a processor is asked to process\&. +.TP +-XprintRounds +.br +Prints information about initial and subsequent annotation processing rounds\&. +.SH ENABLE\ OR\ DISABLE\ WARNINGS\ WITH\ THE\ -XLINT\ OPTION +Enable warning \fIname\fR with the \f3-Xlint:name\fR option, where \f3name\fR is one of the following warning names\&. Note that you can disable a warning with the \f3-Xlint:-name:\fR option\&. +.TP +cast +Warns about unnecessary and redundant casts, for example: +.sp +.nf +\f3String s = (String) "Hello!"\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +classfile +Warns about issues related to class file contents\&. +.TP +deprecation +Warns about the use of deprecated items, for example: +.sp +.nf +\f3java\&.util\&.Date myDate = new java\&.util\&.Date();\fP +.fi +.nf +\f3int currentDay = myDate\&.getDay();\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The method \f3java\&.util\&.Date\&.getDay\fR has been deprecated since JDK 1\&.1 +.TP +dep-ann +Warns about items that are documented with an \f3@deprecated\fR Javadoc comment, but do not have a \f3@Deprecated\fR annotation, for example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of Java SE 7, replaced by {@link #newMethod()}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static void deprecatedMethood() { }\fP +.fi +.nf +\f3public static void newMethod() { }\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +divzero +Warns about division by the constant integer 0, for example: +.sp +.nf +\f3int divideByZero = 42 / 0;\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +empty +Warns about empty statements after \f3if\fRstatements, for example: +.sp +.nf +\f3class E {\fP +.fi +.nf +\f3 void m() {\fP +.fi +.nf +\f3 if (true) ;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +fallthrough +Checks the switch blocks for fall-through cases and provides a warning message for any that are found\&. Fall-through cases are cases in a switch block, other than the last case in the block, whose code does not include a break statement, allowing code execution to fall through from that case to the next case\&. For example, the code following the case 1 label in this switch block does not end with a break statement: +.sp +.nf +\f3switch (x) {\fP +.fi +.nf +\f3case 1:\fP +.fi +.nf +\f3 System\&.out\&.println("1");\fP +.fi +.nf +\f3 // No break statement here\&.\fP +.fi +.nf +\f3case 2:\fP +.fi +.nf +\f3 System\&.out\&.println("2");\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If the \f3-Xlint:fallthrough\fR option was used when compiling this code, then the compiler emits a warning about possible fall-through into case, with the line number of the case in question\&. +.TP +finally +Warns about \f3finally\fR clauses that cannot complete normally, for example: +.sp +.nf +\f3public static int m() {\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3 throw new NullPointerException();\fP +.fi +.nf +\f3 } catch (NullPointerException(); {\fP +.fi +.nf +\f3 System\&.err\&.println("Caught NullPointerException\&.");\fP +.fi +.nf +\f3 return 1;\fP +.fi +.nf +\f3 } finally {\fP +.fi +.nf +\f3 return 0;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning for the \f3finally\fR block in this example\&. When the \f3int\fR method is called, it returns a value of 0\&. A \f3finally\fR block executes when the \f3try\fR block exits\&. In this example, when control is transferred to the \f3catch\fR block, the \f3int\fR method exits\&. However, the \f3finally\fR block must execute, so it is executed, even though control was transferred outside the method\&. +.TP +options +Warns about issues that related to the use of command-line options\&. See Cross-Compilation Options\&. +.TP +overrides +Warns about issues regarding method overrides\&. For example, consider the following two classes: +.sp +.nf +\f3public class ClassWithVarargsMethod {\fP +.fi +.nf +\f3 void varargsMethod(String\&.\&.\&. s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class ClassWithOverridingMethod extends ClassWithVarargsMethod {\fP +.fi +.nf +\f3 @Override\fP +.fi +.nf +\f3 void varargsMethod(String[] s) { }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The compiler generates a warning similar to the following:\&. +.sp +.nf +\f3warning: [override] varargsMethod(String[]) in ClassWithOverridingMethod \fP +.fi +.nf +\f3overrides varargsMethod(String\&.\&.\&.) in ClassWithVarargsMethod; overriding\fP +.fi +.nf +\f3method is missing \&'\&.\&.\&.\&'\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler encounters a \f3varargs\fR method, it translates the \f3varargs\fR formal parameter into an array\&. In the method \f3ClassWithVarargsMethod\&.varargsMethod\fR, the compiler translates the \f3varargs\fR formal parameter \f3String\&.\&.\&. s\fR to the formal parameter \f3String[] s\fR, an array, which matches the formal parameter of the method \f3ClassWithOverridingMethod\&.varargsMethod\fR\&. Consequently, this example compiles\&. +.TP +path +Warns about invalid path elements and nonexistent path directories on the command line (with regard to the class path, the source path, and other paths)\&. Such warnings cannot be suppressed with the \f3@SuppressWarnings\fR annotation, for example: +.sp +.nf +\f3javac \-Xlint:path \-classpath /nonexistentpath Example\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +processing +Warn about issues regarding annotation processing\&. The compiler generates this warning when you have a class that has an annotation, and you use an annotation processor that cannot handle that type of exception\&. For example, the following is a simple annotation processor: + +\fISource file AnnocProc\&.java\fR: +.sp +.nf +\f3import java\&.util\&.*;\fP +.fi +.nf +\f3import javax\&.annotation\&.processing\&.*;\fP +.fi +.nf +\f3import javax\&.lang\&.model\&.*;\fP +.fi +.nf +\f3import\&.javaz\&.lang\&.model\&.element\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@SupportedAnnotationTypes("NotAnno")\fP +.fi +.nf +\f3public class AnnoProc extends AbstractProcessor {\fP +.fi +.nf +\f3 public boolean process(Set<? extends TypeElement> elems, RoundEnvironment renv){\fP +.fi +.nf +\f3 return true;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public SourceVersion getSupportedSourceVersion() {\fP +.fi +.nf +\f3 return SourceVersion\&.latest();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fISource file AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3@interface Anno { }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3@Anno\fP +.fi +.nf +\f3class AnnosWithoutProcessors { }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following commands compile the annotation processor \f3AnnoProc\fR, then run this annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR: +.sp +.nf +\f3javac AnnoProc\&.java\fP +.fi +.nf +\f3javac \-cp \&. \-Xlint:processing \-processor AnnoProc \-proc:only AnnosWithoutProcessors\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp + + +When the compiler runs the annotation processor against the source file \f3AnnosWithoutProcessors\&.java\fR, it generates the following warning: +.sp +.nf +\f3warning: [processing] No processor claimed any of these annotations: Anno\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To resolve this issue, you can rename the annotation defined and used in the class \f3AnnosWithoutProcessors\fR from \f3Anno\fR to \f3NotAnno\fR\&. +.TP +rawtypes +Warns about unchecked operations on raw types\&. The following statement generates a \f3rawtypes\fR warning: +.sp +.nf +\f3void countElements(List l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following example does not generate a \f3rawtypes\fR warning +.sp +.nf +\f3void countElements(List<?> l) { \&.\&.\&. }\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\f3List\fR is a raw type\&. However, \f3List<?>\fR is an unbounded wildcard parameterized type\&. Because \f3List\fR is a parameterized interface, always specify its type argument\&. In this example, the \f3List\fR formal argument is specified with an unbounded wildcard (\f3?\fR) as its formal type parameter, which means that the \f3countElements\fR method can accept any instantiation of the \f3List\fR interface\&. +.TP +Serial +Warns about missing \f3serialVersionUID\fR definitions on serializable classes, for example: +.sp +.nf +\f3public class PersistentTime implements Serializable\fP +.fi +.nf +\f3{\fP +.fi +.nf +\f3 private Date time;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public PersistentTime() {\fP +.fi +.nf +\f3 time = Calendar\&.getInstance()\&.getTime();\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public Date getTime() {\fP +.fi +.nf +\f3 return time;\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - public PersistentTime() { -.fl - time = Calendar.getInstance().getTime(); -.fl - } -.fl -.fl - public Date getTime() { -.fl - return time; -.fl - } -.fl -} -.fl -\fP -.fi The compiler generates the following warning: -.br -.br -\f2warning: [serial] serializable class PersistentTime has no definition of serialVersionUID\fP -.br -.br -If a serializable class does not explicitly declare a field named \f2serialVersionUID\fP, then the serialization runtime will calculate a default \f2serialVersionUID\fP value for that class based on various aspects of the class, as described in the Java Object Serialization Specification. However, it is strongly recommended that all serializable classes explicitly declare \f2serialVersionUID\fP values because the default process of computing \f2serialVersionUID\fP vales is highly sensitive to class details that may vary depending on compiler implementations, and can thus result in unexpected \f2InvalidClassExceptions\fP during deserialization. Therefore, to guarantee a consistent \f2serialVersionUID\fP value across different Java compiler implementations, a serializable class must declare an explicit \f2serialVersionUID\fP value. -.TP 3 -static -Warn about issues relating to use of statics. For example: -.nf -\f3 -.fl -class XLintStatic { -.fl - static void m1() { } -.fl - void m2() { this.m1(); } -.fl -} -.fl -\fP -.fi -The compiler generates the following warning: -.nf -\f3 -.fl -warning: [static] static method should be qualified by type name, XLintStatic, instead of by an expression -.fl -\fP -.fi -To resolve this issue, you can call the static method \f2m1\fP as follows: -.nf -\f3 -.fl -XLintStatic.m1(); -.fl -\fP -.fi -Alternatively, you can remove the \f2static\fP keyword from the declaration of the method \f2m1\fP. -.TP 3 -try -Warn about issues relating to use of \f2try\fP blocks, including try\-with\-resources statements. For example, a warning is generated for the following statement because the resource \f2ac\fP declared in the \f2try\fP statement is not used: -.nf -\f3 -.fl -try ( AutoCloseable ac = getResource() ) { -.fl - // do nothing -.fl -} -.fl -\fP -.fi -.TP 3 -unchecked -Give more detail for unchecked conversion warnings that are mandated by the Java Language Specification. For example: -.nf -\f3 -.fl - List l = new ArrayList<Number>(); -.fl - List<String> ls = l; // unchecked warning -.fl -\fP -.fi -During type erasure, the types \f2ArrayList<Number>\fP and \f2List<String>\fP become \f2ArrayList\fP and \f2List\fP, respectively. -.br -.br -The variable \f2ls\fP has the parameterized type \f2List<String>\fP. When the \f2List\fP referenced by \f2l\fP is assigned to \f2ls\fP, the compiler generates an unchecked warning; the compiler is unable to determine at compile time, and moreover knows that the JVM will not be able to determine at runtime, if \f2l\fP refers to a \f2List<String>\fP type; it does not. Consequently, heap pollution occurs. -.br -.br -In detail, a heap pollution situation occurs when the \f2List\fP object \f2l\fP, whose static type is \f2List<Number>\fP, is assigned to another \f2List\fP object, \f2ls\fP, that has a different static type, \f2List<String>\fP. However, the compiler still allows this assignment. It must allow this assignment to preserve backwards compatibility with versions of Java SE that do not support generics. Because of type erasure, \f2List<Number>\fP and \f2List<String>\fP both become \f2List\fP. Consequently, the compiler allows the assignment of the object \f2l\fP, which has a raw type of \f2List\fP, to the object \f2ls\fP. -.TP 3 -varargs -Warn about unsafe usages of variable arguments (varargs) methods, in particular, those that contain non\-reifiable arguments. For example: -.nf -\f3 -.fl -public class ArrayBuilder { -.fl - public static <T> void addToList (List<T> listArg, T... elements) { -.fl - for (T x : elements) { -.fl - listArg.add(x); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi -The compiler generates the following warning for the definition of the method \f2ArrayBuilder.addToList\fP: -.nf -\f3 -.fl -warning: [varargs] Possible heap pollution from parameterized vararg type T -.fl -\fP -.fi -When the compiler encounters a varargs method, it translates the varargs formal parameter into an array. However, the Java programming language does not permit the creation of arrays of parameterized types. In the method \f2ArrayBuilder.addToList\fP, the compiler translates the varargs formal parameter \f2T... elements\fP to the formal parameter \f2T[] elements\fP, an array. However, because of type erasure, the compiler converts the varargs formal parameter to \f2Object[] elements\fP. Consequently, there is a possibility of heap pollution. -.RE +.sp +.nf +\f3warning: [serial] serializable class PersistentTime has no definition of\fP +.fi +.nf +\f3serialVersionUID\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "COMMAND LINE ARGUMENT FILES" -.LP -.LP -To shorten or simplify the javac command line, you can specify one or more files that themselves contain arguments to the \f2javac\fP command (except \f2\-J\fP options). This enables you to create javac commands of any length on any operating system. -.LP -.LP -An argument file can include javac options and source filenames in any combination. The arguments within a file can be space\-separated or newline\-separated. If a filename contains embedded spaces, put the whole filename in double quotes. -.LP -.LP -Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying \f2*.java\fP). Use of the '\f2@\fP' character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -.LP -When executing javac, pass in the path and name of each argument file with the '\f2@\fP' leading character. When javac encounters an argument beginning with the character `\f2@\fP', it expands the contents of that file into the argument list. -.LP -.SS -Example \- Single Arg File -.LP -.LP -You could use a single argument file named "\f2argfile\fP" to hold all javac arguments: -.LP -.nf -\f3 -.fl -% \fP\f3javac @argfile\fP -.fl -.fi -.LP -.LP -This argument file could contain the contents of both files shown in the next example. -.LP -.SS -Example \- Two Arg Files -.LP -.LP -You can create two argument files \-\- one for the javac options and the other for the source filenames: (Notice the following lists have no line\-continuation characters.) -.LP -.LP -Create a file named "\f2options\fP" containing: -.LP -.nf -\f3 -.fl - \-d classes -.fl - \-g -.fl - \-sourcepath /java/pubs/ws/1.3/src/share/classes -.fl +If a serializable class does not explicitly declare a field named \f3serialVersionUID\fR, then the serialization runtime environment calculates a default \f3serialVersionUID\fR value for that class based on various aspects of the class, as described in the Java Object Serialization Specification\&. However, it is strongly recommended that all serializable classes explicitly declare \f3serialVersionUID\fR values because the default process of computing \f3serialVersionUID\fR vales is highly sensitive to class details that can vary depending on compiler implementations, and as a result, might cause an unexpected \f3InvalidClassExceptions\fR during deserialization\&. To guarantee a consistent \f3serialVersionUID\fR value across different Java compiler implementations, a serializable class must declare an explicit \f3serialVersionUID\fR value\&. +.TP +static +Warns about issues relating to the use of statics, for example: +.sp +.nf +\f3class XLintStatic {\fP +.fi +.nf +\f3 static void m1() { }\fP +.fi +.nf +\f3 void m2() { this\&.m1(); }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -\fP -.fi -.LP -.LP -Create a file named "\f2classes\fP" containing: -.LP -.nf -\f3 -.fl - MyClass1.java -.fl - MyClass2.java -.fl - MyClass3.java -.fl +The compiler generates the following warning: +.sp +.nf +\f3warning: [static] static method should be qualified by type name, \fP +.fi +.nf +\f3XLintStatic, instead of by an expression\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -\fP -.fi -.LP -.LP -You would then run \f3javac\fP with: -.LP -.nf -\f3 -.fl - % \fP\f3javac @options @classes\fP -.fl +To resolve this issue, you can call the \f3static\fR method \f3m1\fR as follows: +.sp +.nf +\f3XLintStatic\&.m1();\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl -.fi -.LP -.SS -Example \- Arg Files with Paths -.LP -.LP -The argument files can have paths, but any filenames inside the files are relative to the current working directory (not \f2path1\fP or \f2path2\fP): -.LP -.nf -\f3 -.fl -% \fP\f3javac @path1/options @path2/classes\fP -.fl -.fi +Alternately, you can remove the \f3static\fR keyword from the declaration of the method \f3m1\fR\&. +.TP +try +Warns about issues relating to use of \f3try\fR blocks, including try-with-resources statements\&. For example, a warning is generated for the following statement because the resource \f3ac\fR declared in the \f3try\fR block is not used: +.sp +.nf +\f3try ( AutoCloseable ac = getResource() ) { // do nothing}\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "ANNOTATION PROCESSING" -.LP -.LP -\f3javac\fP provides direct support for annotation processing, superseding the need for the separate annotation processing tool, \f3apt\fP. -.LP -.LP -The API for annotation processors is defined in the \f2javax.annotation.processing\fP and \f2javax.lang.model\fP packages and subpackages. -.LP -.SS -Overview of annotation processing -.LP -.LP -Unless annotation processing is disabled with the \f3\-proc:none\fP option, the compiler searches for any annotation processors that are available. The search path can be specified with the \f3\-processorpath\fP option; if it is not given, the user class path is used. Processors are located by means of service provider\-configuration files named \f2META\-INF/services/javax.annotation.processing.Processor\fP on the search path. Such files should contain the names of any annotation processors to be used, listed one per line. Alternatively, processors can be specified explicitly, using the \f3\-processor\fP option. -.LP -.LP -After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process. When a match is found, the processor will be invoked. A processor may "claim" the annotations it processes, in which case no further attempt is made to find any processors for those annotations. Once all annotations have been claimed, the compiler does not look for additional processors. -.LP -.LP -If any processors generate any new source files, another round of annotation processing will occur: any newly generated source files will be scanned, and the annotations processed as before. Any processors invoked on previous rounds will also be invoked on all subsequent rounds. This continues until no new source files are generated. -.LP -.LP -After a round occurs where no new source files are generated, the annotation processors will be invoked one last time, to give them a chance to complete any work they may need to do. Finally, unless the \f3\-proc:only\fP option is used, the compiler will compile the original and all the generated source files. -.LP -.SS -Implicitly loaded source files -.LP -.LP -To compile a set of source files, the compiler may need to implicitly load additional source files. (See Searching For Types). Such files are currently not subject to annotation processing. By default, the compiler will give a warning if annotation processing has occurred and any implicitly loaded source files are compiled. See the \-implicit option for ways to suppress the warning. -.LP -.SH "SEARCHING FOR TYPES" -.LP -.LP -When compiling a source file, the compiler often needs information about a type whose definition did not appear in the source files given on the command line. The compiler needs type information for every class or interface used, extended, or implemented in the source file. This includes classes and interfaces not explicitly mentioned in the source file but which provide information through inheritance. -.LP -.LP -For example, when you subclass \f3java.applet.Applet\fP, you are also using \f3Applet's\fP ancestor classes: \f3java.awt.Panel\fP, \f3java.awt.Container\fP, \f3java.awt.Component\fP, and \f3java.lang.Object\fP. -.LP -.LP -When the compiler needs type information, it looks for a source file or class file which defines the type. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory). The user class path is defined by setting the \f3CLASSPATH\fP environment variable or by using the \f3\-classpath\fP command line option. (For details, see Setting the Class Path). -.LP -.LP -If you set the \-sourcepath option, the compiler searches the indicated path for source files; otherwise the compiler searches the user class path for both class files and source files. -.LP -.LP -You can specify different bootstrap or extension classes with the \f3\-bootclasspath\fP and \f3\-extdirs\fP options; see Cross\-Compilation Options below. -.LP -.LP -A successful type search may produce a class file, a source file, or both. If both are found, you can use the \-Xprefer option to instruct the compiler which to use. If \f3newer\fP is given, the compiler will use the newer of the two files. If \f3source\fP is given, it will use the source file. The default is \f3newer\fP. -.LP -.LP -If a type search finds a source file for a required type, either by itself, or as a result of the setting for \f3\-Xprefer\fP, the compiler will read the source file to get the information it needs. In addition, it will by default compile the source file as well. You can use the \-implicit option to specify the behavior. If \f3none\fP is given, no class files will be generated for the source file. If \f3class\fP is given, class files will be generated for the source file. -.LP -.LP -The compiler may not discover the need for some type information until after annotation processing is complete. If the type information is found in a source file and no \f3\-implicit\fP option is given, the compiler will give a warning that the file is being compiled without being subject to annotation processing. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3\-implicit\fP option to specify whether or not class files should be generated for such source files. -.LP -.SH "PROGRAMMATIC INTERFACE" -.LP -.LP -\f3javac\fP supports the new Java Compiler API defined by the classes and interfaces in the \f2javax.tools\fP package. -.LP -.SS -Example -.LP -.LP -To perform a compilation using arguments as you would give on the command line, you can use the following: -.LP -.nf -\f3 -.fl -JavaCompiler javac = ToolProvider.getSystemJavaCompiler(); -.fl -int rc = javac.run(null, null, null, args); -.fl -\fP -.fi +.TP +unchecked +Gives more detail for unchecked conversion warnings that are mandated by the Java Language Specification, for example: +.sp +.nf +\f3List l = new ArrayList<Number>();\fP +.fi +.nf +\f3List<String> ls = l; // unchecked warning\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -This will write any diagnostics to the standard output stream, and return the exit code that \f3javac\fP would give when invoked from the command line. -.LP -.LP -You can use other methods on the \f2javax.tools.JavaCompiler\fP interface to handle diagnostics, control where files are read from and written to, and so on. -.LP -.SS -Old Interface -.LP -.LP -\f3Note:\fP This API is retained for backwards compatibility only; all new code should use the Java Compiler API, described above. -.LP -.LP -The \f2com.sun.tools.javac.Main\fP class provides two static methods to invoke the compiler from a program: -.LP -.nf -\f3 -.fl -public static int compile(String[] args); -.fl -public static int compile(String[] args, PrintWriter out); -.fl -\fP -.fi -.LP -.LP -The \f2args\fP parameter represents any of the command line arguments that would normally be passed to the javac program and are outlined in the above Synopsis section. -.LP -.LP -The \f2out\fP parameter indicates where the compiler's diagnostic output is directed. -.LP -.LP -The return value is equivalent to the exit value from \f3javac\fP. -.LP -.LP -Note that all \f3other\fP classes and methods found in a package whose name starts with \f2com.sun.tools.javac\fP (informally known as sub\-packages of \f2com.sun.tools.javac\fP) are strictly internal and subject to change at any time. -.LP -.SH "EXAMPLES" -.LP -.SS -Compiling a Simple Program -.LP -.LP -One source file, \f2Hello.java\fP, defines a class called \f3greetings.Hello\fP. The \f2greetings\fP directory is the package directory both for the source file and the class file and is off the current directory. This allows us to use the default user class path. It also makes it unnecessary to specify a separate destination directory with \f3\-d\fP. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -greetings/ -.fl -% \f3ls greetings\fP -.fl -Hello.java -.fl -% \f3cat greetings/Hello.java\fP -.fl -package greetings; -.fl +During type erasure, the types \f3ArrayList<Number>\fR and \f3List<String>\fR become \f3ArrayList\fR and \f3List\fR, respectively\&. -.fl -public class Hello { -.fl - public static void main(String[] args) { -.fl - for (int i=0; i < args.length; i++) { -.fl - System.out.println("Hello " + args[i]); -.fl - } -.fl - } -.fl -} -.fl -% \f3javac greetings/Hello.java\fP -.fl -% \f3ls greetings\fP -.fl -Hello.class Hello.java -.fl -% \f3java greetings.Hello World Universe Everyone\fP -.fl -Hello World -.fl -Hello Universe -.fl -Hello Everyone -.fl -.fi +The \f3ls\fR command has the parameterized type \f3List<String>\fR\&. When the \f3List\fR referenced by \f3l\fR is assigned to \f3ls\fR, the compiler generates an unchecked warning\&. At compile time, the compiler and JVM cannot determine whether \f3l\fR refers to a \f3List<String>\fR type\&. In this case, \f3l\fR does not refer to a \f3List<String>\fR type\&. As a result, heap pollution occurs\&. -.LP -.SS -Compiling Multiple Source Files -.LP -.LP -This example compiles all the source files in the package \f2greetings\fP. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -greetings/ -.fl -% \f3ls greetings\fP -.fl -Aloha.java GutenTag.java Hello.java Hi.java -.fl -% \f3javac greetings/*.java\fP -.fl -% \f3ls greetings\fP -.fl -Aloha.class GutenTag.class Hello.class Hi.class -.fl -Aloha.java GutenTag.java Hello.java Hi.java -.fl -.fi +A heap pollution situation occurs when the \f3List\fR object \f3l\fR, whose static type is \f3List<Number>\fR, is assigned to another \f3List\fR object, \f3ls\fR, that has a different static type, \f3List<String>\fR\&. However, the compiler still allows this assignment\&. It must allow this assignment to preserve backward compatibility with releases of Java SE that do not support generics\&. Because of type erasure, \f3List<Number>\fR and \f3List<String>\fR both become \f3List\fR\&. Consequently, the compiler allows the assignment of the object \f3l\fR\f3,\fR which has a raw type of \f3List\fR, to the object \f3ls\fR\&. +.TP +varargs +Warns about unsafe usages of variable arguments (\f3varargs\fR) methods, in particular, those that contain non-reifiable arguments, for example: +.sp +.nf +\f3public class ArrayBuilder {\fP +.fi +.nf +\f3 public static <T> void addToList (List<T> listArg, T\&.\&.\&. elements) {\fP +.fi +.nf +\f3 for (T x : elements) {\fP +.fi +.nf +\f3 listArg\&.add(x);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SS -Specifying a User Class Path -.LP -.LP -Having changed one of the source files in the previous example, we recompile it: -.LP -.nf -\f3 -.fl -% \fP\f3pwd\fP -.fl -/examples -.fl -% \f3javac greetings/Hi.java\fP -.fl -.fi -.LP -.LP -Since \f2greetings.Hi\fP refers to other classes in the \f2greetings\fP package, the compiler needs to find these other classes. The example above works, because our default user class path happens to be the directory containing the package directory. But suppose we want to recompile this file and not worry about which directory we're in? Then we need to add \f2/examples\fP to the user class path. We can do this by setting \f3CLASSPATH\fP, but here we'll use the \f3\-classpath\fP option. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-classpath /examples /examples/greetings/Hi.java\fP -.fl -.fi +\fINote:\fR A non-reifiable type is a type whose type information is not fully available at runtime\&. -.LP -.LP -If we change \f2greetings.Hi\fP again, to use a banner utility, that utility also needs to be accessible through the user class path. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-classpath /examples:/lib/Banners.jar \\ -.fl - /examples/greetings/Hi.java\fP -.fl -.fi +The compiler generates the following warning for the definition of the method \f3ArrayBuilder\&.addToList\fR +.sp +.nf +\f3warning: [varargs] Possible heap pollution from parameterized vararg type T\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -To execute a class in \f2greetings\fP, we need access both to \f2greetings\fP and to the classes it uses. -.LP -.nf -\f3 -.fl -% \fP\f3java \-classpath /examples:/lib/Banners.jar greetings.Hi\fP -.fl -.fi -.LP -.SS -Separating Source Files and Class Files -.LP -.LP -It often makes sense to keep source files and class files in separate directories, especially on large projects. We use \f3\-d\fP to indicate the separate class file destination. Since the source files are not in the user class path, we use \f3\-sourcepath\fP to help the compiler find them. -.LP -.nf -\f3 -.fl -% \fP\f3ls\fP -.fl -classes/ lib/ src/ -.fl -% \f3ls src\fP -.fl -farewells/ -.fl -% \f3ls src/farewells\fP -.fl -Base.java GoodBye.java -.fl -% \f3ls lib\fP -.fl -Banners.jar -.fl -% \f3ls classes\fP -.fl -% \f3javac \-sourcepath src \-classpath classes:lib/Banners.jar \\ -.fl - src/farewells/GoodBye.java \-d classes\fP -.fl -% \f3ls classes\fP -.fl -farewells/ -.fl -% \f3ls classes/farewells\fP -.fl -Base.class GoodBye.class -.fl -.fi - -.LP -.LP -\f3Note:\fP The compiler compiled \f2src/farewells/Base.java\fP, even though we didn't specify it on the command line. To trace automatic compiles, use the \f3\-verbose\fP option. -.LP -.SS -Cross\-Compilation Example -.LP -.LP -Here we use \f3javac\fP to compile code that will run on a 1.6 VM. -.LP -.nf -\f3 -.fl -% \fP\f3javac \-source 1.6 \-target 1.6 \-bootclasspath jdk1.6.0/lib/rt.jar \\ -.fl - \-extdirs "" OldCode.java\fP -.fl -.fi - -.LP -.LP -The \f2\-source 1.6\fP option specifies that version 1.6 (or 6) of the Java programming language be used to compile \f2OldCode.java\fP. The option \f3\-target 1.6\fP option ensures that the generated class files will be compatible with 1.6 VMs. Note that in most cases, the value of the \f3\-target\fP option is the value of the \f3\-source\fP option; in this example, you can omit the \f3\-target\fP option. -.LP -.LP -You must specify the \f3\-bootclasspath\fP option to specify the correct version of the bootstrap classes (the \f2rt.jar\fP library). If not, the compiler generates a warning: -.LP -.nf -\f3 -.fl -% \fP\f3javac \-source 1.6 OldCode.java\fP -.fl -warning: [options] bootstrap class path not set in conjunction with \-source 1.6 -.fl -.fi - -.LP -.LP -If you do not specify the correct version of bootstrap classes, the compiler will use the old language rules (in this example, it will use version 1.6 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to non\-existent methods can get included. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -.na -\f2The javac Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javac/index.html -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jdb(1) \- Java Application Debugger -.TP 2 -o -javah(1) \- C Header and Stub File Generator -.TP 2 -o -javap(1) \- Class File Disassembler -.TP 2 -o -javadoc(1) \- API Documentation Generator -.TP 2 -o -jar(1) \- JAR Archive Tool -.TP 2 -o -.na -\f2The Java Extensions Framework\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/extensions/index.html -.RE - -.LP - +When the compiler encounters a varargs method, it translates the \f3varargs\fR formal parameter into an array\&. However, the Java programming language does not permit the creation of arrays of parameterized types\&. In the method \f3ArrayBuilder\&.addToList\fR, the compiler translates the \f3varargs\fR formal parameter \f3T\&.\&.\&.\fR elements to the formal parameter \f3T[]\fR elements, an array\&. However, because of type erasure, the compiler converts the \f3varargs\fR formal parameter to \f3Object[]\fR elements\&. Consequently, there is a possibility of heap pollution\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javac\fR command, you can specify one or more files that contain arguments to the \f3javac\fR command (except \f3-J\fR options)\&. This enables you to create \f3javac\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be separated by spaces or new line characters\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (*) are not allowed in these lists (such as for specifying \f3*\&.java\fR)\&. Use of the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When executing the \f3javac\fR command, pass in the path and name of each argument file with the at sign (@) leading character\&. When the \f3javac\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javac\fR arguments: +.sp +.nf +\f3javac @argfile\fP +.fi +.nf +\f3\fP +.fi +.sp +This argument file could contain the contents of both files shown in Example 2 +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: one for the \f3javac\fR options and the other for the source file names\&. Note that the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains the following: +.sp +.nf +\f3\-d classes\fP +.fi +.nf +\f3\-g\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.3/src/share/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +Create a file named classes that contains the following: +.sp +.nf +\f3MyClass1\&.java\fP +.fi +.nf +\f3MyClass2\&.java\fP +.fi +.nf +\f3MyClass3\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Then, run the \f3javac\fR command as follows: +.sp +.nf +\f3javac @options @classes\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javac @path1/options @path2/classes\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH ANNOTATION\ PROCESSING +The \f3javac\fR command provides direct support for annotation processing, superseding the need for the separate annotation processing command, \f3apt\fR\&. +.PP +The API for annotation processors is defined in the \f3javax\&.annotation\&.processing\fR and j\f3avax\&.lang\&.model\fR packages and subpackages\&. +.SS HOW\ ANNOTATION\ PROCESSING\ WORKS +Unless annotation processing is disabled with the \f3-proc:none\fR option, the compiler searches for any annotation processors that are available\&. The search path can be specified with the \f3-processorpath\fR option\&. If no path is specified, then the user class path is used\&. Processors are located by means of service provider-configuration files named \f3META-INF/services/javax\&.annotation\&.processing\fR\&.Processor on the search path\&. Such files should contain the names of any annotation processors to be used, listed one per line\&. Alternatively, processors can be specified explicitly, using the \f3-processor\fR option\&. +.PP +After scanning the source files and classes on the command line to determine what annotations are present, the compiler queries the processors to determine what annotations they process\&. When a match is found, the processor is called\&. A processor can claim the annotations it processes, in which case no further attempt is made to find any processors for those annotations\&. After all of the annotations are claimed, the compiler does not search for additional processors\&. +.PP +If any processors generate new source files, then another round of annotation processing occurs: Any newly generated source files are scanned, and the annotations processed as before\&. Any processors called on previous rounds are also called on all subsequent rounds\&. This continues until no new source files are generated\&. +.PP +After a round occurs where no new source files are generated, the annotation processors are called one last time, to give them a chance to complete any remaining work\&. Finally, unless the \f3-proc:only\fR option is used, the compiler compiles the original and all generated source files\&. +.SS IMPLICITLY\ LOADED\ SOURCE\ FILES +To compile a set of source files, the compiler might need to implicitly load additional source files\&. See Searching for Types\&. Such files are currently not subject to annotation processing\&. By default, the compiler gives a warning when annotation processing occurred and any implicitly loaded source files are compiled\&. The \f3-implicit\fR option provides a way to suppress the warning\&. +.SH SEARCHING\ FOR\ TYPES +To compile a source file, the compiler often needs information about a type, but the type definition is not in the source files specified on the command line\&. The compiler needs type information for every class or interface used, extended, or implemented in the source file\&. This includes classes and interfaces not explicitly mentioned in the source file, but that provide information through inheritance\&. +.PP +For example, when you create a subclass \f3java\&.applet\&.Applet\fR, you are also using the ancestor classes of \f3Applet\fR: \f3java\&.awt\&.Panel\fR, \f3java\&.awt\&.Container\fR, \f3java\&.awt\&.Component\fR, and \f3java\&.lang\&.Object\fR\&. +.PP +When the compiler needs type information, it searches for a source file or class file that defines the type\&. The compiler searches for class files first in the bootstrap and extension classes, then in the user class path (which by default is the current directory)\&. The user class path is defined by setting the \f3CLASSPATH\fR environment variable or by using the \f3-classpath\fR option\&. +.PP +If you set the \f3-sourcepath\fR option, then the compiler searches the indicated path for source files\&. Otherwise, the compiler searches the user class path for both class files and source files\&. +.PP +You can specify different bootstrap or extension classes with the \f3-bootclasspath\fR and the \f3-extdirs\fR options\&. See Cross-Compilation Options\&. +.PP +A successful type search may produce a class file, a source file, or both\&. If both are found, then you can use the \f3-Xprefer\fR option to instruct the compiler which to use\&. If \f3newer\fR is specified, then the compiler uses the newer of the two files\&. If \f3source\fR is specified, the compiler uses the source file\&. The default is \f3newer\fR\&. +.PP +If a type search finds a source file for a required type, either by itself, or as a result of the setting for the \f3-Xprefer\fR option, then the compiler reads the source file to get the information it needs\&. By default the compiler also compiles the source file\&. You can use the \f3-implicit\fR option to specify the behavior\&. If \f3none\fR is specified, then no class files are generated for the source file\&. If \f3class\fR is specified, then class files are generated for the source file\&. +.PP +The compiler might not discover the need for some type information until after annotation processing completes\&. When the type information is found in a source file and no \f3-implicit\fR option is specified, the compiler gives a warning that the file is being compiled without being subject to annotation processing\&. To disable the warning, either specify the file on the command line (so that it will be subject to annotation processing) or use the \f3-implicit\fR option to specify whether or not class files should be generated for such source files\&. +.SH PROGRAMMATIC\ INTERFACE +The \f3javac\fR command supports the new Java Compiler API defined by the classes and interfaces in the \f3javax\&.tools\fR package\&. +.SS EXAMPLE +To compile as though providing command-line arguments, use the following syntax: +.sp +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3JavaCompiler javac = ToolProvider\&.getSystemJavaCompiler();\fP +.fi +.nf +\f3\fP +.fi +.sp +The example writes diagnostics to the standard output stream and returns the exit code that \f3javac\fR would give when called from the command line\&. +.PP +You can use other methods in the \f3javax\&.tools\&.JavaCompiler\fR interface to handle diagnostics, control where files are read from and written to, and more\&. +.SS OLD\ INTERFACE +\fINote:\fR This API is retained for backward compatibility only\&. All new code should use the newer Java Compiler API\&. +.PP +The \f3com\&.sun\&.tools\&.javac\&.Main\fR class provides two static methods to call the compiler from a program: +.sp +.nf +\f3public static int compile(String[] args);\fP +.fi +.nf +\f3public static int compile(String[] args, PrintWriter out);\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3args\fR parameter represents any of the command-line arguments that would typically be passed to the compiler\&. +.PP +The \f3out\fR parameter indicates where the compiler diagnostic output is directed\&. +.PP +The \f3return\fR value is equivalent to the \f3exit\fR value from \f3javac\fR\&. +.PP +\fINote:\fR All other classes and methods found in a package with names that start with \f3com\&.sun\&.tools\&.javac\fR (subpackages of \f3com\&.sun\&.tools\&.javac\fR) are strictly internal and subject to change at any time\&. +.SH EXAMPLES +\f3Example 1 Compile a Simple Program\fR +.PP +This example shows how to compile the \f3Hello\&.java\fR source file in the greetings directory\&. The class defined in \f3Hello\&.java\fR is called \f3greetings\&.Hello\fR\&. The greetings directory is the package directory both for the source file and the class file and is underneath the current directory\&. This makes it possible to use the default user class path\&. It also makes it unnecessary to specify a separate destination directory with the \f3-d\fR option\&. +.PP +The source code in \f3Hello\&.java\fR: +.sp +.nf +\f3package greetings;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class Hello {\fP +.fi +.nf +\f3 public static void main(String[] args) {\fP +.fi +.nf +\f3 for (int i=0; i < args\&.length; i++) {\fP +.fi +.nf +\f3 System\&.out\&.println("Hello " + args[i]);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +Compile greetings\&.Hello: +.sp +.nf +\f3javac greetings/Hello\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Run \f3greetings\&.Hello\fR: +.sp +.nf +\f3java greetings\&.Hello World Universe Everyone\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3Hello Universe\fP +.fi +.nf +\f3Hello Everyone\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 2 Compile Multiple Source Files\fR +.PP +This example compiles the \f3Aloha\&.java\fR, \f3GutenTag\&.java\fR, \f3Hello\&.java\fR, and \f3Hi\&.java\fR source files in the \f3greetings\fR package\&. +.sp +.nf +\f3% javac greetings/*\&.java\fP +.fi +.nf +\f3% ls greetings\fP +.fi +.nf +\f3Aloha\&.class GutenTag\&.class Hello\&.class Hi\&.class\fP +.fi +.nf +\f3Aloha\&.java GutenTag\&.java Hello\&.java Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 3 Specify a User Class Path\fR +.PP +After changing one of the source files in the previous example, recompile it: +.sp +.nf +\f3pwd\fP +.fi +.nf +\f3/examples\fP +.fi +.nf +\f3javac greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +Because \f3greetings\&.Hi\fR refers to other classes in the \f3greetings\fR package, the compiler needs to find these other classes\&. The previous example works because the default user class path is the directory that contains the package directory\&. If you want to recompile this file without concern for which directory you are in, then add the examples directory to the user class path by setting \f3CLASSPATH\fR\&. This example uses the \f3-classpath\fR option\&. +.sp +.nf +\f3javac \-classpath /examples /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +If you change \f3greetings\&.Hi\fR to use a banner utility, then that utility also needs to be accessible through the user class path\&. +.sp +.nf +\f3javac \-classpath /examples:/lib/Banners\&.jar \e\fP +.fi +.nf +\f3 /examples/greetings/Hi\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +To execute a class in the \f3greetings\fR package, the program needs access to the \f3greetings\fR package, and to the classes that the \f3greetings\fR classes use\&. +.sp +.nf +\f3java \-classpath /examples:/lib/Banners\&.jar greetings\&.Hi\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3Example 4 Separate Source Files and Class Files\fR +.PP +The following example uses \f3javac\fR to compile code that runs on JVM 1\&.6\&. +.sp +.nf +\f3javac \-source 1\&.6 \-target 1\&.6 \-bootclasspath jdk1\&.6\&.0/lib/rt\&.jar \e \fP +.fi +.nf +\f3\-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3-source 1\&.6\fR option specifies that release 1\&.6 (or 6) of the Java programming language be used to compile \f3OldCode\&.java\fR\&. The option \f3-target 1\&.6\fR option ensures that the generated class files are compatible with JVM 1\&.6\&. Note that in most cases, the value of the \f3-target\fR option is the value of the \f3-source\fR option; in this example, you can omit the \f3-target\fR option\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.6 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \fP +.fi +.nf +\f3\-source 1\&.6\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules (in this example, it uses version 1\&.6 of the Java programming language) combined with the new bootstrap classes, which can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to nonexistent methods can get included\&. +.PP +\f3Example 5 Cross Compile\fR +.PP +This example uses \f3javac\fR to compile code that runs on JVM 1\&.6\&. +.sp +.nf +\f3javac \-source 1\&.6 \-target 1\&.6 \-bootclasspath jdk1\&.6\&.0/lib/rt\&.jar \e\fP +.fi +.nf +\f3 \-extdirs "" OldCode\&.java\fP +.fi +.nf +\f3\fP +.fi +.sp +The\f3-source 1\&.6\fR option specifies that release 1\&.6 (or 6) of the Java programming language to be used to compile OldCode\&.java\&. The \f3-target 1\&.6\fR option ensures that the generated class files are compatible with JVM 1\&.6\&. In most cases, the value of the \f3-target\fR is the value of \f3-source\fR\&. In this example, the \f3-target\fR option is omitted\&. +.PP +You must specify the \f3-bootclasspath\fR option to specify the correct version of the bootstrap classes (the \f3rt\&.jar\fR library)\&. If not, then the compiler generates a warning: +.sp +.nf +\f3javac \-source 1\&.6 OldCode\&.java\fP +.fi +.nf +\f3warning: [options] bootstrap class path not set in conjunction with \-source 1\&.6\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the correct version of bootstrap classes, then the compiler uses the old language rules combined with the new bootstrap classes\&. This combination can result in class files that do not work on the older platform (in this case, Java SE 6) because reference to nonexistent methods can get included\&. In this example, the compiler uses release 1\&.6 of the Java programming language\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jdb(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/javadoc.1 b/jdk/src/solaris/doc/sun/man/man1/javadoc.1 index 6fa939b6b24..b48535a388a 100644 --- a/jdk/src/solaris/doc/sun/man/man1/javadoc.1 +++ b/jdk/src/solaris/doc/sun/man/man1/javadoc.1 @@ -1,4234 +1,2997 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javadoc 1 "10 May 2011" -.SH "Name" -javadoc \- The Java API Documentation Generator -.LP -Generates HTML pages of API documentation from Java source files. This document contains Javadoc examples for Solaris. -.SH "SYNOPSIS" -.LP -\f4javadoc\fP\f2\ [\ \fP\f2options\fP\f2\ ]\ [\ packagenames\ ]\ [\ sourcefilenames\ ]\ [\ \-subpackages\fP\ \f2pkg1:pkg2:...\fP\f2\ ]\ [\ \fP\f2@argfiles\fP\f2\ ]\fP -.LP -Arguments can be in any order. See processing of Source Files for details on how the Javadoc tool determines which "\f2.java\fP" files to process. -.RS 3 -.TP 3 -options -Command\-line options, as specified in this document. To see a typical use of javadoc options, see Real\-World Example. -.TP 3 -packagenames -A series of names of packages, separated by spaces, such as \f2java.lang\ java.lang.reflect\ java.awt\fP. You must separately specify each package you want to document. Wildcards are not allowed; use \-subpackages for recursion. The Javadoc tool uses \f2\-sourcepath\fP to look for these package names. See Example \- Documenting One or More Packages -.TP 3 -sourcefilenames -A series of source file names, separated by spaces, each of which can begin with a path and contain a wildcard such as asterisk (*). The Javadoc tool will process every file whose name ends with ".java", and whose name, when stripped of that suffix, is actually a legal class name (see the Java Language Specification). Therefore, you can name files with dashes (such as \f2X\-Buffer\fP), or other illegal characters, to prevent them from being documented. This is useful for test files and template files The path that precedes the source file name determines where javadoc will look for the file. (The Javadoc tool does \f2not\fP use \f2\-sourcepath\fP to look for these source file names.) Relative paths are relative to the current directory, so passing in \f2Button.java\fP is identical to \f2./Button.java\fP. A source file name with an absolute path and a wildcard, for example, is \f2/home/src/java/awt/Graphics*.java\fP. See Example\ \-\ Documenting One or More Classes. You can also mix packagenames and sourcefilenames, as in Example\ \-\ Documenting Both Packages and Classes -.TP 3 -\-subpackages pkg1:pkg2:... -Generates documentation from source files in the specified packages and recursively in their subpackages. An alternative to supplying packagenames or sourcefilenames. -.TP 3 -@argfiles -One or more files that contain a list of Javadoc options, packagenames and sourcefilenames in any order. Wildcards (*) and \f2\-J\fP options are not allowed in these files. -.RE -.SH "DESCRIPTION" -.LP -The \f3Javadoc\fP tool parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields. You can use it to generate the API (Application Programming Interface) documentation or the implementation documentation for a set of source files. -.LP -You can run the Javadoc tool on entire packages, individual source files, or both. When documenting entire packages, you can either use \f2\-subpackages\fP for traversing recursively down from a top\-level directory, or pass in an explicit list of package names. When documenting individual source files, you pass in a list of source (\f2.java\fP) filenames. Examples are given at the end of this document. How Javadoc processes source files is covered next. -.SS -Processing of source files -.LP -The Javadoc tool processes files that end in "\f2.java\fP" plus other files described under Source Files. If you run the Javadoc tool by explicitly passing in individual source filenames, you can determine exactly which "\f2.java\fP" files are processed. However, that is not how most developers want to work, as it is simpler to pass in package names. The Javadoc tool can be run three ways without explicitly specifying the source filenames. You can (1) pass in package names, (2) use \f2\-subpackages\fP, and (3) use wildcards with source filenames (\f2*.java\fP). In these cases, the Javadoc tool processes a "\f2.java\fP" file only if it fulfills all of the following requirements: -.RS 3 -.TP 2 -o -Its name, after stripping off the "\f2.java\fP" suffix, is actually a legal class name (see the Java Language Specification for legal characters) -.TP 2 -o -Its directory path relative to the root of the source tree is actually a legal package name (after converting its separators to dots) -.TP 2 -o -Its package statement contains the legal package name (specified in the previous bullet) -.RE -.LP -\f3Processing of links\fP \- During a run, the Javadoc tool automatically adds cross\-reference links to package, class and member names that are being documented as part of that run. Links appear in several places: -.RS 3 -.TP 2 -o -Declarations (return types, argument types, field types) -.TP 2 -o -"See Also" sections generated from \f2@see\fP tags -.TP 2 -o -In\-line text generated from \f2{@link}\fP tags -.TP 2 -o -Exception names generated from \f2@throws\fP tags -.TP 2 -o -"Specified by" links to members in interfaces and "Overrides" links to members in classes -.TP 2 -o -Summary tables listing packages, classes and members -.TP 2 -o -Package and class inheritance trees -.TP 2 -o -The index -.RE -.LP -You can add hyperlinks to existing text for classes not included on the command line (but generated separately) by way of the \f2\-link\fP and \f2\-linkoffline\fP options. -.LP -\f3Other processing details\fP \- The Javadoc tool produces one complete document each time it is run; it cannot do incremental builds \-\- that is, it cannot modify or \f2directly\fP incorporate results from previous runs of the Javadoc tool. However, it can link to results from other runs, as just mentioned. -.LP -As implemented, the Javadoc tool requires and relies on the java compiler to do its job. The Javadoc tool calls part of \f2javac\fP to compile the declarations, ignoring the member implementation. It builds a rich internal representation of the classes, including the class hierarchy, and "use" relationships, then generates the HTML from that. The Javadoc tool also picks up user\-supplied documentation from documentation comments in the source code. -.LP -In fact, the Javadoc tool will run on \f2.java\fP source files that are pure stub files with no method bodies. This means you can write documentation comments and run the Javadoc tool in the earliest stages of design while creating the API, before writing the implementation. -.LP -Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code. For example, the Javadoc tool documents default constructors (see Java Language Specification) that are present in the \f2.class\fP files but not in the source code. -.LP -In many cases, the Javadoc tool allows you to generate documentation for source files whose code is incomplete or erroneous. This is a benefit that enables you to generate documentation before all debugging and troubleshooting is done. For example, according to the \f2Java Language Specification\fP, a class that contains an abstract method should itself be declared abstract. The Javadoc tool does not check for this, and would proceed without a warning, whereas the javac compiler stops on this error. The Javadoc tool does do some primitive checking of doc comments. Use the DocCheck doclet to check the doc comments more thoroughly. -.LP -When the Javadoc tool builds its internal structure for the documentation, it loads all referenced classes. Because of this, the Javadoc tool must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes. For more about this, see -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html. Generally speaking, classes you create must either be loaded as an extension or in the Javadoc tool's class path. -.SS -Javadoc Doclets -.LP -You can customize the content and format of the Javadoc tool's output by using doclets. The Javadoc tool has a default "built\-in" doclet, called the standard doclet, that generates HTML\-formatted API documentation. You can modify or subclass the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you'd like. Information about doclets and their use is at the following locations: -.RS 3 -.TP 2 -o -.na -\f2Javadoc Doclets\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html -.TP 2 -o -The \f2\-doclet\fP command\-line option -.RE -.LP -When a custom doclet is not specified with the \f2\-doclet\fP command line option, the Javadoc tool will use the default standard doclet. The javadoc tool has several command line options that are available regardless of which doclet is being used. The standard doclet adds a supplementary set of command line options. Both sets of options are described below in the options section. -.SS -Related Documentation and Doclets -.RS 3 -.TP 2 -o -.na -\f2Javadoc Enhancements\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html for details about improvements added in Javadoc. -.TP 2 -o -.na -\f2Javadoc FAQ\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html for answers to common questions, information about Javadoc\-related tools, and workarounds for bugs. -.TP 2 -o -.na -\f2How to Write Doc Comments for Javadoc\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html for more information about Sun conventions for writing documentation comments. -.TP 2 -o -.na -\f2Requirements for Writing API Specifications\fP @ -.fi -http://java.sun.com/j2se/javadoc/writingapispecs/index.html \- Standard requirements used when writing the Java SE Platform Specification. It can be useful whether you are writing API specifications in source file documentation comments or in other formats. It covers requirements for packages, classes, interfaces, fields and methods to satisfy testable assertions. -.TP 2 -o -.na -\f2Documentation Comment Specification\fP @ -.fi -http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html \- The original specification on documentation comments, Chapter 18, Documentation Comments, in the \f2Java Language Specification\fP, First Edition, by James Gosling, Bill Joy, and Guy Steele. (This chapter was removed from the second edition.) -.TP 2 -o -.na -\f2DocCheck Doclet\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-141437.html \- Checks doc comments in source files and generates a report listing the errors and irregularities it finds. It is part of the Doc Check Utilities. -.TP 2 -o -.na -\f2MIF Doclet\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/ \- Can automate the generation of API documentation in MIF, FrameMaker and PDF formats. MIF is Adobe FrameMaker's interchange format. -.RE -.SS -Terminology -.LP -The terms \f2documentation comment\fP, \f2doc comment\fP, \f2main description\fP, \f2tag\fP, \f2block tag\fP, and \f2in\-line tag\fP are described at Documentation Comments. These other terms have specific meanings within the context of the Javadoc tool: -.RS 3 -.TP 3 -generated document -The document generated by the javadoc tool from the doc comments in Java source code. The default generated document is in HTML and is created by the standard doclet. -.LP -.TP 3 -name -A name of a program element written in the Java Language \-\- that is, the name of a package, class, interface, field, constructor or method. A name can be fully\-qualified, such as \f2java.lang.String.equals(java.lang.Object)\fP, or partially\-qualified, such as \f2equals(Object)\fP. -.LP -.TP 3 -documented classes -The classes and interfaces for which detailed documentation is generated during a javadoc run. To be documented, the source files must be available, their source filenames or package names must be passed into the javadoc command, and they must not be filtered out by their access modifier (public, protected, package\-private or private). We also refer to these as the classes included in the javadoc output, or the \f2included classes\fP. -.LP -.TP 3 -included classes -Classes and interfaces whose details are documented during a run of the Javadoc tool. Same as \f2documented classes\fP. -.LP -.TP 3 -excluded classes -Classes and interfaces whose details are \f2not\fP documented during a run of the Javadoc tool. -.LP -.TP 3 -referenced classes -The classes and interfaces that are explicitly referred to in the definition (implementation) or doc comments of the documented classes and interfaces. Examples of references include return type, parameter type, cast type, extended class, implemented interface, imported classes, classes used in method bodies, @see, {@link}, {@linkplain}, and {@inheritDoc} tags. (Notice this definition has changed since -.na -\f21.3\fP @ -.fi -http://download.oracle.com/javase/1.3/docs/tooldocs/solaris/javadoc.html#referencedclasses.) When the Javadoc tool is run, it should load into memory all of the referenced classes in javadoc's bootclasspath and classpath. (The Javadoc tool prints a "Class not found" warning for referenced classes not found.) The Javadoc tool can derive enough information from the .class files to determine their existence and the fully\-qualified names of their members. -.LP -.TP 3 -external referenced classes -The referenced classes whose documentation is not being generated during a javadoc run. In other words, these classes are not passed into the Javadoc tool on the command line. Links in the generated documentation to those classes are said to be \f2external references\fP or \f2external links\fP. For example, if you run the Javadoc tool on only the \f2java.awt\fP package, then any class in \f2java.lang\fP, such as \f2Object\fP, is an external referenced class. External referenced classes can be linked to using the \f2\-link\fP and \f2\-linkoffline\fP options. An important property of an external referenced class is that its source comments are normally not available to the Javadoc run. In this case, these comments cannot be inherited. -.RE -.SH "SOURCE FILES" -.LP -The Javadoc tool will generate output originating from four different types of "source" files: Java language source files for classes (\f2.java\fP), package comment files, overview comment files, and miscellaneous unprocessed files. This section also covers test files and template files that can also be in the source tree, but which you want to be sure not to document. -.SS -Class Source Code Files -.LP -Each class or interface and its members can have their own documentation comments, contained in a \f2.java\fP file. For more details about these doc comments, see Documentation Comments. -.SS -Package Comment Files -.LP -Each package can have its own documentation comment, contained in its own "source" file, that the Javadoc tool will merge into the package summary page that it generates. You typically include in this comment any documentation that applies to the entire package. -.LP -To create a package comment file, you have a choice of two files to place your comments: -.RS 3 -.TP 2 -o -\f2package\-info.java\fP \- Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is generally preferred over package.html. -.TP 2 -o -\f2package.html\fP \- Can contain only package comments and Javadoc tags, no package annotations. -.RE -.LP -A package may have a single \f2package.html\fP file or a single \f2package\-info.java\fP file but not both. Place either file in the package directory in the source tree along with your \f2.java\fP files. -.LP -\f4package\-info.java\fP \- This file can contain a package comment of the following structure \-\- the comment is placed before the package declaration: -.LP -File: \f2java/applet/package\-info.java\fP -.nf -\f3 -.fl -/** -.fl - * Provides the classes necessary to create an -.fl - * applet and the classes an applet uses -.fl - * to communicate with its applet context. -.fl - * <p> -.fl - * The applet framework involves two entities: -.fl - * the applet and the applet context. -.fl - * An applet is an embeddable window (see the -.fl - * {@link java.awt.Panel} class) with a few extra -.fl - * methods that the applet context can use to -.fl - * initialize, start, and stop the applet. -.fl - * -.fl - * @since 1.0 -.fl - * @see java.awt -.fl - */ -.fl -package java.lang.applet; -.fl -\fP -.fi -.LP -Note that while the comment separators \f2/**\fP and \f2/*\fP must be present, the leading asterisks on the intermediate lines can be omitted. -.LP -\f4package.html\fP \- This file can contain a package comment of the following structure \-\- the comment is placed in the \f2<body>\fP element: -.LP -File: \f2java/applet/package.html\fP -.nf -\f3 -.fl -<HTML> -.fl -<BODY> -.fl -Provides the classes necessary to create an applet and the -.fl -classes an applet uses to communicate with its applet context. -.fl -<p> -.fl -The applet framework involves two entities: the applet -.fl -and the applet context. An applet is an embeddable -.fl -window (see the {@link java.awt.Panel} class) with a -.fl -few extra methods that the applet context can use to -.fl -initialize, start, and stop the applet. -.fl +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 10 May 2011 +.\" SectDesc: Basic Tools +.\" Title: javadoc.1 +.\" +.if n .pl 99999 +.TH javadoc 1 "10 May 2011" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.fl -@since 1.0 -.fl -@see java.awt -.fl -</BODY> -.fl -</HTML> -.fl -\fP -.fi -.LP -Notice this is just a normal HTML file and does not include a package declaration. The content of the package comment file is written in HTML, like all other comments, with one exception: The documentation comment should not include the comment separators \f2/**\fP and \f2*/\fP or leading asterisks. When writing the comment, you should make the first sentence a summary about the package, and not put a title or any other text between \f2<body>\fP and the first sentence. You can include package tags; as with any documentation comment, all block tags must appear after the main description. If you add a \f2@see\fP tag in a package comment file, it must have a fully\-qualified name. For more details, see the -.na -\f2example of \fP\f2package.html\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#packagecomments. -.LP -\f3Processing of package comment file\fP \- When the Javadoc tool runs, it will automatically look for the package comment file; if found, the Javadoc tool does the following: -.RS 3 -.TP 2 -o -Copies the comment for processing. (For \f2package.html\fP, copies all content between \f2<body>\fP and \f2</body>\fP HTML tags. You can include a \f2<head>\fP section to put a \f2<title>\fP, source file copyright statement, or other information, but none of these will appear in the generated documentation.) -.TP 2 -o -Processes any package tags that are present. -.TP 2 -o -Inserts the processed text at the bottom of the package summary page it generates, as shown in -.na -\f2Package Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/applet/package\-summary.html. -.TP 2 -o -Copies the first sentence of the package comment to the top of the package summary page. It also adds the package name and this first sentence to the list of packages on the overview page, as shown in -.na -\f2Overview Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/overview\-summary.html. The end\-of\-sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions. -.RE -.SS -Overview Comment File -.LP -Each application or set of packages that you are documenting can have its own overview documentation comment, kept in its own "source" file, that the Javadoc tool will merge into the overview page that it generates. You typically include in this comment any documentation that applies to the entire application or set of packages. -.LP -To create an overview comment file, you can name the file anything you want, typically \f4overview.html\fP and place it anywhere, typically at the top level of the source tree. For example, if the source files for the \f2java.applet\fP package are contained in \f2/home/user/src/java/applet\fP directory, you could create an overview comment file at \f2/home/user/src/overview.html\fP. -.LP -Notice you can have multiple overview comment files for the same set of source files, in case you want to run javadoc multiple times on different sets of packages. For example, you could run javadoc once with \-private for internal documentation and again without that option for public documentation. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file. -.LP -The content of the overview comment file is one big documentation comment, written in HTML, like the package comment file described previously. See that description for details. To re\-iterate, when writing the comment, you should make the first sentence a summary about the application or set of packages, and not put a title or any other text between \f2<body>\fP and the first sentence. You can include overview tags; as with any documentation comment, all tags except in\-line tags, such as \f2{@link}\fP, must appear after the main description. If you add a \f2@see\fP tag, it must have a fully\-qualified name. -.LP -When you run the Javadoc tool, you specify the overview comment file name with the \-overview option. The file is then processed similar to that of a package comment file. -.RS 3 -.TP 2 -o -Copies all content between \f2<body>\fP and \f2</body>\fP tags for processing. -.TP 2 -o -Processes any overview tags that are present. -.TP 2 -o -Inserts the processed text at the bottom of the overview page it generates, as shown in -.na -\f2Overview Summary\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/overview\-summary.html. -.TP 2 -o -Copies the first sentence of the overview comment to the top of the overview summary page. -.RE -.SS -Miscellaneous Unprocessed Files -.LP -You can also include in your source any miscellaneous files that you want the Javadoc tool to copy to the destination directory. These typically includes graphic files, example Java source (.java) and class (.class) files, and self\-standing HTML files whose content would overwhelm the documentation comment of a normal Java source file. -.LP -To include unprocessed files, put them in a directory called \f4doc\-files\fP which can be a subdirectory of any package directory that contains source files. You can have one such subdirectory for each package. You might include images, example code, source files, .class files, applets and HTML files. For example, if you want to include the image of a button \f2button.gif\fP in the \f2java.awt.Button\fP class documentation, you place that file in the \f2/home/user/src/java/awt/doc\-files/\fP directory. Notice the \f2doc\-files\fP directory should not be located at \f2/home/user/src/java/doc\-files\fP because \f2java\fP is not a package \-\- that is, it does not directly contain any source files. -.LP -All links to these unprocessed files must be hard\-coded, because the Javadoc tool does not look at the files \-\- it simply copies the directory and all its contents to the destination. For example, the link in the \f2Button.java\fP doc comment might look like: -.nf -\f3 -.fl - /** -.fl - * This button looks like this: -.fl - * <img src="doc\-files/Button.gif"> -.fl - */ -.fl -\fP -.fi -.SS -Test Files and Template Files -.LP -Some developers have indicated they want to store test files and templates files in the source tree near their corresponding source files. That is, they would like to put them in the same directory, or a subdirectory, of those source files. -.LP -If you run the Javadoc tool by explicitly passing in individual source filenames, you can deliberately omit test and templates files and prevent them from being processed. However, if you are passing in package names or wildcards, you need to follow certain rules to ensure these test files and templates files are not processed. -.LP -Test files differ from template files in that the former are legal, compilable source files, while the latter are not, but may end with ".java". -.LP -\f3Test files\fP \- Often developers want to put compilable, runnable test files for a given package in the \f2same\fP directory as the source files for that package. But they want the test files to belong to a package other than the source file package, such as the unnamed package (so the test files have no package statement or a different package statement from the source). In this scenario, when the source is being documented by specifying its package name specified on the command line, the test files will cause warnings or errors. You need to put such test files in a subdirectory. For example, if you want to add test files for source files in \f2com.package1\fP, put them in a subdirectory that would be an invalid package name (because it contains a hyphen): -.nf -\f3 -.fl - com/package1/test\-files/ -.fl -\fP -.fi -.LP -The test directory will be skipped by the Javadoc tool with no warnings. -.LP -If your test files contain doc comments, you can set up a separate run of the Javadoc tool to produce documentation of the test files by passing in their test source filenames with wildcards, such as \f2com/package1/test\-files/*.java\fP. -.LP -\f3Templates for source files\fP \- Template files have names that often end in ".java" and are not compilable. If you have a template for a source file that you want to keep in the source directory, you can name it with a dash (such as \f2Buffer\-Template.java\fP), or any other illegal Java character, to prevent it from being processed. This relies on the fact that the Javadoc tool will only process source files whose name, when stripped of the ".java" suffix, is actually a legal class name (see information about Identifiers in the Java Language Specification). -.SH "GENERATED FILES" -.LP -By default, javadoc uses a standard doclet that generates HTML\-formatted documentation. This doclet generates the following kinds of files (where each HTML "page" corresponds to a separate file). Note that javadoc generates files with two types of names: those named after classes/interfaces, and those that are not (such as \f2package\-summary.html\fP). Files in the latter group contain hyphens to prevent filename conflicts with those in the former group. -.LP -\f3Basic Content Pages\fP -.RS 3 -.TP 2 -o -One \f3class or interface page\fP (\f2classname\fP\f2.html\fP) for each class or interface it is documenting. -.TP 2 -o -One \f3package page\fP (\f2package\-summary.html\fP) for each package it is documenting. The Javadoc tool will include any HTML text provided in a file named \f2package.html\fP or \f2package\-info.java\fP in the package directory of the source tree. -.TP 2 -o -One \f3overview page\fP (\f2overview\-summary.html\fP) for the entire set of packages. This is the front page of the generated document. The Javadoc tool will include any HTML text provided in a file specified with the \f2\-overview\fP option. Note that this file is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) -.RE -.LP -\f3Cross\-Reference Pages\fP -.RS 3 -.TP 2 -o -One \f3class hierarchy page for the entire set of packages\fP (\f2overview\-tree.html\fP). To view this, click on "Overview" in the navigation bar, then click on "Tree". -.TP 2 -o -One \f3class hierarchy page for each package\fP (\f2package\-tree.html\fP) To view this, go to a particular package, class or interface page; click "Tree" to display the hierarchy for that package. -.TP 2 -o -One \f3"use" page\fP for each package (\f2package\-use.html\fP) and a separate one for each class and interface (\f2class\-use/\fP\f2classname\fP\f2.html\fP). This page describes what packages, classes, methods, constructors and fields use any part of the given class, interface or package. Given a class or interface A, its "use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar. -.TP 2 -o -A \f3deprecated API page\fP (\f2deprecated\-list.html\fP) listing all deprecated names. (A deprecated name is not recommended for use, generally due to improvements, and a replacement name is usually given. Deprecated APIs may be removed in future implementations.) -.TP 2 -o -A \f3constant field values page\fP (\f2constant\-values.html\fP) for the values of static fields. -.TP 2 -o -A \f3serialized form page\fP (\f2serialized\-form.html\fP) for information about serializable and externalizable classes. Each such class has a description of its serialization fields and methods. This information is of interest to re\-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class comment. The standard doclet automatically generates a serialized form page: any class (public or non\-public) that implements Serializable is included, along with \f2readObject\fP and \f2writeObject\fP methods, the fields that are serialized, and the doc comments from the \f2@serial\fP, \f2@serialField\fP, and \f2@serialData\fP tags. Public serializable classes can be excluded by marking them (or their package) with \f2@serial exclude\fP, and package\-private serializable classes can be included by marking them (or their package) with \f2@serial include\fP. As of 1.4, you can generate the complete serialized form for public and private classes by running javadoc \f2without\fP specifying the \f2\-private\fP option. -.TP 2 -o -An \f3index\fP (\f2index\-*.html\fP) of all class, interface, constructor, field and method names, alphabetically arranged. This is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\-Z for English). -.RE -.LP -\f3Support Files\fP -.RS 3 -.TP 2 -o -A \f3help page\fP (\f2help\-doc.html\fP) that describes the navigation bar and the above pages. You can provide your own custom help file to override the default using \f2\-helpfile\fP. -.TP 2 -o -One \f3index.html file\fP which creates the HTML frames for display. This is the file you load to display the front page with frames. This file itself contains no text content. -.TP 2 -o -Several \f3frame files\fP (\f2*\-frame.html\fP) containing lists of packages, classes and interfaces, used when HTML frames are being displayed. -.TP 2 -o -A \f3package list\fP file (\f2package\-list\fP), used by the \f2\-link\fP and \f2\-linkoffline\fP options. This is a text file, not HTML, and is not reachable through any links. -.TP 2 -o -A \f3style sheet\fP file (\f2stylesheet.css\fP) that controls a limited amount of color, font family, font size, font style and positioning on the generated pages. -.TP 2 -o -A \f3doc\-files\fP directory that holds any image, example, source code or other files that you want copied to the destination directory. These files are not processed by the Javadoc tool in any manner \-\- that is, any javadoc tags in them will be ignored. This directory is not generated unless it exists in the source tree. -.RE -.LP -\f3HTML Frames\fP -.LP -The Javadoc tool will generate either two or three HTML frames, as shown in the figure below. It creates the minimum necessary number of frames by omitting the list of packages if there is only one package (or no packages). That is, when you pass a single package name or source files (*.java) belonging to a single package as arguments into the javadoc command, it will create only one frame (C) in the left\-hand column \-\- the list of classes. When you pass into javadoc two or more package names, it creates a third frame (P) listing all packages, as well as an overview page (Detail). This overview page has the filename \f2overview\-summary.html\fP. Thus, this file is created only if you pass in two or more package names. You can bypass frames by clicking on the "No Frames" link or entering at overview\-summary.html. -.LP -If you are unfamiliar with HTML frames, you should be aware that frames can have \f2focus\fP for printing and scrolling. To give a frame focus, click on it. Then on many browsers the arrow keys and page keys will scroll that frame, and the print menu command will print it. -.LP -Load one of the following two files as the starting page depending on whether you want HTML frames or not: -.RS 3 -.TP 2 -o -\f2index.html\fP (for frames) -.TP 2 -o -\f2overview\-summary.html\fP (for no frames) -.RE -.LP -\f3Generated File Structure\fP -.LP -The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized. This structure is one directory per subpackage. -.LP -For example, the document generated for the class \f2java.applet.Applet\fP class would be located at \f2java/applet/Applet.html\fP. The file structure for the java.applet package follows, given that the destination directory is named \f2apidocs\fP. All files that contain the word "frame" appear in the upper\-left or lower\-left frames, as noted. All other HTML files appear in the right\-hand frame. -.LP -NOTE \- Directories are shown in \f3bold\fP. The asterisks (\f2*\fP) indicate the files and directories that are \f2omitted\fP when the arguments to javadoc are source filenames (*.java) rather than package names. Also when arguments are source filenames, \f2package\-list\fP is created but is empty. The doc\-files directory will not be created in the destination unless it exists in the source tree. -.nf -\f3 -.fl +.SH NAME +javadoc \- Generates HTML pages of API documentation from Java source files\&. +.SH SYNOPSIS +.sp +.nf -.fl -\fP\f3apidocs\fP Top directory -.fl - index.html Initial page that sets up HTML frames -.fl - * overview\-summary.html Lists all packages with first sentence summaries -.fl - overview\-tree.html Lists class hierarchy for all packages -.fl - deprecated\-list.html Lists deprecated API for all packages -.fl - constant\-values.html Lists values of static fields for all packages -.fl - serialized\-form.html Lists serialized form for all packages -.fl - * overview\-frame.html Lists all packages, used in upper\-left frame -.fl - allclasses\-frame.html Lists all classes for all packages, used in lower\-left frame -.fl - help\-doc.html Lists user help for how these pages are organized -.fl - index\-all.html Default index created without \-splitindex option -.fl - \f3index\-files\fP Directory created with \-splitindex option -.fl - index\-<number>.html Index files created with \-splitindex option -.fl - package\-list Lists package names, used only for resolving external refs -.fl - stylesheet.css HTML style sheet for defining fonts, colors and positions -.fl - \f3java\fP Package directory -.fl - \f3applet\fP Subpackage directory -.fl - Applet.html Page for Applet class -.fl - AppletContext.html Page for AppletContext interface -.fl - AppletStub.html Page for AppletStub interface -.fl - AudioClip.html Page for AudioClip interface -.fl - * package\-summary.html Lists classes with first sentence summaries for this package -.fl - * package\-frame.html Lists classes in this package, used in lower left\-hand frame -.fl - * package\-tree.html Lists class hierarchy for this package -.fl - package\-use Lists where this package is used -.fl - \f3doc\-files\fP Directory holding image and example files -.fl - \f3class\-use\fP Directory holding pages API is used -.fl - Applet.html Page for uses of Applet class -.fl - AppletContext.html Page for uses of AppletContext interface -.fl - AppletStub.html Page for uses of AppletStub interface -.fl - AudioClip.html Page for uses of AudioClip interface -.fl - \f3src\-html\fP Source code directory -.fl - \f3java\fP Package directory -.fl - \f3applet\fP Subpackage directory -.fl - Applet.html Page for Applet source code -.fl - AppletContext.html Page for AppletContext source code -.fl - AppletStub.html Page for AppletStub source code -.fl - AudioClip.html Page for AudioClip source code -.fl -.fi -.SS -Generated API Declarations -.LP -The Javadoc tool generates a declaration at the start of each class, interface, field, constructor, and method description for that API item. For example, the declaration for the \f2Boolean\fP class is: -.LP -\f2public final class Boolean\fP -.br -\f2extends Object\fP -.br -\f2implements Serializable\fP -.LP -and the declaration for the \f2Boolean.valueOf\fPmethod is: -.LP -\f2public static Boolean valueOf(String s)\fP -.LP -The Javadoc tool can include the modifiers \f2public\fP, \f2protected\fP, \f2private\fP, \f2abstract\fP, \f2final\fP, \f2static\fP, \f2transient\fP, and \f2volatile\fP, but not \f2synchronized\fP or \f2native\fP. These last two modifiers are considered implementation detail and not part of the API specification. -.LP -Rather than relying on the keyword \f2synchronized\fP, APIs should document their concurrency semantics in the comment's main description, as in "a single \f2Enumeration\fP cannot be used by multiple threads concurrently". The document should not describe how to achieve these semantics. As another example, while \f2Hashtable\fP should be thread\-safe, there's no reason to specify that we achieve this by synchronizing all of its exported methods. We should reserve the right to synchronize internally at the bucket level, thus offering higher concurrency. -.SH "DOCUMENTATION COMMENTS" -.LP -The original "Documentation Comment Specification" can be found under related documentation. -.SS -Commenting the Source Code -.LP -You can include \f2documentation comments\fP ("doc comments") in the source code, ahead of declarations for any class, interface, method, constructor, or field. You can also create doc comments for each package and another one for the overview, though their syntax is slightly different. Doc comments are also known informally as "Javadoc comments" (but this term violates its trademark usage). A doc comment consists of the characters between the characters \f2/**\fP that begin the comment and the characters \f2*/\fP that end it. Leading asterisks are allowed on each line and are described further below. The text in a comment can continue onto multiple lines. -.nf -\f3 -.fl -/** -.fl - * This is the typical format of a simple documentation comment -.fl - * that spans two lines. -.fl - */ -.fl -\fP -.fi -.LP +\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR] +.fi +.sp +.TP +\fIpackages\fR +Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&. + +By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&. +.TP +\fIsource-files\fR +Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&. +.TP +\fIoptions\fR +Command-line options, separated by spaces\&. See Options\&. +.TP +\fI@argfiles\fR +Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&. +.SH DESCRIPTION +The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&. +.PP +You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&. +.SS PROCESS\ SOURCE\ FILES +The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements: +.TP 0.2i +\(bu +The file name prefix (with \f3\&.java\fR removed) is a valid class name\&. +.TP 0.2i +\(bu +The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&. +.TP 0.2i +\(bu +The package statement contains the valid package name\&. +.PP +Processing Links + +During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&. +.TP 0.2i +\(bu +Declarations (return types, argument types, and field types)\&. +.TP 0.2i +\(bu +\fISee Also\fR sections that are generated from \f3@see\fR tags\&. +.TP 0.2i +\(bu +Inline text generated from \f3{@link}\fR tags\&. +.TP 0.2i +\(bu +Exception names generated from \f3@throws\fR tags\&. +.TP 0.2i +\(bu +\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&. +.TP 0.2i +\(bu +Summary tables listing packages, classes and members\&. +.TP 0.2i +\(bu +Package and class inheritance trees\&. +.TP 0.2i +\(bu +The index\&. +.PP +You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&. +.PP +Processing Details + +The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&. +.PP +The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&. +.PP +The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&. +.PP +Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&. +.PP +In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&. +.PP +When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.PP +Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&. +.SS JAVADOC\ DOCLETS +You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&. +.PP +When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&. +.SH SOURCE\ FILES +The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&. +.SS CLASS\ SOURCE\ FILES +Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&. +.SS PACKAGE\ COMMENT\ FILES +Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&. +.PP +To create a package comment file, you can place your comments in one of the following files: +.TP 0.2i +\(bu +The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&. +.TP 0.2i +\(bu +The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&. +.PP +A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&. +.PP +The package-info\&.java File + +The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&. +.PP +\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Provides the classes necessary to create an \fP +.fi +.nf +\f3 * applet and the classes an applet uses \fP +.fi +.nf +\f3 * to communicate with its applet context\&.\fP +.fi +.nf +\f3 * <p>\fP +.fi +.nf +\f3 * The applet framework involves two entities:\fP +.fi +.nf +\f3 * the applet and the applet context\&.\fP +.fi +.nf +\f3 * An applet is an embeddable window (see the\fP +.fi +.nf +\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP +.fi +.nf +\f3 * methods that the applet context can use to \fP +.fi +.nf +\f3 * initialize, start, and stop the applet\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @since 1\&.0\fP +.fi +.nf +\f3 * @see java\&.awt\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3package java\&.lang\&.applet;\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +The package\&.html File + +The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&. +.PP +File: \f3java/applet/package\&.html\fR +.sp +.nf +\f3<HTML>\fP +.fi +.nf +\f3<BODY>\fP +.fi +.nf +\f3Provides the classes necessary to create an applet and the \fP +.fi +.nf +\f3classes an applet uses to communicate with its applet context\&.\fP +.fi +.nf +\f3<p>\fP +.fi +.nf +\f3The applet framework involves two entities: the applet\fP +.fi +.nf +\f3and the applet context\&. An applet is an embeddable\fP +.fi +.nf +\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP +.fi +.nf +\f3few extra methods that the applet context can use to\fP +.fi +.nf +\f3initialize, start, and stop the applet\&. \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3@since 1\&.0 \fP +.fi +.nf +\f3@see java\&.awt\fP +.fi +.nf +\f3</BODY>\fP +.fi +.nf +\f3</HTML>\fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&. +.PP +Processing the Comment File + +When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&. +.TP 0.2i +\(bu +Processes the package tags\&. See Package Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html + +The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&. +.SS OVERVIEW\ COMMENT\ FILES +Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&. +.PP +You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&. +.PP +For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&. +.PP +You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&. +.PP +The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&. +.PP +When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following: +.TP 0.2i +\(bu +Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&. +.TP 0.2i +\(bu +Processes the overview tags that are present\&. See Overview Tags\&. +.TP 0.2i +\(bu +Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html +.TP 0.2i +\(bu +Copies the first sentence of the overview comment to the top of the overview summary page\&. +.SS UNPROCESSED\ FILES +Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&. +.PP +To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&. +.PP +For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&. +.PP +All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This button looks like this: \fP +.fi +.nf +\f3 * <img src="doc\-files/Button\&.gif">\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS TEST\ AND\ TEMPLATE\ FILES +You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&. +.PP +Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&. +.PP +Test Files + +If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen: +.sp +.nf +\f3com/package1/test\-files/\fP +.fi +.nf +\f3\fR +.fi +.sp +If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&. +.PP +Template Files + +If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&. +.SH GENERATED\ FILES +By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&. +.SS BASIC\ CONTENT\ PAGES +.TP 0.2i +\(bu +One class or interface page (classname\&.html) for each class or interface being documented\&. +.TP 0.2i +\(bu +One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&. +.TP 0.2i +\(bu +One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&. +.SS CROSS-REFERENCE\ PAGES +.TP 0.2i +\(bu +One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&. +.TP 0.2i +\(bu +One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&. +.TP 0.2i +\(bu +One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&. +.TP 0.2i +\(bu +A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&. +.TP 0.2i +\(bu +A constant field values page (constant-values\&.html) for the values of static fields\&. +.TP 0.2i +\(bu +A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&. +.TP 0.2i +\(bu +An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&. +.SS SUPPORT\ PAGES +.TP 0.2i +\(bu +A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&. +.TP 0.2i +\(bu +One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&. +.TP 0.2i +\(bu +Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&. +.TP 0.2i +\(bu +A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&. +.TP 0.2i +\(bu +A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&. +.TP 0.2i +\(bu +A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&. +.PP +See Options\&. +.SS HTML\ FRAMES +The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&. +.SS GENERATED\ FILE\ STRUCTURE +The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&. +.PP +For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&. +.PP +The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&. +.PP +Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&. +.TP 0.2i +\(bu +\fIapidocs\fR: Top-level directory +.RS +.TP 0.2i +\(bu +index\&.html: Initial Page that sets up HTML frames +.TP 0.2i +\(bu +*overview-summary\&.html: Package list with summaries +.TP 0.2i +\(bu +overview-tree\&.html: Class hierarchy for all packages +.TP 0.2i +\(bu +deprecated-list\&.html: Deprecated APIs for all packages +.TP 0.2i +\(bu +constant-values\&.html: Static field values for all packages +.TP 0.2i +\(bu +serialized-form\&.html: Serialized forms for all packages +.TP 0.2i +\(bu +*overview-frame\&.html: All packages for display in upper-left frame +.TP 0.2i +\(bu +allclasses-frame\&.html: All classes for display in lower-left frame +.TP 0.2i +\(bu +help-doc\&.html: Help about Javadoc page organization +.TP 0.2i +\(bu +index-all\&.html: Default index created without \f3-splitindex\fR option +.TP 0.2i +\(bu +\fIindex-files\fR: Directory created with \f3-splitindex\fR option +.RS +.TP 0.2i +\(bu +index-<number>\&.html: Index files created with \f3-splitindex\fR option +.RE + +.TP 0.2i +\(bu +package-list: Package names for resolving external references +.TP 0.2i +\(bu +stylesheet\&.css: Defines fonts, colors, positions, and so on +.RE + +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory +.RS +.TP 0.2i +\(bu +Applet\&.html: \f3Applet\fR class page +.TP 0.2i +\(bu +AppletContext\&.html: \f3AppletContext\fR interface +.TP 0.2i +\(bu +AppletStub\&.html: \f3AppletStub\fR interface +.TP 0.2i +\(bu +AudioClip\&.html: \f3AudioClip\fR interface +.TP 0.2i +\(bu +package-summary\&.html: Classes with summaries +.TP 0.2i +\(bu +package-frame\&.html: Package classes for display in lower-left frame +.TP 0.2i +\(bu +package-tree\&.html: Class hierarchy for this package +.TP 0.2i +\(bu +package-use\&.html: Where this package is used +.TP 0.2i +\(bu +\fIdoc-files\fR: Image and example files directory +.TP 0.2i +\(bu +\fIclass-use\fR: Image and examples file location + +- Applet\&.html: Uses of the Applet class + +- AppletContext\&.html: Uses of the \f3AppletContext\fR interface + +- AppletStub\&.html: Uses of the \f3AppletStub\fR interface + +- AudioClip\&.html: Uses of the \f3AudioClip\fR interface +.RE + +.RE + +.TP 0.2i +\(bu +\fIsrc-html\fR: Source code directory +.RS +.TP 0.2i +\(bu +\fIjava\fR: Package directory +.RS +.TP 0.2i +\(bu +\fIapplet\fR: Subpackage directory + +- Applet\&.html: Applet source code + +- AppletContext\&.html: \f3AppletContext\fR source code + +- AppletStub\&.html: \f3AppletStub\fR source code + +- AudioClip\&.html: \f3AudioClip\fR source code +.RE + +.RE + +.SS GENERATED\ API\ DECLARATIONS +The \f3javadoc\fR command generates a declaration at the start of each class, interface, field, constructor, and method description for that API item\&. For example, the declaration for the \f3Boolean\fR class is: +.sp +.nf +\f3public final class Boolean\fP +.fi +.nf +\f3extends Object\fP +.fi +.nf +\f3implements Serializable\fP +.fi +.nf +\f3\fR +.fi +.sp +The declaration for the \f3Boolean\&.valueOf\fR method is: +.sp +.nf +\f3public static Boolean valueOf(String s)\fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3javadoc\fR command can include the modifiers \f3public\fR, \f3protected\fR, \f3private\fR, \f3abstract\fR, \f3final\fR, \f3static\fR, \f3transient\fR, and \f3volatile\fR, but not \f3synchronized\fR or \f3native\fR\&. The \f3synchronized\fR and \f3native\fR modifiers are considered implementation detail and not part of the API specification\&. +.PP +Rather than relying on the keyword \f3synchronized\fR, APIs should document their concurrency semantics in the main description of the comment\&. For example, a description might be: A single enumeration cannot be used by multiple threads concurrently\&. The document should not describe how to achieve these semantics\&. As another example, while the \f3Hashtable\fR option should be thread-safe, there is no reason to specify that it is achieved by synchronizing all of its exported methods\&. It is better to reserve the right to synchronize internally at the bucket level for higher concurrency\&. +.SH DOCUMENTATION\ COMMENTS +This section describes source code comments and comment inheritance\&. +.SS SOURCE\ CODE\ COMMENTS +You can include documentation comments in the source code, ahead of declarations for any class, interface, method, constructor, or field\&. You can also create documentation comments for each package and another one for the overview, though their syntax is slightly different\&. A documentation comment consists of the characters between \f3/**\fR and \f3*/\fR that end it\&. Leading asterisks are allowed on each line and are described further in the following section\&. The text in a comment can continue onto multiple lines\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the typical format of a simple documentation comment\fP +.fi +.nf +\f3 * that spans two lines\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp To save space you can put a comment on one line: -.nf -\f3 -.fl -/** This comment takes up only one line. */ -.fl -\fP -.fi -.LP -\f3Placement of comments\fP \- Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations \-\- see the class example, method example, and field example. Documentation comments placed in the body of a method are ignored. Only one documentation comment per declaration statement is recognized by the Javadoc tool. -.LP -A common mistake is to put an \f2import\fP statement between the class comment and the class declaration. Avoid this, as the Javadoc tool will ignore the class comment. -.nf -\f3 -.fl - /** -.fl - * This is the class comment for the class Whatever. -.fl - */ -.fl +.sp +.nf +\f3/** This comment takes up only one line\&. */\fP +.fi +.nf +\f3\fR +.fi +.sp -.fl - import com.sun; // MISTAKE \- Important not to put import statement here -.fl +.PP +Placement of Comments -.fl - public class Whatever { -.fl - } -.fl -\fP -.fi -.LP -\f3A doc comment is composed of a \fP\f4main description\fP\f3 followed by a \fP\f4tag section\fP \- The \f2main description\fP begins after the starting delimiter \f2/**\fP and continues until the tag section. The \f2tag section\fP starts with the first block tag, which is defined by the first \f2@\fP character that begins a line (ignoring leading asterisks, white space, and leading separator \f2/**\fP). It is possible to have a comment with only a tag section and no main description. The main description cannot continue after the tag section begins. The argument to a tag can span multiple lines. There can be any number of tags \-\- some types of tags can be repeated while others cannot. For example, this \f2@see\fP starts the tag section: -.nf -\f3 -.fl -/** -.fl - * This sentence would hold the main description for this doc comment. -.fl - * @see java.lang.Object -.fl - */ -.fl -\fP -.fi -.LP -\f3Block tags and in\-line tags\fP \- A \f2tag\fP is a special keyword within a doc comment that the Javadoc tool can process. There are two kinds of tags: block tags, which appear as \f2@tag\fP (also known as "standalone tags"), and in\-line tags, which appear within curly braces, as \f2{@tag}\fP. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and separator (\f2/**\fP). This means you can use the \f2@\fP character elsewhere in the text and it will not be interpreted as the start of a tag. If you want to start a line with the \f2@\fP character and not have it be interpreted, use the HTML entity \f2@\fP. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the doc comment. This associated text can span multiple lines. An in\-line tag is allowed and interpreted anywhere that text is allowed. The following example contains the block tag \f2@deprecated\fP and in\-line tag \f2{@link}\fP. -.nf -\f3 -.fl -/** -.fl - * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} -.fl - */ -.fl -\fP -.fi -.LP -\f3Comments are written in HTML\fP \- The text must be written in HTML, in that they should use HTML entities and can use HTML tags. You can use whichever version of HTML your browser supports; we have written the standard doclet to generate HTML 3.2\-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames. (We preface each generated file with "HTML 4.0" because of the frame sets.) -.LP -For example, entities for the less\-than (\f2<\fP) and greater\-than (\f2>\fP) symbols should be written \f2<\fP and \f2>\fP. Likewise, the ampersand (\f2&\fP) should be written \f2&\fP. The bold HTML tag \f2<b>\fP is shown in the following example. -.LP -Here is a doc comment: -.nf -\f3 -.fl -/** -.fl - * This is a <b>doc</b> comment. -.fl - * @see java.lang.Object -.fl - */ -.fl -\fP -.fi -.LP -\f3Leading asterisks\fP \- When javadoc parses a doc comment, leading asterisk (\f2*\fP) characters on each line are discarded; blanks and tabs preceding the initial asterisk (\f2*\fP) characters are also discarded. Starting with 1.4, if you omit the leading asterisk on a line, the leading white space is no longer removed. This enables you to paste code examples directly into a doc comment inside a \f2<PRE>\fP tag, and its indentation will be honored. Spaces are generally interpreted by browsers more uniformly than tabs. Indentation is relative to the left margin (rather than the separator \f2/**\fP or \f2<PRE>\fP tag). -.LP -\f3First sentence\fP \- The first sentence of each doc comment should be a summary sentence, containing a concise but complete description of the declared entity. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag. The Javadoc tool copies this first sentence to the member summary at the top of the HTML page. -.LP -\f3Declaration with multiple fields\fP \- Java allows declaring multiple fields in a single statement, but this statement can have only one documentation comment, which is copied for all fields. Therefore if you want individual documentation comments for each field, you must declare each field in a separate statement. For example, the following documentation comment doesn't make sense written as a single declaration and would be better handled as two declarations: -.nf -\f3 -.fl -/** -.fl - * The horizontal and vertical distances of point (x,y) -.fl - */ -.fl -public int x, y; // Avoid this -.fl -\fP -.fi -.LP -The Javadoc tool generates the following documentation from the above code: -.nf -\f3 -.fl -public int \fP\f3x\fP -.fl -.fi -.RS 3 -The horizontal and vertical distances of point (x,y) +Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations\&. Documentation comments placed in the body of a method are ignored\&. The \f3javadoc\fR command recognizes only one documentation comment per declaration statement\&. See Where Tags Can Be Used\&. +.PP +A common mistake is to put an \f3import\fR statement between the class comment and the class declaration\&. Do not put an \f3import\fR statement at this location because the \f3javadoc\fR command ignores the class comment\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is the class comment for the class Whatever\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3import com\&.example; // MISTAKE \- Important not to put import statement here\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3public class Whatever{ }\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Parts of Comments + +A documentation comment has a main description followed by a tag section\&. The main description begins after the starting delimiter \f3/**\fR and continues until the tag section\&. The tag section starts with the first block tag, which is defined by the first \f3@\fR character that begins a line (ignoring leading asterisks, white space, and leading separator \f3/**\fR)\&. It is possible to have a comment with only a tag section and no main description\&. The main description cannot continue after the tag section begins\&. The argument to a tag can span multiple lines\&. There can be any number of tags, and some types of tags can be repeated while others cannot\&. For example, this \f3@see\fR tag starts the tag section: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This sentence holds the main description for this documentation comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Block and inline Tags + +A tag is a special keyword within a documentation comment that the \f3javadoc\fR command processes\&. There are two kinds of tags: block tags, which appear as an \f3@tag\fR tag (also known as standalone tags), and inline tags, which appear within braces, as an \f3{@tag}\fR tag\&. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and the separator (\f3/**\fR)\&. This means you can use the \f3@\fR character elsewhere in the text and it will not be interpreted as the start of a tag\&. If you want to start a line with the \f3@\fR character and not have it be interpreted, then use the HTML entity \f3@\fR\&. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the documentation comment\&. This associated text can span multiple lines\&. An inline tag is allowed and interpreted anywhere that text is allowed\&. The following example contains the \f3@deprecated\fR block tag and the \f3{@link}\fR inline tag\&. See Javadoc Tags\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @deprecated As of JDK 1\&.1, replaced by {@link #setBounds(int,int,int,int)}\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Write Comments in HTML + +The text must be written in HTML with HTML entities and HTML tags\&. You can use whichever version of HTML your browser supports\&. The standard doclet generates HTML 3\&.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames\&. HTML 4\&.0 is preferred for generated files because of the frame sets\&. +.PP +For example, entities for the less than symbol (<) and the greater than symbol (>) should be written as \f3<\fR and \f3>\fR\&. Similarly, the ampersand (&) should be written as \f3&\fR\&. The bold HTML tag \f3<b>\fR is shown in the following example\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * This is a <b>doc</b> comment\&.\fP +.fi +.nf +\f3 * @see java\&.lang\&.Object\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Leading Asterisks + +When the \f3javadoc\fR command parses a documentation comment, leading asterisks (*) on each line are discarded, and blanks and tabs that precede the initial asterisks (*) are also discarded\&. If you omit the leading asterisk on a line, then the leading white space is no longer removed so that you can paste code examples directly into a documentation comment inside a \f3<PRE>\fR tag with its indentation preserved\&. Spaces are interpreted by browsers more uniformly than tabs\&. Indentation is relative to the left margin (rather than the separator \f3/**\fR or \f3<PRE>\fR tag)\&. +.PP +First Sentence + +The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity\&. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag\&. The \f3javadoc\fR command copies this first sentence to the member summary at the top of the HTML page\&. +.PP +Multiple-Field Declarations + +The Java platform lets you declare multiple fields in a single statement, but this statement can have only one documentation comment that is copied for all fields\&. If you want individual documentation comments for each field, then declare each field in a separate statement\&. For example, the following documentation comment does not make sense written as a single declaration and would be better handled as two declarations: +.sp +.nf +\f3/** \fP +.fi +.nf +\f3 * The horizontal and vertical distances of point (x,y)\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public int x, y; // Avoid this \fP +.fi +.nf +\f3\fR +.fi +.sp +The \f3javadoc\fR command generates the following documentation from the previous code: +.sp +.nf +\f3public int x\fP +.fi +.nf +\f3\fR +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.sp +.nf +\f3public int y\fP +.fi +.nf +\f3\fR +.fi +.sp +The horizontal and vertical distances of point (x, y)\&. +.PP +Use of Header Tags + +When writing documentation comments for members, it is best not to use HTML heading tags such as \f3<H1>\fR and \f3<H2>\fR, because the \f3javadoc\fR command creates an entire structured document, and these structural tags might interfere with the formatting of the generated document\&. However, you can use these headings in class and package comments to provide your own structure\&. +.SS METHOD\ COMMENT\ INHERITANCE +The \f3javadoc\fR command allows method comment inheritance in classes and interfaces to fill in missing text or to explicitly inherit method comments\&. Constructors, fields, and nested classes do not inherit documentation comments\&. +.PP +\fINote:\fR The source file for an inherited method must be on the path specified by the \f3-sourcepath\fR option for the documentation comment to be available to copy\&. Neither the class nor its package needs to be passed in on the command line\&. This contrasts with Release 1\&.3\&.\fIn\fR and earlier releases, where the class had to be a documented class\&. +.PP +Fill in Missing Text + +When a main description, or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag is missing from a method comment, the \f3javadoc\fR command copies the corresponding main description or tag comment from the method it overrides or implements (if any)\&. See Method Comment Inheritance\&. +.PP +When an \f3@param\fR tag for a particular parameter is missing, the comment for that parameter is copied from the method further up the inheritance hierarchy\&. When an \f3@throws\fR tag for a particular exception is missing, the \f3@throws\fR tag is copied only when that exception is declared\&. +.PP +This behavior contrasts with Release 1\&.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited\&. +.PP +See Javadoc Tags and Options\&. +.PP +Explicit Inheritance + +Insert the \f3{@inheritDoc}\fR inline tag in a method main description or \f3@return\fR, \f3@param\fR, or \f3@throws\fR tag comment\&. The corresponding inherited main description or tag comment is copied into that spot\&. +.SS CLASS\ AND\ INTERFACE\ INHERITANCE +Comment inheritance occurs in all possible cases of inheritance from classes and interfaces: +.TP 0.2i +\(bu +When a method in a class overrides a method in a superclass +.TP 0.2i +\(bu +When a method in an interface overrides a method in a superinterface +.TP 0.2i +\(bu +When a method in a class implements a method in an interface +.PP +In the first two cases, the \f3javadoc\fR command generates the subheading \fIOverrides\fR in the documentation for the overriding method\&. A link to the method being overridden is included, whether or not the comment is inherited\&. +.PP +In the third case, when a method in a specified class implements a method in an interface, the \f3javadoc\fR command generates the subheading \fISpecified by\fR in the documentation for the overriding method\&. A link to the method being implemented is included, whether or not the comment is inherited\&. +.SS METHOD\ COMMENTS\ ALGORITHM +If a method does not have a documentation comment, or has an \f3{@inheritDoc}\fR tag, then the \f3javadoc\fR command uses the following algorithm to search for an applicable comment\&. The algorithm is designed to find the most specific applicable documentation comment, and to give preference to interfaces over superclasses: +.TP 0.4i +1\&. +Look in each directly implemented (or extended) interface in the order they appear following the word \f3implements\fR (or \f3extends\fR) in the method declaration\&. Use the first documentation comment found for this method\&. +.TP 0.4i +2\&. +If Step 1 failed to find a documentation comment, then recursively apply this entire algorithm to each directly implemented (or extended) interface in the same order they were examined in Step 1\&. +.TP 0.4i +3\&. +When Step 2 fails to find a documentation comment and this is a class other than the \f3Object\fR class, but not an interface: +.RS +.TP 0.4i +1\&. +If the superclass has a documentation comment for this method, then use it\&. +.TP 0.4i +2\&. +If Step 3a failed to find a documentation comment, then recursively apply this entire algorithm to the superclass\&. +.RE + +.SH JAVADOC\ TAGS +The \f3javadoc\fR command parses special tags when they are embedded within a Java documentation comment\&. The \f3javadoc\fR tags let you autogenerate a complete, well-formatted API from your source code\&. The tags start with an at sign (\f3@\fR) and are case-sensitive\&. They must be typed with the uppercase and lowercase letters as shown\&. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk), or it is treated as text\&. By convention, tags with the same name are grouped together\&. For example, put all \f3@see\fR tags together\&. For more information, see Where Tags Can Be Used\&. +.PP +Tags have the following types: +.TP 0.2i +\(bu +Bock tags: Place block tags only in the tag section that follows the description\&. Block tags have the form: \fI@tag\fR\&. +.TP 0.2i +\(bu +Inline tags: Place inline tags anywhere in the main description or in the comments for block tags\&. Inline tags are enclosed within braces: \fI{@tag}\fR\&. +.PP +For custom tags, see -tag tagname:Xaoptcmf:"taghead"\&. See also Where Tags Can Be Used\&. +.SS TAG\ DESCRIPTIONS +.TP +@author \fIname-text\fR +Introduced in JDK 1\&.0 + +Adds an Author entry with the specified name text to the generated documents when the \f3-author\fR option is used\&. A documentation comment can contain multiple \f3@author\fR tags\&. You can specify one name per \f3@author\fR tag or multiple names per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and space between names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line if you want a localized name separator other than a comma\&. See @author in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@author +.TP +{@code \fItext\fR} +Introduced in JDK 1\&.5 + +Equivalent to \f3<code>{@literal}</code>\fR\&. + +Displays text in code font without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use regular angle brackets (< and >) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (\f3<-\fR)\&. For example, the documentation comment text \f3{@code A<B>C}\fR displayed in the generated HTML page unchanged as \f3A<B>C\fR\&. This means that the \f3<B>\fR is not interpreted as bold and is in code font\&. If you want the same functionality without the code font, then use the \f3{@literal}\fR tag\&. +.TP +@deprecated \fIdeprecated-text\fR +Introduced in JDK 1\&.0 + +Adds a comment indicating that this API should no longer be used (even though it may continue to work)\&. The \f3javadoc\fR command moves \f3deprecated-text\fRahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field\&. + +The first sentence of deprecated text should tell the user when the API was deprecated and what to use as a replacement\&. The \f3javadoc\fR command copies the first sentence to the summary section and index\&. Subsequent sentences can also explain why it was deprecated\&. You should include an \f3{@link}\fR tag (for Javadoc 1\&.2 or later) that points to the replacement API\&. + +Use the \fI@deprecated annotation\fR tag to deprecate a program element\&. See How and When to Deprecate APIs at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/deprecation/deprecation\&.html + +See also @deprecated in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@deprecated +.TP +{@docRoot} +Introduced in JDK 1\&.3 + +Represents the relative path to the generated document\&'s (destination) root directory from any generated page\&. This tag is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages\&. Linking to the copyright page from the bottom of each page is common\&. + +This \f3{@docRoot}\fR tag can be used both on the command line and in a documentation comment\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, and includes the text portion of any tag (such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags)\&. +.RS +.TP 0.2i +\(bu +On the command line, where the header, footer, or bottom are defined: \f3javadoc -bottom \&'<a href="{@docRoot}/copyright\&.html">Copyright</a>\&'\fR\&. + +When you use the \f3{@docRoot}\fR tag this way in a make file, some \f3makefile\fR programs require a special way to escape for the brace \f3{}\fR characters\&. For example, the Inprise MAKE version 5\&.2 running on Windows requires double braces: \f3{{@docRoot}}\fR\&. It also requires double (rather than single) quotation marks to enclose arguments to options such as the \f3-bottom\fR option (with the quotation marks around the \f3href\fR argument omitted)\&. +.TP 0.2i +\(bu +In a documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * See the <a href="{@docRoot}/copyright\&.html">Copyright</a>\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This tag is needed because the generated documents are in hierarchical directories, as deep as the number of subpackages\&. The expression: \f3<a href="{@docRoot}/copyright\&.html">\fR resolves to \f3<a href="\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/Object\&.java\fR and \f3<a href="\&.\&./\&.\&./\&.\&./copyright\&.html">\fR for \f3java/lang/ref/Reference\&.java\fR\&. +.RE + +.TP +@exception \fIclass-name description\fR +Introduced in JDK 1\&.0 + +Identical to the \f3@throws\fR tag\&. See @throws class-name description\&. +.TP +{@inheritDoc} +Introduced in JDK 1\&.4 + +Inherits (copies) documentation from the nearest inheritable class or implementable interface into the current documentation comment at this tag\&'s location\&. This enables you to write more general comments higher up the inheritance tree and to write around the copied text\&. + +This tag is valid only in these places in a documentation comment: +.RS +.TP 0.2i +\(bu +In the main description block of a method\&. In this case, the main description is copied from a class or interface up the hierarchy\&. +.TP 0.2i +\(bu +In the text arguments of the \f3@return\fR, \f3@param,\fR and \f3@throws\fR tags of a method\&. In this case, the tag text is copied from the corresponding tag up the hierarchy\&. .RE -.nf -\f3 -.fl -public int \fP\f3y\fP -.fl -.fi -.RS 3 -The horizontal and vertical distances of point (x,y) +.RS +See Method Comment Inheritance for a description of how comments are found in the inheritance hierarchy\&. Note that if this tag is missing, then the comment is or is not automatically inherited according to rules described in that section\&. + .RE -.LP -\f3Use header tags carefully\fP \- When writing documentation comments for members, it's best not to use HTML heading tags such as <H1> and <H2>, because the Javadoc tool creates an entire structured document and these structural tags might interfere with the formatting of the generated document. However, it is fine to use these headings in class and package comments to provide your own structure. -.SS -Automatic Copying of Method Comments -.LP -The Javadoc tool has the ability to copy or "inherit" method comments in classes and interfaces under the following two circumstances. Constructors, fields and nested classes do not inherit doc comments. -.RS 3 -.TP 2 -o -\f3Automatically inherit comment to fill in missing text\fP \- When a main description, or \f2@return\fP, \f2@param\fP or \f2@throws\fP tag is missing from a method comment, the Javadoc tool copies the corresponding main description or tag comment from the method it overrides or implements (if any), according to the algorithm below. -.LP -More specifically, when a \f2@param\fP tag for a particular parameter is missing, then the comment for that parameter is copied from the method further up the inheritance hierarchy. When a \f2@throws\fP tag for a particular exception is missing, the \f2@throws\fP tag is copied \f2only if that exception is declared\fP. -.LP -This behavior contrasts with version 1.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited. -.TP 2 -o -\f3Explicitly inherit comment with {@inheritDoc} tag\fP \- Insert the inline tag \f2{@inheritDoc}\fP in a method main description or \f2@return\fP, \f2@param\fP or \f2@throws\fP tag comment \-\- the corresponding inherited main description or tag comment is copied into that spot. +.TP +{@link \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.2 + +Inserts an inline link with a visible text label that points to the documentation for the specified package, class, or member name of a referenced class\&. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag, such as the \f3@return\fR, \f3@param\fR and \f3@deprecated\fR tags\&. See @link in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#{@link + +This tag is similar to the \f3@see\fR tag\&. Both tags require the same references and accept the same syntax for \f3package\&.class#member\fR and \f3label\fR\&. The main difference is that the \f3{@link}\fR tag generates an inline link rather than placing the link in the See Also section\&. The \f3{@link}\fR tag begins and ends with braces to separate it from the rest of the inline text\&. If you need to use the right brace (\f3}\fR) inside the label, then use the HTML entity notation \f3}\fR\&. + +There is no limit to the number of \f3{@link}\fR tags allowed in a sentence\&. You can use this tag in the main description part of any documentation comment or in the text portion of any tag, such as the \f3@deprecated\fR, \f3@return\fR or \f3@param\fR tags\&. + +For example, here is a comment that refers to the \f3getComponentAt(int, int)\fR method: +.sp +.nf +\f3Use the {@link #getComponentAt(int, int) getComponentAt} method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + + +From this code, the standard doclet generates the following HTML (assuming it refers to another class in the same package): +.sp +.nf +\f3Use the <a href="Component\&.html#getComponentAt(int, int)">getComponentAt</a> method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The previous line appears on the web page as: +.sp +.nf +\f3Use the getComponentAt method\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +{@linkplain \fIpackage\&.class#member label\fR} +Introduced in JDK 1\&.4 + +Behaves the same as the \f3{@link}\fR tag, except the link label is displayed in plain text rather than code font\&. Useful when the label is plain text\&. For example, \f3Refer to {@linkplain add() the overridden method}\fR\&. displays as: Refer to the overridden method\&. +.TP +{@literal \fItext\fR} +Introduced in JDK 1\&.5 + +Displays text without interpreting the text as HTML markup or nested Javadoc tags\&. This enables you to use angle brackets (\f3< and >\fR) instead of the HTML entities (\f3<\fR and \f3>\fR) in documentation comments, such as in parameter types (\f3<Object>\fR), inequalities (\f33 < 4\fR), or arrows (<-)\&. For example, the documentation comment text \f3{@literal A<B>C}\fR displays unchanged in the generated HTML page in your browser, as \f3A<B>C\fR\&. The \f3<B>\fR is not interpreted as bold (and it is not in code font)\&. If you want the same functionality with the text in code font, then use the \f3{@code}\fR tag\&. +.TP +@param \fIparameter-name description\fR +Introduced in JDK 1\&.0 + +Adds a parameter with the specified \f3parameter-name\fR followed by the specified description to the Parameters section\&. When writing the documentation comment, you can continue the description onto multiple lines\&. This tag is valid only in a documentation comment for a method, constructor, or class\&. See @param in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@param + +The \f3parameter-name\fR can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method, or constructor\&. Use angle brackets around this parameter name to specify the use of a type parameter\&. + +Example of a type parameter of a class: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param <E> Type of element stored in a list\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public interface List<E> extends Collection<E> {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Example of a type parameter of a method: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @param string the string to be converted\fP +.fi +.nf +\f3 * @param type the type to convert the string to\fP +.fi +.nf +\f3 * @param <T> the type of the element\fP +.fi +.nf +\f3 * @param <V> the value of the element\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3<T, V extends T> V convert(String string, Class<T> type) {\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +@return \fIdescription\fR +Introduced in JDK 1\&.0 + +Adds a Returns section with the description text\&. This text should describe the return type and permissible range of values\&. This tag is valid only in a documentation comment for a method\&. See @return in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@return +.TP +@see \fIreference\fR +Introduced in JDK 1\&.0 + +Adds a \fISee Also\fR heading with a link or text entry that points to a reference\&. A documentation comment can contain any number of \f3@see\fR tags, which are all grouped under the same heading\&. The \f3@see\fR tag has three variations\&. The form is the most common\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. For inserting an inline link within a sentence to a package, class, or member, see \f3{@link}\fR\&. + +\fIForm 1\fR\&. The @see \f3string\fR tag form adds a text entry for \fIstring\fR\&. No link is generated\&. The string is a book or other reference to information not available by URL\&. The \f3javadoc\fR command distinguishes this from the previous cases by searching for a double quotation mark (") as the first character\&. For example, \f3@see "The Java Programming Language"\fR that generates the following text: + +\fISee Also\fR: + +"The Java Programming Language" + +\fIForm 2\fR\&. The \f3@see <a href="URL#value">label</a>\fR form adds a link as defined by \f3URL#value\fR\&. The \f3URL#value\fR parameter is a relative or absolute URL\&. The \f3javadoc\fR command distinguishes this from other cases by searching for a less-than symbol (\f3<\fR) as the first character\&. For example, \f3@see <a href="spec\&.html#section">Java Spec</a>\fR generates the following link: + +\fISee Also\fR: + +Java Spec + +\fIForm 3\fR\&. The \f3@see package\&.class#member label\fR form adds a link with a visible text label that points to the documentation for the specified name in the Java Language that is referenced\&. The label is optional\&. If the label is omitted, then the name appears instead as visible text, suitably shortened\&. Use the \f3-noqualifier\fR option to globally remove the package name from this visible text\&. Use the label when you want the visible text to be different from the autogenerated visible text\&. See How a Name Appears\&. + +In Java SE 1\&.2 only, the name but not the label automatically appears in \f3<code>\fR HTML tags\&. Starting with Java SE 1\&.2\&.2, the \f3<code>\fR tag is always included around the visible text, whether or not a label is used\&. +.RS +.TP 0.2i +\(bu +\f3package\&.class#member\fR is any valid program element name that is referenced, such as a package, class, interface, constructor, method or field name, except that the character ahead of the member name should be a number sign (\f3#\fR)\&. The class represents any top-level or nested class or interface\&. The member represents any constructor, method, or field (not a nested class or interface)\&. If this name is in the documented classes, then the \f3javadoc\fR command create a link to it\&. To create links to external referenced classes, use the \f3-link\fR option\&. Use either of the other two \f3@see\fR tag forms to refer to the documentation of a name that does not belong to a referenced class\&. See Specify a Name\&. + +\fINote:\fR External referenced classes are classes that are not passed into the \f3javadoc\fR command on the command line\&. Links in the generated documentation to external referenced classes are called external references or external links\&. For example, if you run the \f3javadoc\fR command on only the \f3java\&.awt package\fR, then any class in \f3java\&.lang\fR, such as \f3Object\fR, is an external referenced class\&. Use the \f3-link\fR and \f3-linkoffline\fR options to link to external referenced classes\&. The source comments of external referenced classes are not available to the \f3javadoc\fR command run\&. +.TP 0.2i +\(bu +\f3label\fR is optional text that is visible as the link label\&. The label can contain white space\&. If \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears, suitably shortened relative to the current class and package\&. See How a Name Appears\&. +.TP 0.2i +\(bu +A space is the delimiter between \f3package\&.class#member\fR and \f3label\fR\&. A space inside parentheses does not indicate the start of a label, so spaces can be used between parameters in a method\&. +.RE + + +\fI\fRIn the following example, an \f3@see\fR tag (in the \f3Character\fR class) refers to the equals method in the \f3String\fR class\&. The tag includes both arguments: the name \f3String#equals(Object)\fR and the label \f3equals\fR\&. +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @see String#equals(Object) equals\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The standard doclet produces HTML that is similar to: +.sp +.nf +\f3<dl>\fP +.fi +.nf +\f3<dt><b>See Also:</b>\fP +.fi +.nf +\f3<dd><a href="\&.\&./\&.\&./java/lang/String#equals(java\&.lang\&.Object)"><code>equals<code></a>\fP +.fi +.nf +\f3</dl>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The previous code looks similar to the following in a browser, where the label is the visible link text: + +\fISee Also\fR: + +equals +.PP +Specify a Name + +\fI\fRThis \f3package\&.class#member\fR name can be either fully qualified, such as \f3java\&.lang\&.String#toUpperCase()\fR or not, such as \f3String#toUpperCase()\fR or \f3#toUpperCase()\fR\&. If the name is less than fully qualified, then the \f3javadoc\fR command uses the standard Java compiler search order to find it\&. See Search Order for the @see Tag\&. The name can contain white space within parentheses, such as between method arguments\&.The advantage to providing shorter, partially qualified names is that they are shorter to type and there is less clutter in the source code\&. The following listing shows the different forms of the name, where \f3Class\fR can be a class or interface; Type can be a class, interface, array, or primitive; and method can be a method or constructor\&. +.sp +.nf +\f3\fITypical forms for\fR\fI @see package\&.class#member\fR\fP +.fi +.nf +\f3\fIReferencing a member of the current class\fR\fP +.fi +.nf +\f3@see #field\fP +.fi +.nf +\f3@see #method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see #constructor(Type argname, Type argname,\&.\&.\&.) \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3\fIReferencing another class in the current or imported packages\fR\fP +.fi +.nf +\f3@see Class#field\fP +.fi +.nf +\f3@see Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see Class\&.NestedClass\fP +.fi +.nf +\f3@see Class \fP +.fi +.nf +\f3\fR +.fi +.nf +\f3\fIReferencing an element in another package (fully qualified)\fR\fP +.fi +.nf +\f3@see package\&.Class#field\fP +.fi +.nf +\f3@see package\&.Class#method(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#method(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type, Type,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class#constructor(Type argname, Type argname,\&.\&.\&.)\fP +.fi +.nf +\f3@see package\&.Class\&.NestedClass\fP +.fi +.nf +\f3@see package\&.Class\fP +.fi +.nf +\f3@see package\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3\fRNotes about the previous listing: +.TP 0.2i +\(bu +The first set of forms with no class or package causes the \f3javadoc\fR command to search only through the current class hierarchy\&. It finds a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search Items 1\(en3)\&. It does not search the rest of the current package or other packages (search Items 4\(en5)\&. See Search Order for the @see Tag\&. +.TP 0.2i +\(bu +If any method or constructor is entered as a name with no parentheses, such as \f3getValue\fR, and if there is no field with the same name, then the \f3javadoc\fR command still creates a link to the method\&. If this method is overloaded, then the \f3javadoc\fR command links to the first method its search encounters, which is unspecified\&. +.TP 0.2i +\(bu +Nested classes must be specified as \f3outer\&.inner\fR, not simply \f3inner\fR, for all forms\&. +.TP 0.2i +\(bu +As stated, the number sign (\f3#\fR), rather than a dot (\f3\&.\fR) separates a member from its class\&. This enables the \f3javadoc\fR command to resolve ambiguities, because the dot also separates classes, nested classes, packages, and subpackages\&. However, the \f3javadoc\fR command properly parses a dot when there is no ambiguity, but prints a warning to alert you\&. +.PP +Search Order for the @see Tag + +\fI\fRThe \f3javadoc\fR command processes an \f3@see\fR tag that appears in a source file, package file, or overview file\&. In the latter two files, you must fully qualify the name you supply with the \f3@see\fR tag\&. In a source file, you can specify a name that is fully qualified or partially qualified\&. +.PP +The following is the search order for the \f3@see\fR tag\&. +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superonterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statement\&. +.PP +The \f3javadoc\fR command continues to search recursively through Items 1-3 for each class it encounters until it finds a match\&. That is, after it searches through the current class and its enclosing class E, it searches through the superclasses of E before the enclosing classes of E\&. In Items 4 and 5, the \f3javadoc\fR command does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler)\&. In Item 5, the \f3javadoc\fR command searches in \fIjava\&.lang\fR because that is imported by all programs\&. +.PP +When the \f3javadoc\fR command encounters an \f3@see\fR tag in a source file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would, except the \f3javadoc\fR command does not detect certain name space ambiguities because it assumes the source code is free of these errors\&. This search order is formally defined in the Java Language Specification\&. The \f3javadoc\fR command searches for that name through all related and imported classes and packages\&. In particular, it searches in this order: +.TP 0.4i +1\&. +The current class or interface\&. +.TP 0.4i +2\&. +Any enclosing classes and interfaces, searching the closest first\&. +.TP 0.4i +3\&. +Any superclasses and superinterfaces, searching the closest first\&. +.TP 0.4i +4\&. +The current package\&. +.TP 0.4i +5\&. +Any imported packages, classes, and interfaces, searching in the order of the \f3import\fR statements\&. +.PP +The \f3javadoc\fR command does not necessarily look in subclasses, nor will it look in other packages even when their documentation is being generated in the same run\&. For example, if the \f3@see\fR tag is in the \f3java\&.awt\&.event\&.KeyEvent\fR class and refers to a name in the \f3java\&.awt package\fR, then the \f3javadoc\fR command does not look in that package unless that class imports it\&. +.PP +How a Name Appears + +\fI\fRIf \f3label\fR is omitted, then \f3package\&.class\&.member\fR appears\&. In general, it is suitably shortened relative to the current class and package\&. Shortened means the \f3javadoc\fR command displays only the minimum name necessary\&. For example, if the \f3String\&.toUpperCase()\fR method contains references to a member of the same class and to a member of a different class, then the class name is displayed only in the latter case, as shown in the following listing\&. Use the \f3-noqualifier\fR option to globally remove the package names\&. +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of the same class, same package +.br +\fIExample in\fR: \f3@see String#toLowerCase()\fR +.br +\fIAppears as\fR: \f3toLowerCase()\fR - omits the package and class names +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, same package +.br +\fIExample in\fR: \f3@see Character#toLowerCase(char)\fR +.br +\fIAppears as\fR: \f3Character\&.toLowerCase(char)\fR - omits the package name, includes the class name +.br + +.PP +\fIType of reference\fR: The \f3@see\fR tag refers to a member of a different class, different package +.br +\fIExample in\fR: \f3@see java\&.io\&.File#exists()\fR +.br +\fIAppears as\fR: \f3java\&.io\&.File\&.exists()\fR - includes the package and class names +.br + +.PP +Examples of the @see Tag + +The comment to the right shows how the name appears when the \f3@see\fR tag is in a class in another package, such as \f3java\&.applet\&.Applet\fR\&. See @see in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@see +.sp +.nf +\f3 See also:\fP +.fi +.nf +\f3@see java\&.lang\&.String // String \fP +.fi +.nf +\f3@see java\&.lang\&.String The String class // The String class \fP +.fi +.nf +\f3@see String // String \fP +.fi +.nf +\f3@see String#equals(Object) // String\&.equals(Object) \fP +.fi +.nf +\f3@see String#equals // String\&.equals(java\&.lang\&.Object) \fP +.fi +.nf +\f3@see java\&.lang\&.Object#wait(long) // java\&.lang\&.Object\&.wait(long) \fP +.fi +.nf +\f3@see Character#MAX_RADIX // Character\&.MAX_RADIX \fP +.fi +.nf +\f3@see <a href="spec\&.html">Java Spec</a> // Java Spec \fP +.fi +.nf +\f3@see "The Java Programming Language" // "The Java Programming Language" \fP +.fi +.nf +\f3\fR +.fi +.sp +\fINote:\fR You can extend the \f3@se\fR\f3e\fR tag to link to classes not being documented with the \f3-link\fR option\&. +.TP +@serial \fIfield-description\fR | include | exclude +Introduced in JDK 1\&.2 + +Used in the documentation comment for a default serializable field\&. See Documenting Serializable Fields and Data for a Class at http://docs\&.oracle\&.com/javase/8/docs/platform/serialization/spec/serial-arch\&.html#5251 + +See also Oracle\(cqs Criteria for Including Classes in the Serialilzed Form Specification at http://www\&.oracle\&.com/technetwork/java/javase/documentation/serialized-criteria-137781\&.html + +An optional \f3field-description\fR should explain the meaning of the field and list the acceptable values\&. When needed, the description can span multiple lines\&. The standard doclet adds this information to the serialized form page\&. See Cross-Reference Pages\&. + +If a serializable field was added to a class after the class was made serializable, then a statement should be added to its main description to identify at which version it was added\&. + +The \f3include\fR and \f3exclude\fR arguments identify whether a class or package should be included or excluded from the serialized form page\&. They work as follows: +.RS +.TP 0.2i +\(bu +A public or protected class that implements \f3Serializable\fR is included unless that class (or its package) is marked with the \f3@serial exclude\fR tag\&. +.TP 0.2i +\(bu +A private or package-private class that implements \f3Serializable\fR is excluded unless that class (or its package) is marked with the \f3@serial include\fR tag\&. .RE -.LP -The source file for the inherited method need only be on the path specified by \-sourcepath for the doc comment to actually be available to copy. Neither the class nor its package needs to be passed in on the command line. This contrasts with 1.3.x and earlier releases, where the class had to be a documented class -.LP -\f3Inherit from classes and interfaces\fP \- Inheriting of comments occurs in all three possible cases of inheritance from classes and interfaces: -.RS 3 -.TP 2 -o -When a method in a class overrides a method in a superclass -.TP 2 -o -When a method in an interface overrides a method in a superinterface -.TP 2 -o -When a method in a class implements a method in an interface +.RS +For example, the \f3javax\&.swing\fR package is marked with the \f3@serial\fR\f3exclude\fR tag in package\&.html or package-info\&.java\&. The public class \f3java\&.security\&.BasicPermission\fR is marked with the \f3@serial exclude\fR tag\&. The package-private class \f3java\&.util\&.PropertyPermissionCollection\fR is marked with the \f3@serial include\fR tag\&. + +The \f3@serial\fR tag at the class level overrides the \f3@serial\fR tag at the package level\&. + .RE -.LP -In the first two cases, for method overrides, the Javadoc tool generates a subheading "Overrides" in the documentation for the overriding method, with a link to the method it is overriding, whether or not the comment is inherited. -.LP -In the third case, when a method in a given class implements a method in an interface, the Javadoc tool generates a subheading "Specified by" in the documentation for the overriding method, with a link to the method it is implementing. This happens whether or not the comment is inherited. -.LP -\f3Algorithm for Inheriting Method Comments\fP \- If a method does not have a doc comment, or has an {@inheritDoc} tag, the Javadoc tool searches for an applicable comment using the following algorithm, which is designed to find the most specific applicable doc comment, giving preference to interfaces over superclasses: -.RS 3 -.TP 3 -1. -Look in each directly implemented (or extended) interface in the order they appear following the word implements (or extends) in the method declaration. Use the first doc comment found for this method. -.TP 3 -2. -If step 1 failed to find a doc comment, recursively apply this entire algorithm to each directly implemented (or extended) interface, in the same order they were examined in step 1. -.TP 3 -3. -If step 2 failed to find a doc comment and this is a class other than Object (not an interface): -.RS 3 -.TP 3 -a. -If the superclass has a doc comment for this method, use it. -.TP 3 -b. -If step 3a failed to find a doc comment, recursively apply this entire algorithm to the superclass. -.RE -.RE -.SH "JAVADOC TAGS" -.LP -The Javadoc tool parses special tags when they are embedded within a Java doc comment. These doc tags enable you to autogenerate a complete, well\-formatted API from your source code. The tags start with an "at" sign (\f2@\fP) and are case\-sensitive \-\- they must be typed with the uppercase and lowercase letters as shown. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk) or it is treated as normal text. By convention, tags with the same name are grouped together. For example, put all \f2@see\fP tags together. -.LP -Tags come in two types: -.RS 3 -.TP 2 -o -\f3Block tags\fP \- Can be placed only in the tag section that follows the main description. Block tags are of the form: \f2@tag\fP. -.TP 2 -o -\f3Inline tags\fP \- Can be placed anywhere in the main description or in the comments for block tags. Inline tags are denoted by curly braces: \f2{@tag}\fP. -.RE -.LP -For information about tags we might introduce in future releases, see -.na -\f2Proposed Tags\fP @ -.fi -http://java.sun.com/j2se/javadoc/proposed\-tags.html. -.LP -The current tags are: -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 80 0 -.nr 38 \w\f3Tag\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@author\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@code}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@docRoot}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@deprecated\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@exception\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@inheritDoc}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@link}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@linkplain}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@literal}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@param\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@return\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@see\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serial\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serialData\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@serialField\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@since\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@throws\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2{@value}\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f2@version\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Introduced in JDK/SDK\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.5 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.3 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.5 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.1 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.2 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.4 -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \w1.0 -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 873 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Tag\fP\h'|\n(41u'\f3Introduced in JDK/SDK\fP -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@author\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@code}\fP\h'|\n(41u'1.5 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@docRoot}\fP\h'|\n(41u'1.3 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@deprecated\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@exception\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@inheritDoc}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@link}\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@linkplain}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@literal}\fP\h'|\n(41u'1.5 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@param\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@return\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@see\fP\h'|\n(41u'1.0 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serial\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serialData\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@serialField\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@since\fP\h'|\n(41u'1.1 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@throws\fP\h'|\n(41u'1.2 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2{@value}\fP\h'|\n(41u'1.4 -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f2@version\fP\h'|\n(41u'1.0 -.fc -.nr T. 1 -.T# 1 -.35 -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-42 -.LP -For custom tags, see the \-tag option. -.RS 3 -.TP 3 -@author\ name\-text -Adds an "Author" entry with the specified \f2name\-text\fP to the generated docs when the \-author option is used. A doc comment may contain multiple \f2@author\fP tags. You can specify one name per \f2@author\fP tag or multiple names per tag. In the former case, the Javadoc tool inserts a comma (\f2,\fP) and space between names. In the latter case, the entire text is simply copied to the generated document without being parsed. Therefore, you can use multiple names per line if you want a localized name separator other than comma. -.RE -.LP -For more details, see Where Tags Can Be Used and -.na -\f2writing @author tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@author. -.LP -.RS 3 -.TP 3 -@deprecated\ deprecated\-text Note: You can deprecate a program element using the @Deprecated annotation. -.RE -.LP -Adds a comment indicating that this API should no longer be used (even though it may continue to work). The Javadoc tool moves the \f2deprecated\-text\fP ahead of the main description, placing it in italics and preceding it with a bold warning: "Deprecated". This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field. -.LP -The first sentence of \f2deprecated\-text\fP should at least tell the user when the API was deprecated and what to use as a replacement. The Javadoc tool copies just the first sentence to the summary section and index. Subsequent sentences can also explain why it has been deprecated. You should include a \f2{@link}\fP tag (for Javadoc 1.2 or later) that points to the replacement API: -.LP -For more details, see -.na -\f2writing @deprecated tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@deprecated. -.RS 3 -.TP 2 -o -For Javadoc 1.2 and later, use a \f2{@link}\fP tag. This creates the link in\-line, where you want it. For example: -.nf -\f3 -.fl -/** -.fl - * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} -.fl - */ -.fl - -.fl -\fP -.fi -.TP 2 -o -For Javadoc 1.1, the standard format is to create a \f2@see\fP tag (which cannot be in\-line) for each \f2@deprecated\fP tag. -.RE -.LP -For more about deprecation, see -.na -\f2The @deprecated tag\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/deprecation/index.html. -.LP -.RS 3 -.TP 3 -{@code\ text} -Equivalent to \f2<code>{@literal}</code>\fP. -.LP -Displays \f2text\fP in \f2code\fP font without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (\f2<\fP and \f2>\fP) instead of the HTML entities (\f2<\fP and \f2>\fP) in doc comments, such as in parameter types (\f2<Object>\fP), inequalities (\f23 < 4\fP), or arrows (\f2<\-\fP). For example, the doc comment text: -.nf -\f3 -.fl - \fP\f4{@code A<B>C}\fP\f3 -.fl - -.fl -\fP -.fi -.LP -displays in the generated HTML page unchanged, as: -.nf -\f3 -.fl - \fP\f4A<B>C\fP\f3 -.fl - -.fl -\fP -.fi -.LP -The noteworthy point is that the \f2<B>\fP is not interpreted as bold and is in code font. -.LP -If you want the same functionality without the code font, use \f2{@literal}\fP. -.LP -.TP 3 -{@docRoot} -Represents the relative path to the generated document's (destination) root directory from any generated page. It is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages. Linking to the copyright page from the bottom of each page is common. -.LP -This \f2{@docRoot}\fP tag can be used both on the command line and in a doc comment: This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated). -.RS 3 -.TP 3 -1. -On the command line, where the header/footer/bottom are defined: -.nf -\f3 -.fl - javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>' -.fl - -.fl -\fP -.fi -.LP -NOTE \- When using \f2{@docRoot}\fP this way in a make file, some makefile programs require special escaping for the brace {} characters. For example, the Inprise MAKE version 5.2 running on Windows requires double braces: \f2{{@docRoot}}\fP. It also requires double (rather than single) quotes to enclose arguments to options such as \f2\-bottom\fP (with the quotes around the \f2href\fP argument omitted). -.TP 3 -2. -In a doc comment: -.nf -\f3 -.fl - /** -.fl - * See the <a href="{@docRoot}/copyright.html">Copyright</a>. -.fl - */ -.fl - -.fl -\fP -.fi -.RE -.LP -The reason this tag is needed is because the generated docs are in hierarchical directories, as deep as the number of subpackages. This expression: -.nf -\f3 -.fl - <a href="{@docRoot}/copyright.html"> -.fl - -.fl -\fP -.fi -.LP -would resolve to: -.nf -\f3 -.fl - <a href="../../copyright.html"> for java/lang/Object.java -.fl - -.fl -\fP -.fi -.LP -and -.nf -\f3 -.fl - <a href="../../../copyright.html"> for java/lang/ref/Reference.java -.fl - -.fl -\fP -.fi -.LP -.TP 3 -@exception\ class\-name\ description -The \f2@exception\fP tag is a synonym for \f2@throws\fP. -.LP -.TP 3 -{@inheritDoc}\ -Inherits (copies) documentation from the "nearest" inheritable class or implementable interface into the current doc comment at this tag's location. This allows you to write more general comments higher up the inheritance tree, and to write around the copied text. -.LP -This tag is valid only in these places in a doc comment: -.RS 3 -.TP 2 -o -In the main description block of a method. In this case, the main description is copied from a class or interface up the hierarchy. -.TP 2 -o -In the text arguments of the @return, @param and @throws tags of a method. In this case, the tag text is copied from the corresponding tag up the hierarchy. -.RE -.LP -See Automatic Copying of Method Comments for a more precise description of how comments are found in the inheritance hierarchy. Note that if this tag is missing, the comment is or is not automatically inherited according to rules described in that section. -.LP -.TP 3 -{@link\ package.class#member\ label} -Inserts an in\-line link with visible text \f2label\fP that points to the documentation for the specified package, class or member name of a referenced class. This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated). -.LP -This tag is very simliar to \f2@see\fP \-\- both require the same references and accept exactly the same syntax for \f2package.class\fP\f2#\fP\f2member\fP and \f2label\fP. The main difference is that \f2{@link}\fP generates an in\-line link rather than placing the link in the "See Also" section. Also, the \f2{@link}\fP tag begins and ends with curly braces to separate it from the rest of the in\-line text. If you need to use "}" inside the label, use the HTML entity notation } -.LP -There is no limit to the number of \f2{@link}\fP tags allowed in a sentence. You can use this tag in the main description part of any documentation comment or in the text portion of any tag (such as @deprecated, @return or @param). -.LP -For example, here is a comment that refers to the \f2getComponentAt(int, int)\fP method: -.nf -\f3 -.fl -Use the {@link #getComponentAt(int, int) getComponentAt} method. -.fl - -.fl -\fP -.fi -.LP -From this, the standard doclet would generate the following HTML (assuming it refers to another class in the same package): -.nf -\f3 -.fl -Use the <a href="Component.html#getComponentAt(int, int)">getComponentAt</a> method. -.fl - -.fl -\fP -.fi -.LP -Which appears on the web page as: -.nf -\f3 -.fl -Use the getComponentAt method. -.fl - -.fl -\fP -.fi -.LP -You can extend \f2{@link}\fP to link to classes not being documented by using the \f2\-link\fP option. -.LP -For more details, see -.na -\f2writing {@link} tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#{@link}. -.LP -.TP 3 -{@linkplain\ package.class#member\ label} -Identical to \f2{@link}\fP, except the link's label is displayed in plain text than code font. Useful when the label is plain text. Example: -.nf -\f3 -.fl - Refer to {@linkplain add() the overridden method}. -.fl - -.fl -\fP -.fi -.LP -This would display as: -.LP -Refer to the overridden method. -.LP -.TP 3 -{@literal\ text} -Displays \f2text\fP without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (\f2<\fP and \f2>\fP) instead of the HTML entities (\f2<\fP and \f2>\fP) in doc comments, such as in parameter types (\f2<Object>\fP), inequalities (\f23 < 4\fP), or arrows (\f2<\-\fP). For example, the doc comment text: -.nf -\f3 -.fl - \fP\f4{@literal A<B>C}\fP\f3 -.fl - -.fl -\fP -.fi -.LP -displays unchanged in the generated HTML page in your browser, as: -.LP -\f2\ \ \ \ \ \fPA<B>C -.LP -The noteworthy point is that the \f2<B>\fP is not interpreted as bold (and it is not in code font). -.LP -If you want the same functionality but with the text in code font, use \f2{@code}\fP. -.LP -.TP 3 -@param\ parameter\-name description -Adds a parameter with the specified \f2parameter\-name\fP followed by the specified \f2description\fP to the "Parameters" section. When writing the doc comment, you may continue the \f2description\fP onto multiple lines. This tag is valid only in a doc comment for a method, constructor or class. -.LP -The \f2parameter\-name\fP can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method or constructor. Use angle brackets around this parameter name to specify the use of a type parameter. -.LP -Example of a type parameter of a class: -.nf -\f3 -.fl - /** -.fl - * @param <E> Type of element stored in a list -.fl - */ -.fl - public interface List<E> extends Collection<E> { -.fl - } -.fl - -.fl -\fP -.fi -.LP -Example of a type parameter of a method: -.nf -\f3 -.fl - /** -.fl - * @param string the string to be converted -.fl - * @param type the type to convert the string to -.fl - * @param <T> the type of the element -.fl - * @param <V> the value of the element -.fl - */ -.fl - <T, V extends T> V convert(String string, Class<T> type) { -.fl - } -.fl - -.fl -\fP -.fi -.LP -For more details, see -.na -\f2writing @param tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@param. -.LP -.TP 3 -@return\ description -Adds a "Returns" section with the \f2description\fP text. This text should describe the return type and permissible range of values. This tag is valid only in a doc comment for a method. -.LP -For more details, see -.na -\f2writing @return tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@return. -.LP -.TP 3 -@see\ reference -Adds a "See Also" heading with a link or text entry that points to \f2reference\fP. A doc comment may contain any number of \f2@see\fP tags, which are all grouped under the same heading. The \f2@see\fP tag has three variations; the third form below is the most common. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. For inserting an in\-line link within a sentence to a package, class or member, see \f2{@link}\fP. -.RS 3 -.TP 3 -@see "string" -Adds a text entry for \f2string\fP. No link is generated. The \f2string\fP is a book or other reference to information not available by URL. The Javadoc tool distinguishes this from the previous cases by looking for a double\-quote (\f2"\fP) as the first character. For example: -.nf -\f3 -.fl - @see "The Java Programming Language" -.fl - -.fl -\fP -.fi -.LP -This generates text such as: -.RE -.RE -.RS 3 -.RS 3 -.RS 3 -.RS 3 -.TP 3 -See Also: -"The Java Programming Language" -.RE -.RE -.TP 3 -@see <a href="URL#value">label</a> -Adds a link as defined by \f2URL\fP#\f2value\fP. The \f2URL\fP#\f2value\fP is a relative or absolute URL. The Javadoc tool distinguishes this from other cases by looking for a less\-than symbol (\f2<\fP) as the first character. For example: -.nf -\f3 -.fl - @see <a href="spec.html#section">Java Spec</a> -.fl -\fP -.fi -This generates a link such as: -.RS 3 -.TP 3 -See Also: -Java Spec -.RE -.TP 3 -@see\ package.class#member\ label -Adds a link, with visible text \f2label\fP, that points to the documentation for the specified name in the Java Language that is referenced. The \f2label\fP is optional; if omitted, the name appears instead as the visible text, suitably shortened \-\- see How a name is displayed. Use \-noqualifier to globally remove the package name from this visible text. Use the label when you want the visible text to be different from the auto\-generated visible text. -.LP -Only in version 1.2, just the name but not the label would automatically appear in <code> HTML tags, Starting with 1.2.2, the <code> is always included around the visible text, whether or not a label is used. -.LP -.RS 3 -.TP 2 -o -\f4package.class\fP\f4#\fP\f4member\fP is any valid program element name that is referenced \-\- a package, class, interface, constructor, method or field name \-\- except that the character ahead of the member name should be a hash character (\f2#\fP). The \f2class\fP represents any top\-level or nested class or interface. The \f2member\fP represents any constructor, method or field (not a nested class or interface). If this name is in the documented classes, the Javadoc tool will automatically create a link to it. To create links to external referenced classes, use the \f2\-link\fP option. Use either of the other two \f2@see\fP forms for referring to documentation of a name that does not belong to a referenced class. This argument is described at greater length below under Specifying a Name. -.TP 2 -o -\f4label\fP is optional text that is visible as the link's label. The \f2label\fP can contain whitespace. If \f2label\fP is omitted, then \f2package.class.member\fP will appear, suitably shortened relative to the current class and package \-\- see How a name is displayed. -.TP 2 -o -A space is the delimiter between \f2package.class\fP\f2#\fP\f2member\fP and \f2label\fP. A space inside parentheses does not indicate the start of a label, so spaces may be used between parameters in a method. -.RE -.LP -\f3Example\fP \- In this example, an \f2@see\fP tag (in the \f2Character\fP class) refers to the \f2equals\fP method in the \f2String\fP class. The tag includes both arguments: the name "\f2String#equals(Object)\fP" and the label "\f2equals\fP". -.nf -\f3 -.fl - /** -.fl - * @see String#equals(Object) equals -.fl - */ -.fl -\fP -.fi -The standard doclet produces HTML something like this: -.nf -\f3 -.fl -<dl> -.fl -<dt><b>See Also:</b> -.fl -<dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals<code></a> -.fl -</dl> -.fl -\fP -.fi -Which looks something like this in a browser, where the label is the visible link text: -.RS 3 -.TP 3 -See Also: -equals -.RE -.LP -\f3Specifying a name\fP \- This \f2package.class\fP\f2#\fP\f2member\fP name can be either fully\-qualified, such as \f2java.lang.String#toUpperCase()\fP or not, such as \f2String#toUpperCase()\fP or \f2#toUpperCase()\fP. If less than fully\-qualified, the Javadoc tool uses the normal Java compiler search order to find it, further described below in Search order for @see. The name can contain whitespace within parentheses, such as between method arguments. -.LP -Of course the advantage of providing shorter, "partially\-qualified" names is that they are shorter to type and there is less clutter in the source code. The following table shows the different forms of the name, where \f2Class\fP can be a class or interface, \f2Type\fP can be a class, interface, array, or primitive, and \f2method\fP can be a method or constructor. -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 -.nr 34 \n(.lu -.eo -.am 80 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Typical\ forms\ for\ \fP\f4@see\fP\f3\ \fP\f4package.class#member\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ a\ member\ of\ the\ current\ class\fP -.br -\f2@see\fP\ \f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ another\ class\ in\ the\ current\ or\ imported\ packages\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2Class.NestedClass\fP -.br -\f2@see\fP\ \f2Class\fP -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/2u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3Referencing\ an\ element\ in\ another\ package\fP\ (fully qualified) -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2field\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP -.br -\f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP -.br -\f2@see\fP\ \f2package.Class.NestedClass\fP -.br -\f2@see\fP\ \f2package.Class\fP -.br -\f2@see\fP\ \f2package\fP -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.80 -.rm 80 -.nr 38 \n(a- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(b- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(c- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr TW \n(80 -.if t .if \n(TW>\n(.li .tm Table at line 1364 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-58 -.LP -The following notes apply to the above table: -.RS 3 -.TP 2 -o -The first set of forms (with no class or package) will cause the Javadoc tool to search only through the current class's hierarchy. It will find a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search steps 1\-3). It will not search the rest of the current package or other packages (search steps 4\-5). -.TP 2 -o -If any method or constructor is entered as a name with no parentheses, such as \f2getValue\fP, and if there is no field with the same name, the Javadoc tool will correctly create a link to it, but will print a warning message reminding you to add the parentheses and arguments. If this method is overloaded, the Javadoc tool will link to the first method its search encounters, which is unspecified. -.TP 2 -o -Nested classes must be specified as \f2outer\fP\f2.\fP\f2inner\fP, not simply \f2inner\fP, for all forms. -.TP 2 -o -As stated, the hash character (\f2#\fP), rather than a dot (\f2.\fP) separates a member from its class. This enables the Javadoc tool to resolve ambiguities, since the dot also separates classes, nested classes, packages, and subpackages. However, the Javadoc tool is generally lenient and will properly parse a dot if you know there is no ambiguity, though it will print a warning. -.RE -.LP -\f3Search order for @see\fP \- the Javadoc tool will process a \f2@see\fP tag that appears in a source file (.java), package file (package.html or package\-info.java) or overview file (overview.html). In the latter two files, you must fully\-qualify the name you supply with \f2@see\fP. In a source file, you can specify a name that is fully\-qualified or partially\-qualified. -.LP -When the Javadoc tool encounters a \f2@see\fP tag in a \f2.java\fP file that is \f2not\fP fully qualified, it searches for the specified name in the same order as the Java compiler would (except the Javadoc tool will not detect certain namespace ambiguities, since it assumes the source code is free of these errors). This search order is formally defined in the \f2Java Language Specification\fP. The Javadoc tool searches for that name through all related and imported classes and packages. In particular, it searches in this order: -.RS 3 -.TP 3 -1. -the current class or interface -.TP 3 -2. -any enclosing classes and interfaces, searching closest first -.TP 3 -3. -any superclasses and superinterfaces, searching closest first -.TP 3 -4. -the current package -.TP 3 -5. -any imported packages, classes and interfaces, searching in the order of the import statement -.RE -.LP -The Javadoc tool continues to search recursively through steps 1\-3 for each class it encounters until it finds a match. That is, after it searches through the current class and its enclosing class E, it will search through E's superclasses before E's enclosing classes. In steps 4 and 5, the Javadoc tool does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler). In step 5, the Javadoc tool looks in java.lang, since that is automatically imported by all programs. -.LP -The Javadoc tool does not necessarily look in subclasses, nor will it look in other packages even if their documentation is being generated in the same run. For example, if the \f2@see\fP tag is in the \f2java.awt.event.KeyEvent\fP class and refers to a name in the \f2java.awt\fP package, javadoc does not look in that package unless that class imports it. -.LP -\f3How a name is displayed\fP \- If \f2label\fP is omitted, then \f2package.class.member\fP appears. In general, it is suitably shortened relative to the current class and package. By "shortened", we mean the Javadoc tool displays only the minimum name necessary. For example, if the \f2String.toUpperCase()\fP method contains references to a member of the same class and to a member of a different class, the class name is displayed only in the latter case, as shown in the following table. -.LP -Use \-noqualifier to globally remove the package names. -.br -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f3Example in \fP\f4String.toUpperCase()\fP -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of the same class, same package -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2toLowerCase()\fP (omits the package and class names) -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of a different class, same package -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@see Character#toLowerCase(char)\fP -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2Character.toLowerCase(char)\fP (omits the package name, includes the class name) -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f2@see\fP tag refers to member of a different class, different package -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@see java.io.File#exists()\fP -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\f2java.io.File.exists()\fP (includes the package and class names) -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Type of Reference\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(b- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(g- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f2@see String#toLowerCase()\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 82 0 -.nr 38 \w\f3Displays As\fP -.if \n(82<\n(38 .nr 82 \n(38 -.82 -.rm 82 -.nr 38 \n(c- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \n(f- -.if \n(82<\n(38 .nr 82 \n(38 -.nr 38 \n(i- -.if \n(82<\n(38 .nr 82 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr TW \n(82 -.if t .if \n(TW>\n(.li .tm Table at line 1440 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Type of Reference\fP\h'|\n(41u'\h'|\n(42u'\f3Displays As\fP -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.ne \n(c|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\f2@see String#toLowerCase()\fP\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.ne \n(f|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.ne \n(h|u+\n(.Vu -.ne \n(i|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-28 -.LP -\f3Examples of @see\fP -.br -The comment to the right shows how the name would be displayed if the \f2@see\fP tag is in a class in another package, such as \f2java.applet.Applet\fP. -.nf -\f3 -.fl - See also: -.fl -@see java.lang.String // String \fP\f3 -.fl -@see java.lang.String The String class // The String class \fP\f3 -.fl -@see String // String \fP\f3 -.fl -@see String#equals(Object) // String.equals(Object) \fP\f3 -.fl -@see String#equals // String.equals(java.lang.Object) \fP\f3 -.fl -@see java.lang.Object#wait(long) // java.lang.Object.wait(long) \fP\f3 -.fl -@see Character#MAX_RADIX // Character.MAX_RADIX \fP\f3 -.fl -@see <a href="spec.html">Java Spec</a> // Java Spec \fP\f3 -.fl -@see "The Java Programming Language" // "The Java Programming Language" \fP\f3 -.fl -\fP -.fi -You can extend \f2@see\fP to link to classes not being documented by using the \f2\-link\fP option. -.LP -For more details, see -.na -\f2writing @see tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@see. -.RE -.RE -.LP -.RS 3 -.TP 3 -@serial\ field\-description | include | exclude -Used in the doc comment for a default serializable field. -.LP -An optional \f2field\-description\fP should explain the meaning of the field and list the acceptable values. If needed, the description can span multiple lines. The standard doclet adds this information to the serialized form page. -.LP -If a serializable field was added to a class some time after the class was made serializable, a statement should be added to its main description to identify at which version it was added. -.LP -The \f2include\fP and \f2exclude\fP arguments identify whether a class or package should be included or excluded from the serialized form page. They work as follows: -.RS 3 -.TP 2 -o -A public or protected class that implements \f2Serializable\fP is \f2included\fP unless that class (or its package) is marked \f2@serial exclude\fP. -.TP 2 -o -A private or package\-private class that implements \f2Serializable\fP is \f2excluded\fP unless that class (or its package) is marked \f2@serial include\fP. -.RE -.LP -Examples: The \f2javax.swing\fP package is marked \f2@serial exclude\fP (in \f2package.html\fP or \f2package\-info.java\fP). The public class \f2java.security.BasicPermission\fP is marked \f2@serial exclude\fP. The package\-private class \f2java.util.PropertyPermissionCollection\fP is marked \f2@serial include\fP. -.LP -The tag @serial at a class level overrides @serial at a package level. -.LP -For more information about how to use these tags, along with an example, see " -.na -\f2Documenting Serializable Fields and Data for a Class\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/serialization/spec/serial\-arch.html," Section 1.6 of the \f2Java Object Serialization Specification\fP. Also see the -.na -\f2Serialization FAQ\fP @ -.fi -http://java.sun.com/javase/technologies/core/basic/serializationFAQ.jsp#javadoc_warn_missing, which covers common questions, such as "Why do I see javadoc warnings stating that I am missing @serial tags for private fields if I am not running javadoc with the \-private switch?". Also see -.na -\f2Sun's criteria\fP @ -.fi -http://java.sun.com/j2se/javadoc/writingapispecs/serialized\-criteria.html for including classes in the serialized form specification. -.LP -.TP 3 -@serialField\ field\-name\ field\-type\ field\-description -Documents an \f2ObjectStreamField\fP component of a \f2Serializable\fP class's \f2serialPersistentFields\fP member. One \f2@serialField\fP tag should be used for each \f2ObjectStreamField\fP component. -.LP -.TP 3 -@serialData\ data\-description -The \f2data\-description\fP documents the types and order of data in the serialized form. Specifically, this data includes the optional data written by the \f2writeObject\fP method and all data (including base classes) written by the \f2Externalizable.writeExternal\fP method. -.LP -The \f2@serialData\fP tag can be used in the doc comment for the \f2writeObject\fP, \f2readObject\fP, \f2writeExternal\fP, \f2readExternal\fP, \f2writeReplace\fP, and \f2readResolve\fP methods. -.LP -.TP 3 -@since\ since\-text -Adds a "Since" heading with the specified \f2since\-text\fP to the generated documentation. The text has no special internal structure. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. This tag means that this change or feature has existed since the software release specified by the \f2since\-text\fP. For example: -.nf -\f3 -.fl - @since 1.5 -.fl - -.fl -\fP -.fi -.LP -For source code in the Java platform, this tag indicates the version of the Java platform API specification (not necessarily when it was added to the reference implementation). Multiple @since tags are allowed and are treated like multiple @author tags. You could use multiple tags if the prgram element is used by more than one API. -.LP -.TP 3 -@throws\ class\-name\ description -The \f2@throws\fP and \f2@exception\fP tags are synonyms. Adds a "Throws" subheading to the generated documentation, with the \f2class\-name\fP and \f2description\fP text. The \f2class\-name\fP is the name of the exception that may be thrown by the method. This tag is valid only in the doc comment for a method or constructor. If this class is not fully\-specified, the Javadoc tool uses the search order to look up this class. Multiple \f2@throws\fP tags can be used in a given doc comment for the same or different exceptions. -.LP -To ensure that all checked exceptions are documented, if a \f2@throws\fP tag does not exist for an exception in the throws clause, the Javadoc tool automatically adds that exception to the HTML output (with no description) as if it were documented with @throws tag. -.LP -The \f2@throws\fP documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method. The same is true for copying from an interface method to an implementing method. You can use {@inheritDoc} to force @throws to inherit documentation. -.LP -For more details, see -.na -\f2writing @throws tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@exception. -.LP -.TP 3 -{@value\ package.class#field} -When \f2{@value}\fP is used (without any argument) in the doc comment of a static field, it displays the value of that constant: -.nf -\f3 -.fl - /** -.fl - * The value of this constant is {@value}. -.fl - */ -.fl - public static final String SCRIPT_START = "<script>" -.fl - -.fl -\fP -.fi -.LP -When used with argument \f2package.class#field\fP in any doc comment, it displays the value of the specified constant: -.nf -\f3 -.fl - /** -.fl - * Evaluates the script starting with {@value #SCRIPT_START}. -.fl - */ -.fl - public String evalScript(String script) { -.fl - } -.fl - -.fl -\fP -.fi -.LP -The argument \f2package.class#field\fP takes a form identical to that of the @see argument, except that the member must be a static field. -.LP -These values of these constants are also displayed on the -.na -\f2Constant Field Values\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/constant\-values.html page. -.LP -.TP 3 -@version\ version\-text -Adds a "Version" subheading with the specified \f2version\-text\fP to the generated docs when the \-version option is used. This tag is intended to hold the current version number of the software that this code is part of (as opposed to @since, which holds the version number where this code was introduced). The \f2version\-text\fP has no special internal structure. To see where the version tag can be used, see Where Tags Can Be Used. -.LP -A doc comment may contain multiple \f2@version\fP tags. If it makes sense, you can specify one version number per \f2@version\fP tag or multiple version numbers per tag. In the former case, the Javadoc tool inserts a comma (\f2,\fP) and space between names. In the latter case, the entire text is simply copied to the generated document without being parsed. Therefore, you can use multiple names per line if you want a localized name separator other than comma. -.LP -For more details, see -.na -\f2writing @version tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@version. -.RE -.SS -Where Tags Can Be Used -.LP -The following sections describe where the tags can be used. Note that these tags can be used in all doc comments: \f2@see\fP, \f2@since\fP, \f2@deprecated\fP, \f2{@link}\fP, \f2{@linkplain}\fP, and \f2{@docroot}\fP. -.SS -Overview Documentation Tags -.LP -Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named \f2overview.html\fP). Like in any other documentation comments, these tags must appear after the main description. -.LP -\f3NOTE\fP \- The \f2{@link}\fP tag has a bug in overview documents in version 1.2 \-\- the text appears properly but has no link. The \f2{@docRoot}\fP tag does not currently work in overview documents. -.LP -\f3Overview Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -.SS -Package Documentation Tags -.LP -Package tags are tags that can appear in the documentation comment for a package (which resides in the source file named \f2package.html\fP or \f2package\-info.java\fP). The \f2@serial\fP tag can only be used here with the \f2include\fP or \f2exclude\fP argument. -.LP -\f3Package Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -.SS -Class and Interface Documentation Tags -.LP -The following are tags that can appear in the documentation comment for a class or interface. The \f2@serial\fP tag can only be used here with the \f2include\fP or \f2exclude\fP argument. -.LP -\f3Class/Interface Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@author\fP -.TP 2 -o -\f2@version\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -\f3An example of a class comment:\fP -.nf -\f3 -.fl -/** -.fl - * A class representing a window on the screen. -.fl - * For example: -.fl - * <pre> -.fl - * Window win = new Window(parent); -.fl - * win.show(); -.fl - * </pre> -.fl - * -.fl - * @author Sami Shaio -.fl - * @version 1.13, 06/08/06 -.fl - * @see java.awt.BaseWindow -.fl - * @see java.awt.Button -.fl - */ -.fl -class Window extends BaseWindow { -.fl - ... -.fl -} -.fl -\fP -.fi -.SS -Field Documentation Tags -.LP -The following are the tags that can appear in -.LP -\f3Field Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@serial\fP -.TP 2 -o -\f2@serialField\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@docRoot}\fP -.TP 2 -o -\f2{@value}\fP -.RE -\f3An example of a field comment:\fP -.nf -\f3 -.fl - /** -.fl - * The X\-coordinate of the component. -.fl - * -.fl - * @see #getLocation() -.fl - */ -.fl - int x = 1263732; -.fl -\fP -.fi -.SS -Constructor and Method Documentation Tags -.LP -The following are the tags that can appear in the documentation comment for a constructor or method, except for \f2@return\fP, which cannot appear in a constructor, and \f2{@inheritDoc}\fP, which has certain restrictions. The \f2@serialData\fP tag can only be used in the doc comment for certain serialization methods. -.LP -\f3Method/Constructor Tags\fP -.RS 3 -.TP 2 -o -\f2@see\fP -.TP 2 -o -\f2@since\fP -.TP 2 -o -\f2@deprecated\fP -.TP 2 -o -\f2@param\fP -.TP 2 -o -\f2@return\fP -.TP 2 -o -\f2@throws\fP and \f2@exception\fP -.TP 2 -o -\f2@serialData\fP -.TP 2 -o -\f2{@link}\fP -.TP 2 -o -\f2{@linkplain}\fP -.TP 2 -o -\f2{@inheritDoc}\fP -.TP 2 -o -\f2{@docRoot}\fP -.RE -\f3An example of a method doc comment:\fP -.nf -\f3 -.fl - /** -.fl - * Returns the character at the specified index. An index -.fl - * ranges from <code>0</code> to <code>length() \- 1</code>. -.fl - * -.fl - * @param index the index of the desired character. -.fl - * @return the desired character. -.fl - * @exception StringIndexOutOfRangeException -.fl - * if the index is not in the range <code>0</code> -.fl - * to <code>length()\-1</code>. -.fl - * @see java.lang.Character#charValue() -.fl - */ -.fl - public char charAt(int index) { -.fl - ... -.fl - } -.fl -\fP -.fi -.SH "OPTIONS" -.LP -The javadoc tool uses doclets to determine its output. The Javadoc tool uses the default standard doclet unless a custom doclet is specified with the \-doclet option. The Javadoc tool provides a set of command\-line options that can be used with any doclet \-\- these options are described below under the sub\-heading Javadoc Options. The standard doclet provides an additional set of command\-line options that are described below under the sub\-heading Options Provided by the Standard Doclet. All option names are case\-insensitive, though their arguments can be case\-sensitive. -.LP +.TP +@serialData \fIdata-description\fR +Introduced in JDK 1\&.2 + +Uses the data description value to document the types and order of data in the serialized form\&. This data includes the optional data written by the \f3writeObject\fR method and all data (including base classes) written by the \f3Externalizable\&.writeExternal\fR method\&. + +The \f3@serialData\fR tag can be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.TP +@serialField \fIfield-name\fR\fIfield-type\fR\fIfield-description\fR +Introduced in JDK 1\&.2 + +Documents an \f3ObjectStreamField\fR component of the \f3serialPersistentFields\fR member of a \f3Serializable\fR class\&. Use one \f3@serialField\fR tag for each \f3ObjectStreamField\fR component\&. +.TP +@since \fIsince-text\fR +Introduced in JDK 1\&.1 + +Adds a \fISince\fR heading with the specified \f3since-text\fR value to the generated documentation\&. The text has no special internal structure\&. This tag is valid in any documentation comment: overview, package, class, interface, constructor, method, or field\&. This tag means that this change or feature has existed since the software release specified by the \f3since-text\fR value, for example: \f3@since 1\&.5\fR\&. + +For Java platform source code, the \f3@since\fR tag indicates the version of the Java platform API specification, which is not necessarily when the source code was added to the reference implementation\&. Multiple \f3@since\fR tags are allowed and are treated like multiple \f3@author\fR tags\&. You could use multiple tags when the program element is used by more than one API\&. +.TP +@throws \fIclass-name\fR\fIdescription\fR +Introduced in JDK 1\&.2 + +Behaves the same as the \f3@exception\fR tag\&. See @throws in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@exception + +The \f3@throws\fR tag adds a \fIThrows\fR subheading to the generated documentation, with the \f3class-name\fR and \f3description\fR text\&. The \fIclass-name\fR is the name of the exception that might be thrown by the method\&. This tag is valid only in the documentation comment for a method or constructor\&. If this class is not fully specified, then the \f3javadoc\fR command uses the search order to look up this class\&. Multiple \f3@throws\fR tags can be used in a specified documentation comment for the same or different exceptions\&. See Search Order for the @see Tag\&. + +To ensure that all checked exceptions are documented, when an \f3@throws\fR tag does not exist for an exception in the throws clause, the \f3javadoc\fR command adds that exception to the HTML output (with no description) as though it were documented with the \f3@throws\fR tag\&. + +The \f3@throws\fR documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method\&. The same is true for copying from an interface method to an implementing method\&. You can use the \f3{@inheritDoc}\fR tag to force the \f3@throws\fR tag to inherit documentation\&. +.TP +{@value \fIpackage\&.class#field\fR} +Introduced in JDK 1\&.4 + +Displays constant values\&. When the \f3{@value}\fR tag is used without an argument in the documentation comment of a static field, it displays the value of that constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * The value of this constant is {@value}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public static final String SCRIPT_START = "<script>"\fP +.fi +.nf +\f3\fR +.fi +.sp + + +When used with the argument \f3package\&.class#field\fR in any documentation comment, he \f3{@value}\fR tag displays the value of the specified constant: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Evaluates the script starting with {@value #SCRIPT_START}\&.\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3public String evalScript(String script) {}\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The argument \f3package\&.class#field\fR takes a form similar to that of the \f3@see\fR tag argument, except that the member must be a static field\&. + +The values of these constants are also displayed in Constant Field Values at http://docs\&.oracle\&.com/javase/8/docs/api/constant-values\&.html +.TP +@version \fIversion-text\fR +Introduced in JDK 1\&.0 + +Adds a \fIVersion\fR subheading with the specified \f3version-text\fR value to the generated documents when the \f3-version\fR option is used\&. This tag is intended to hold the current release number of the software that this code is part of, as opposed to the\f3@since\fR tag, which holds the release number where this code was introduced\&. The \f3version-text\fR value has no special internal structure\&. See @version in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#@version + +A documentation comment can contain multiple \f3@version\fR tags\&. When it makes sense, you can specify one release number per \f3@version\fR tag or multiple release numbers per tag\&. In the former case, the \f3javadoc\fR command inserts a comma (,) and a space between the names\&. In the latter case, the entire text is copied to the generated document without being parsed\&. Therefore, you can use multiple names per line when you want a localized name separator other than a comma\&. +.SH WHERE\ TAGS\ CAN\ BE\ USED +The following sections describe where tags can be used\&. Note that the following tags can be used in all documentation comments: \f3@see\fR, \f3@since\fR, \f3@deprecated\fR, \f3{@link}\fR, \f3{@linkplain}\fR, and \f3{@docroot}\fR\&. +.SS OVERVIEW\ TAGS +Overview tags are tags that can appear in the documentation comment for the overview page (which resides in the source file typically named overview\&.html)\&. Similar to any other documentation comments, these tags must appear after the main description +.PP +\fINote:\fR The \f3{@link}\fR tag has a bug in overview documents in Java SE 1\&.2\&. The text appears correctly but has no link\&. The \f3{@docRoot}\fR tag does not currently work in overview documents\&. +.PP +The overview tags are the following: +.PP +@see reference || @since since-text || @serialField field-name field-type field-description || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS PACKAGE\ TAGS +Package tags are tags that can appear in the documentation comment for a package, that resides in the source file named package\&.html or package-info\&.java\&. The \f3@serial\fR tag can only be used here with the \f3include\fR or \f3exclude\fR argument\&. +.PP +The package tags are the following: +.PP +@see reference || @since since-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@linkplain package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.SS CLASS\ AND\ INTERFACE\ TAGS +The following are tags that can appear in the documentation comment for a class or interface\&. The \f3@serial\fR tag can only be used within the documentation for a class or interface with an \f3include\fR or \f3exclude\fR argument\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @author name-text || @version version-text || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || +.PP +Class comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * A class representing a window on the screen\&.\fP +.fi +.nf +\f3 * For example:\fP +.fi +.nf +\f3 * <pre>\fP +.fi +.nf +\f3 * Window win = new Window(parent);\fP +.fi +.nf +\f3 * win\&.show();\fP +.fi +.nf +\f3 * </pre>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @author Sami Shaio\fP +.fi +.nf +\f3 * @version 1\&.13, 06/08/06\fP +.fi +.nf +\f3 * @see java\&.awt\&.BaseWindow\fP +.fi +.nf +\f3 * @see java\&.awt\&.Button\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3class Window extends BaseWindow {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS FIELD\ TAGS +These tags can appear in fields: +.PP +@see reference || @since since-text || @deprecated deprecated-text || @serial field-description | include | exclude || @serialField field-name field-type field-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@docRoot} || {@value package\&.class#field} +.PP +Field comment example: +.sp +.nf +\f3 /**\fP +.fi +.nf +\f3 * The X\-coordinate of the component\&.\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @see #getLocation()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 int x = 1263732;\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS CONSTRUCTOR\ AND\ METHOD\ TAGS +The following tags can appear in the documentation comment for a constructor or a method, except for the \f3@return\fR tag, which cannot appear in a constructor, and the \f3{@inheritDoc}\fR tag, which has restrictions\&. +.PP +@see reference || @since since-text || @deprecated deprecated-text || @param parameter-name description || @return description || @throws class-name description || @exception class-name description || @serialData data-description || {@link package\&.class#member label} || {@linkplain package\&.class#member label} || {@inheritDoc} || {@docRoot} +.PP +\fINote:\fR The \f3@serialData\fR tag can only be used in the documentation comment for the \f3writeObject\fR, \f3readObject\fR, \f3writeExternal\fR, \f3readExternal\fR, \f3writeReplace\fR, and \f3readResolve\fR methods\&. +.PP +Method comment example: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * Returns the character at the specified index\&. An index \fP +.fi +.nf +\f3 * ranges from <code>0</code> to <code>length() \- 1</code>\fP +.fi +.nf +\f3 *\fP +.fi +.nf +\f3 * @param index the index of the desired character\&.\fP +.fi +.nf +\f3 * @return the desired character\&.\fP +.fi +.nf +\f3 * @exception StringIndexOutOfRangeException \fP +.fi +.nf +\f3 * if the index is not in the range <code>0</code> \fP +.fi +.nf +\f3 * to <code>length()\-1</code>\fP +.fi +.nf +\f3 * @see java\&.lang\&.Character#charValue()\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3 public char charAt(int index) {\fP +.fi +.nf +\f3 \&.\&.\&.\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fR +.fi +.sp +.SH OPTIONS +The \f3javadoc\fR command uses doclets to determine its output\&. The \f3javadoc\fR command uses the default standard doclet unless a custom doclet is specified with the \f3-doclet\fR option\&. The \f3javadoc\fR command provides a set of command-line options that can be used with any doclet\&. These options are described in Javadoc Options\&. The standard doclet provides an additional set of command-line options that are described in Standard Doclet Options\&. All option names are not case-sensitive, but their arguments are case-sensitive\&. +.TP 0.2i +\(bu +See also Javadoc Options +.TP 0.2i +\(bu +See also Standard Doclet Options +.PP The options are: -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 82 -.nr 34 \n(.lu -.eo -.am 80 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\-\f21.1\fP -.br -\-author -.br -\-\f2bootclasspath\fP -.br -\-bottom -.br -\-\f2breakiterator\fP -.br -\-charset -.br -\-\f2classpath\fP -.br -\-d -.br -\-docencoding -.br -\-docfilessubdirs -.br -\-\f2doclet\fP -.br -\-\f2docletpath\fP -.br -\-doctitle -.br -\-\f2encoding\fP -.br -\-\f2exclude\fP -.br -\-excludedocfilessubdir -.br -\-\f2extdirs\fP -.br -\-footer -.br -\-group -.br -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\-header -.br -\-\f2help\fP -.br -\-helpfile -.br -\-\f2J\fP -.br -\-keywords -.br -\-link -.br -\-linkoffline -.br -\-linksource -.br -\-\f2locale\fP -.br -\-nocomment -.br -\-nodeprecated -.br -\-nodeprecatedlist -.br -\-nohelp -.br -\-noindex -.br -\-nonavbar -.br -\-noqualifier -.br -\-nosince -.br -\-notimestamp -.br -\-notree -.br -\-\f2overview\fP -.br -\-\f2package\fP -.br -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 82 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/4u -.if \n(.l<\n(82 .ll \n(82u -.in 0 -\-\f2private\fP -.br -\-\f2protected\fP -.br -\-\f2public\fP -.br -\-\f2quiet\fP -.br -\-serialwarn -.br -\-\f2source\fP -.br -\-\f2sourcepath\fP -.br -\-sourcetab -.br -\-splitindex -.br -\-stylesheetfile -.br -\-\f2subpackages\fP -.br -\-tag -.br -\-taglet -.br -\-tagletpath -.br -\-top -.br -\-title -.br -\-use -.br -\-\f2verbose\fP -.br -\-version -.br -\-windowtitle -.br -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.80 -.rm 80 -.nr 38 \n(a- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.81 -.rm 81 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 82 0 -.82 -.rm 82 -.nr 38 \n(c- -.if \n(82<\n(38 .nr 82 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr 42 \n(81+(3*\n(38) -.nr 82 +\n(42 -.nr TW \n(82 -.if t .if \n(TW>\n(.li .tm Table at line 2015 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ne \n(a|u+\n(.Vu -.ne \n(b|u+\n(.Vu -.ne \n(c|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u \n(82u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(42u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-127 -.LP -Options shown in \f2italic\fP are the Javadoc core options, which are provided by the front end of the Javadoc tool and are available to all doclets. The standard doclet itself provides the non\-italic options. -.SS -Javadoc Options -.RS 3 -.TP 3 -\-overview \ path/filename -Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by \f2path/filename\fP and place it on the Overview page (\f2overview\-summary.html\fP). The \f2path/filename\fP is relative to the current directory. -.br -.br -While you can use any name you want for \f2filename\fP and place it anywhere you want for \f2path\fP, a typical thing to do is to name it \f2overview.html\fP and place it in the source tree at the directory that contains the topmost package directories. In this location, no \f2path\fP is needed when documenting packages, since \f2\-sourcepath\fP will point to this file. For example, if the source tree for the \f2java.lang\fP package is \f2/src/classes/java/lang/\fP, then you could place the overview file at \f2/src/classes/overview.html\fP. See Real World Example. -.br -.br -For information about the file specified by \f2path/filename\fP, see overview comment file. -.br -.br -Note that the overview page is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) -.br -.br -The title on the overview page is set by \f2\-doctitle\fP. -.TP 3 -\-public -Shows only public classes and members. -.TP 3 -\-protected -Shows only protected and public classes and members. This is the default. -.TP 3 -\-package -Shows only package, protected, and public classes and members. -.TP 3 -\-private -Shows all classes and members. -.TP 3 -\-help -Displays the online help, which lists these javadoc and doclet command line options. -.TP 3 -\-doclet\ class -Specifies the class file that starts the doclet used in generating the documentation. Use the fully\-qualified name. This doclet defines the content and formats the output. If the \f4\-doclet\fP option is not used, javadoc uses the standard doclet for generating the default HTML format. This class must contain the \f2start(Root)\fP method. The path to this starting class is defined by the \f2\-docletpath\fP option. -.br -.br -For example, to call the MIF doclet, use: -.nf -\f3 -.fl - \-doclet com.sun.tools.doclets.mif.MIFDoclet -.fl -\fP -.fi -For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.TP 3 -\-docletpath\ classpathlist -Specifies the path to the doclet starting class file (specified with the \f2\-doclet\fP option) and any jar files it depends on. If the starting class file is in a jar file, then this specifies the path to that jar file, as shown in the example below. You can specify an absolute path or a path relative to the current directory. If \f2classpathlist\fP contains multiple paths or jar files, they should be separated with a colon (:) on Solaris and a semi\-colon (;) on Windows. This option is not necessary if the doclet starting class is already in the search path. -.br -.br -Example of path to jar file that contains the starting doclet class file. Notice the jar filename is included. -.nf -\f3 -.fl - \-docletpath /home/user/mifdoclet/lib/mifdoclet.jar -.fl -\fP -.fi -Example of path to starting doclet class file. Notice the class filename is omitted. -.nf -\f3 -.fl - \-docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/ -.fl -\fP -.fi -For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.TP 3 -\-1.1 -\f2This feature has been removed from Javadoc 1.4. There is no replacement for it. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1.1 (it never supported nested classes). If you need this option, use Javadoc 1.2 or 1.3 instead.\fP -.TP 3 -\-source release -Specifies the version of source code accepted. The following values for \f2release\fP are allowed: -.RS 3 -.TP 2 -o -\f31.5\fP \- javadoc accepts code containing generics and other language features introduced in JDK 1.5. The compiler defaults to the 1.5 behavior if the \f3\-source\fP flag is not used. -.TP 2 -o -\f31.4\fP \- javadoc accepts code containing assertions, which were introduced in JDK 1.4. -.TP 2 -o -\f31.3\fP \- javadoc does \f2not\fP support assertions, generics, or other language features introduced after JDK 1.3. +.PP +-1\&.1 || -author || -bootclasspath classpathlist || -bottom text || -breakiterator || -charset name || -classpath classpathlist || -d directory || -docencoding name || -docfilesubdirs || -doclet class || -docletpath classpathlist || -doctitle title || -encoding || -exclude packagename1:packagename2:\&.\&.\&. || -excludedocfilessubdir name1:name2 || -extdirs dirist || -footer footer || -group groupheading packagepattern:packagepattern || -header header || -help || -helpfile path\efilename || -Jflag || -keywords || -link extdocURL || -linkoffline extdocURL packagelistLoc || -linksource || -locale language_country_variant || -nocomment || -nodeprecated || -nodeprecatedlist || -nohelp || -noindex || -nonavbar || -noqualifier all | packagename1:packagename2\&.\&.\&. || -nosince || -notimestamp || -notree || -overview path/filename || -package || -private || -protected || -public || -quiet || -serialwarn || -source release || -sourcepath sourcepathlist || -sourcetab tablength || -splitindex || -stylesheet path/filename || -subpackages package1:package2:\&.\&.\&. || -tag tagname:Xaoptcmf:"taghead" || -taglet class || -tagletpath tagletpathlist || -title title || -top || -use || -verbose || -version || -windowtitle title +.PP +The following options are the core Javadoc options that are available to all doclets\&. The standard doclet provides the rest of the doclets: \f3-bootclasspath\fR, \f3-breakiterator\fR, \f3-classpath\fR, \f3-doclet\fR, \f3-docletpath\fR, \f3-encoding\fR, -\f3exclude\fR, \f3-extdirs\fR, \f3-help\fR, \f3-locale\fR, \f3-\fR\f3overview\fR, \f3-package\fR, \f3-private\fR, \f3-protected\fR, \f3-public\fR, \f3-quiet\fR, \f3-source\fR, \f3-sourcepath\fR, \f3-subpackages\fR, and \f3-verbose\fR\&. +.SS JAVADOC\ OPTIONS +.TP +-overview \fIpath/filename\fR +.br +Specifies that the \f3javadoc\fR command should retrieve the text for the overview documentation from the source file specified by the \fIpath/filename\fRand place it on the Overview page (overview-summary\&.html)\&. The \fIpath/filename\fRis relative to the current directory\&. + +While you can use any name you want for the \f3filename\fR value and place it anywhere you want for the path, it is typical to name it overview\&.html and place it in the source tree at the directory that contains the topmost package directories\&. In this location, no path is needed when documenting packages, because the \f3-sourcepath\fR option points to this file\&. + +For example, if the source tree for the \f3java\&.lang\fR package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview\&.html + +See Real-World Examples\&. + +For information about the file specified by \fIpath/filename,\fRsee Overview Comment Files\&. + +The overview page is created only when you pass two or more package names to the \f3javadoc\fR command\&. For a further explanation, see HTML Frames\&. The title on the overview page is set by \f3-doctitle\fR\&. +.TP +-Xdoclint:(all|none|[-]\fI<group>\fR) +.br +Reports warnings for bad references, lack of accessibility and missing Javadoc comments, and reports errors for invalid Javadoc syntax and missing HTML tags\&. + +This option enables the \f3javadoc\fR command to check for all documentation comments included in the generated output\&. As always, you can select which items to include in the generated output with the standard options \f3-public\fR, \f3-protected\fR, \f3-package\fR and \f3-private\fR\&. + +When the \f3-Xdoclint\fR is enabled, it reports issues with messages similar to the \f3javac\fR command\&. The \f3javadoc\fR command prints a message, a copy of the source line, and a caret pointing at the exact position where the error was detected\&. Messages may be either warnings or errors, depending on their severity and the likelihood to cause an error if the generated documentation were run through a validator\&. For example, bad references or missing Javadoc comments do not cause the \f3javadoc\fR command to generate invalid HTML, so these issues are reported as warnings\&. Syntax errors or missing HTML end tags cause the \f3javadoc\fR command to generate invalid output, so these issues are reported as errors\&. + +By default, the \f3-Xdoclint\fR option is enabled\&. Disable it with the option \f3-Xdoclint:none\fR\&. + +Change what the \f3-Xdoclint\fR option reports with the following options: +.RS +.TP 0.2i +\(bu +\f3-Xdoclint none\fR : disable the \f3-Xdoclint\fR option +.TP 0.2i +\(bu +\f3-Xdoclint\fR\fIgroup\fR : enable \fIgroup\fR checks +.TP 0.2i +\(bu +\f3-Xdoclint all\fR : enable all groups of checks +.TP 0.2i +\(bu +\f3-Xdoclint all,\fR\fI-group\fR : enable all except \fIgroup\fR checks .RE -Use the value of \f2release\fP corresponding to that used when compiling the code with javac. -.TP 3 -\-sourcepath\ sourcepathlist -Specifies the search paths for finding source files (\f2.java\fP) when passing package names or \f2\-subpackages\fP into the \f2javadoc\fP command. The \f2sourcepathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented but whose comments are inherited by the source files being documented. -.br -.br -Note that you can use the \f2\-sourcepath\fP option only when passing package names into the javadoc command \-\- it will not locate \f2.java\fP files passed into the \f2javadoc\fP command. (To locate \f2.java\fP files, cd to that directory or include the path ahead of each file, as shown at Documenting One or More Classes.) If \f2\-sourcepath\fP is omitted, javadoc uses the class path to find the source files (see \-classpath). Therefore, the default \-sourcepath is the value of class path. If \-classpath is omitted and you are passing package names into javadoc, it looks in the current directory (and subdirectories) for the source files. -.br -.br -Set \f2sourcepathlist\fP to the root directory of the source tree for the package you are documenting. For example, suppose you want to document a package called \f2com.mypackage\fP whose source files are located at: -.nf -\f3 -.fl - /home/user/src/com/mypackage/*.java -.fl -\fP -.fi -In this case you would specify the \f2sourcepath\fP to \f2/home/user/src\fP, the directory that contains \f2com/mypackage\fP, and then supply the package name \f2com.mypackage\fP: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user/src/ com.mypackage\fP -.fl -.fi -This is easy to remember by noticing that if you concatenate the value of sourcepath and the package name together and change the dot to a slash "/", you end up with the full path to the package: \f2/home/user/src/com/mypackage\fP. -.br -.br -To point to two source paths: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com.mypackage\fP -.fl -.fi -.TP 3 -\-classpath\ classpathlist -Specifies the paths where javadoc will look for referenced classes (\f2.class\fP files) \-\- these are the documented classes plus any classes referenced by those classes. The \f2classpathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. Follow the instructions in -.na -\f2class path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general documentation for specifying \f2classpathlist\fP. -.br -.br -If \f2\-sourcepath\fP is omitted, the Javadoc tool uses \f2\-classpath\fP to find the source files as well as class files (for backward compatibility). Therefore, if you want to search for source and class files in separate paths, use both \f2\-sourcepath\fP and \f2\-classpath\fP. -.br -.br -For example, if you want to document \f2com.mypackage\fP, whose source files reside in the directory \f2/home/user/src/com/mypackage\fP, and if this package relies on a library in \f2/home/user/lib\fP, you would specify: -.nf -\f3 -.fl - % \fP\f3javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage\fP -.fl -.fi -As with other tools, if you do not specify \f2\-classpath\fP, the Javadoc tool uses the CLASSPATH environment variable, if it is set. If both are not set, the Javadoc tool searches for classes from the current directory. -.br -.br -For an in\-depth description of how the Javadoc tool uses \f2\-classpath\fP to find user classes as it relates to extension classes and bootstrap classes, see -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html. -.br -.br -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a Java program cannot tell the difference between the two invocations). -.br -.br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.TP 3 -\-subpackages\ \ package1:package2:... -Generates documentation from source files in the specified packages and recursively in their subpackages. This option is useful when adding new subpackages to the source code, as they are automatically included. Each \f2package\fP argument is any top\-level subpackage (such as \f2java\fP) or fully qualified package (such as \f2javax.swing\fP) that does not need to contain source files. Arguments are separated by colons (on all operating systmes). Wildcards are not needed or allowed. Use \f2\-sourcepath\fP to specify where to find the packages. This option is smart about not processing source files that are in the source tree but do not belong to the packages, as described at processing of source files. -.br -.br -For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP -.fl -.fi -This command generates documentation for packages named "java" and "javax.swing" and all their subpackages. -.br -.br -You can use \f2\-subpackages\fP in conjunction with \f2\-exclude\fP to exclude specific packages. -.TP 3 -\-exclude\ \ packagename1:packagename2:... -Unconditionally excludes the specified packages and their subpackages from the list formed by \f2\-subpackages\fP. It excludes those packages even if they would otherwise be included by some previous or later \f2\-subpackages\fP option. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude java.net:java.lang\fP -.fl -.fi -would include \f2java.io\fP, \f2java.util\fP, and \f2java.math\fP (among others), but would exclude packages rooted at \f2java.net\fP and \f2java.lang\fP. Notice this excludes \f2java.lang.ref\fP, a subpackage of \f2java.lang\fP). -.TP 3 -\-bootclasspath\ classpathlist -Specifies the paths where the boot classes reside. These are nominally the Java platform classes. The bootclasspath is part of the search path the Javadoc tool will use to look up source and class files. See -.na -\f2How Classes Are Found\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfiles. for more details. Separate directories in \f2classpathlist\fP with colons (:). -.TP 3 -\-extdirs\ dirlist -Specifies the directories where extension classes reside. These are any classes that use the Java Extension mechanism. The extdirs is part of the search path the Javadoc tool will use to look up source and class files. See \f2\-classpath\fP (above) for more details. Separate directories in \f2dirlist\fP with colons (:). -.TP 3 -\-verbose -Provides more detailed messages while javadoc is running. Without the verbose option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting. The verbose option causes the printing of additional messages specifying the number of milliseconds to parse each java source file. -.TP 3 -\-quiet -Shuts off non\-error and non\-warning messages, leaving only the warnings and errors appear, making them easier to view. Also suppresses the version string. -.TP 3 -\-breakiterator\ -Uses the internationalized sentence boundary of -.na -\f2java.text.BreakIterator\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/text/BreakIterator.html to determine the end of the first sentence for English (all other locales already use \f2BreakIterator\fP), rather than an English language, locale\-specific algorithm. By \f2first sentence\fP, we mean the first sentence in the main description of a package, class or member. This sentence is copied to the package, class or member summary, and to the alphabetic index. -.br -.br -From JDK 1.2 forward, the BreakIterator class is already used to determine the end of sentence for all languages but English. Therefore, the \f2\-breakiterator\fP option has no effect except for English from 1.2 forward. English has its own default algorithm: -.RS 3 -.TP 2 -o -English default sentence\-break algorithm \- Stops at a period followed by a space or a HTML block tag, such as \f2<P>\fP. -.TP 2 -o -Breakiterator sentence\-break algorithm \- In general, stops at a period, question mark or exclamation mark followed by a space if the next word starts with a capital letter. This is meant to handle most abbreviations (such as "The serial no. is valid", but won't handle "Mr. Smith"). Doesn't stop at HTML tags or sentences that begin with numbers or symbols. Stops at the last period in "../filename", even if embedded in an HTML tag. +.RS +The variable \fIgroup\fR has one of the following values: +.RS + .RE -NOTE: We have removed from 1.5.0 the breakiterator warning messages that were in 1.4.x and have left the default sentence\-break algorithm unchanged. That is, the \-breakiterator option is not the default in 1.5.0, nor do we expect it to become the default. This is a reversal from our former intention that the default would change in the "next major release" (1.5.0). This means if you have not modified your source code to eliminate the breakiterator warnings in 1.4.x, then you don't have to do anything, and the warnings go away starting with 1.5.0. The reason for this reversal is because any benefit to having breakiterator become the default would be outweighed by the incompatible source change it would require. We regret any extra work and confusion this has caused. -.TP 3 -\-locale\ language_country_variant -\f3Important\fP \- The \f2\-locale\fP option must be placed \f2ahead\fP (to the left) of any options provided by the standard doclet or any other doclet. Otherwise, the navigation bars will appear in English. This is the only command\-line option that is order\-dependent. -.br -.br -Specifies the locale that javadoc uses when generating documentation. The argument is the name of the locale, as described in java.util.Locale documentation, such as \f2en_US\fP (English, United States) or \f2en_US_WIN\fP (Windows variant). -.br -.br -Specifying a locale causes javadoc to choose the resource files of that locale for messages (strings in the navigation bar, headings for lists and tables, help file contents, comments in stylesheet.css, and so forth). It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence. It does not determine the locale of the doc comment text specified in the source files of the documented classes. -.TP 3 -\-encoding\ name -Specifies the encoding name of the source files, such as \f2EUCJIS/SJIS\fP. If this option is not specified, the platform default converter is used. -.br -.br -Also see \-docencoding and \-charset. -.TP 3 -\-Jflag -Passes \f2flag\fP directly to the runtime system java that runs javadoc. Notice there must be no space between the \f2J\fP and the \f2flag\fP. For example, if you need to ensure that the system sets aside 32 megabytes of memory in which to process the generated documentation, then you would call the \f2\-Xmx\fP option of java as follows (\f2\-Xms\fP is optional, as it only sets the size of initial memory, which is useful if you know the minimum amount of memory required): -.nf -\f3 -.fl - % \fP\f3javadoc \-J\-Xmx32m \-J\-Xms32m\fP \f3com.mypackage\fP -.fl -.fi -To tell what version of javadoc you are using, call the "\f2\-version\fP" option of java: -.nf -\f3 -.fl - % \fP\f3javadoc \-J\-version\fP -.fl - java version "1.2" -.fl - Classic VM (build JDK\-1.2\-V, green threads, sunwjit) -.fl -.fi -(The version number of the standard doclet appears in its output stream.) +.TP 0.2i +\(bu +\f3accessibility\fR : Checks for the issues to be detected by an accessibility checker (for example, no caption or summary attributes specified in a \f3<table>\fR tag)\&. +.TP 0.2i +\(bu +\f3html\fR : Detects high-level HTML issues, like putting block elements inside inline elements, or not closing elements that require an end tag\&. The rules are derived from theHTML 4\&.01 Specification\&. This type of check enables the \f3javadoc\fR command to detect HTML issues that many browsers might accept\&. +.TP 0.2i +\(bu +\f3missing\fR : Checks for missing Javadoc comments or tags (for example, a missing comment or class, or a missing \f3@return\fR tag or similar tag on a method)\&. +.TP 0.2i +\(bu +\f3reference\fR : Checks for issues relating to the references to Java API elements from Javadoc tags (for example, item not found in \f3@see\fR , or a bad name after \f3@param)\fR\&. +.TP 0.2i +\(bu +\f3syntax\fR : Checks for low level issues like unescaped angle brackets (\f3<\fR and \f3>\fR) and ampersands (\f3&\fR) and invalid Javadoc tags\&. .RE -.SS -Options Provided by the Standard Doclet -.RS 3 -.TP 3 -\-d\ directory -Specifies the destination directory where javadoc saves the generated HTML files. (The "d" means "destination.") Omitting this option causes the files to be saved to the current directory. The value \f2directory\fP can be absolute, or relative to the current working directory. As of 1.4, the destination directory is automatically created when javadoc is run. -.br -.br -For example, the following generates the documentation for the package \f2com.mypackage\fP and saves the results in the \f2/home/user/doc/\fP directory: -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/user/doc com.mypackage\fP -.fl -.fi -.TP 3 -\-use -Includes one "Use" page for each documented class and package. The page describes what packages, classes, methods, constructors and fields use any API of the given class or package. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C. -.br -.br -For example, let us look at what might appear on the "Use" page for String. The \f2getName()\fP method in the \f2java.awt.Font\fP class returns type \f2String\fP. Therefore, \f2getName()\fP uses \f2String\fP, and you will find that method on the "Use" page for \f2String\fP. -.br -.br -Note that this documents only uses of the API, not the implementation. If a method uses \f2String\fP in its implementation but does not take a string as an argument or return a string, that is not considered a "use" of \f2String\fP. -.br -.br -You can access the generated "Use" page by first going to the class or package, then clicking on the "Use" link in the navigation bar. -.TP 3 -\-version -Includes the @version text in the generated docs. This text is omitted by default. To tell what version of the Javadoc tool you are using, use the \f2\-J\-version\fP option. -.TP 3 -\-author -Includes the @author text in the generated docs. -.TP 3 -\-splitindex -Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non\-alphabetical characters. -.TP 3 -\-windowtitle\ title -Specifies the title to be placed in the HTML <title> tag. This appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page. This title should not contain any HTML tags, as the browser will not properly interpret them. Any internal quotation marks within \f2title\fP may have to be escaped. If \-windowtitle is omitted, the Javadoc tool uses the value of \-doctitle for this option. -.nf -\f3 -.fl - % \fP\f3javadoc \-windowtitle "Java SE Platform" com.mypackage\fP -.fl -.fi -.TP 3 -\-doctitle\ title -Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level\-one heading directly beneath the upper navigation bar. The \f2title\fP may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2title\fP may have to be escaped. -.nf -\f3 -.fl - % \fP\f3javadoc \-doctitle "Java(TM)" com.mypackage\fP -.fl -.fi -.TP 3 -\-title\ title -\f3This option no longer exists.\fP It existed only in Beta versions of Javadoc 1.2. It has been renamed to \f2\-doctitle\fP. This option is being renamed to make it clear that it defines the document title rather than the window title. -.TP 3 -\-header\ header -Specifies the header text to be placed at the top of each output file. The header will be placed to the right of the upper navigation bar. \f2header\fP may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2header\fP may have to be escaped. -.nf -\f3 -.fl - % \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP -.fl -.fi -.TP 3 -\-footer\ footer -Specifies the footer text to be placed at the bottom of each output file. The footer will be placed to the right of the lower navigation bar. \f2footer\fP may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2footer\fP may have to be escaped. -.TP 3 -\-top -Specifies the text to be placed at the top of each output file. -.TP 3 -\-bottom\ text -Specifies the text to be placed at the bottom of each output file. The text will be placed at the bottom of the page, below the lower navigation bar. The \f2text\fP may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within \f2text\fP may have to be escaped. -.TP 3 -\-link\ extdocURL -Creates links to existing javadoc\-generated documentation of external referenced classes. It takes one argument: -.RS 3 -.TP 2 -o -\f4extdocURL\fP is the absolute or relative URL of the directory containing the external javadoc\-generated documentation you want to link to. Examples are shown below. The package\-list file must be found in this directory (otherwise, use \f2\-linkoffline\fP). The Javadoc tool reads the package names from the \f2package\-list\fP file and then links to those packages at that URL. When the Javadoc tool is run, the \f2extdocURL\fP value is copied literally into the \f2<A HREF>\fP links that are created. Therefore, \f2extdocURL\fP must be the URL to the \f2directory\fP, not to a file. -.br -.br -You can use an absolute link for \f2extdocURL\fP to enable your docs to link to a document on any website, or can use a relative link to link only to a relative location. If relative, the value you pass in should be the relative path from the destination directory (specified with \f2\-d\fP) to the directory containing the packages being linked to. -.br -.br -When specifying an absolute link you normally use an \f2http:\fP link. However, if you want to link to a file system that has no web server, you can use a \f2file:\fP link \-\- however, do this only if everyone wanting to access the generated documentation shares the same file system. -.br -.br -In all cases, and on all operating systems, you should use a forward slash as the separator, whether the URL is absolute or relative, and "http:" or "file:" based (as specified in the -.na -\f2URL Memo\fP @ -.fi -http://www.ietf.org/rfc/rfc1738.txt). -.RS 3 -.TP 3 -Absolute http: based link: -\f2\-link http://<host>/<directory>/<directory>/.../<name>\fP -.TP 3 -Absolute file: based link: -\f2\-link file://<host>/<directory>/<directory>/.../<name>\fP -.TP 3 -Relative link: -\f2\-link <directory>/<directory>/.../<name>\fP +.RS +You can specify the \f3-Xdoclint\fR option multiple times to enable the option to check errors and warnings in multiple categories\&. Alternatively, you can specify multiple error and warning categories by using the preceding options\&. For example, use either of the following commands to check for the HTML, syntax, and accessibility issues in the file \fIfilename\fR\&. +.sp +.nf +\f3javadoc \-Xdoclint:html \-Xdoclint:syntax \-Xdoclint:accessibility \fIfilename\fR\fP +.fi +.nf +\f3javadoc \-Xdoclint:html,syntax,accessibility \fIfilename\fR\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fINote:\fR The \f3javadoc\fR command does not guarantee the completeness of these checks\&. In particular, it is not a full HTML compliance checker\&. The goal of the -\f3Xdoclint\fR option is to enable the \f3javadoc\fR command to report majority of common errors\&. + +The \f3javadoc\fR command does not attempt to fix invalid input, it just reports it\&. + .RE +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. This is the default\&. +.TP +-package +.br +Shows only package, protected, and public classes and members\&. +.TP +-private +.br +Shows all classes and members\&. +.TP +-help +.br +Displays the online help, which lists all of the \f3javadoc\fR and \f3doclet\fR command-line options\&. +.TP +-doclet \fIclass\fR +.br +Specifies the class file that starts the doclet used in generating the documentation\&. Use the fully qualified name\&. This doclet defines the content and formats the output\&. If the \f3-doclet\fR option is not used, then the \f3javadoc\fR command uses the standard doclet for generating the default HTML format\&. This class must contain the \f3start(Root)\fR method\&. The path to this starting class is defined by the \f3-docletpath\fR option\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-docletpath \fIclasspathlist\fR +.br +Specifies the path to the doclet starting class file (specified with the \f3-doclet\fR option) and any JAR files it depends on\&. If the starting class file is in a JAR file, then this option specifies the path to that JAR file\&. You can specify an absolute path or a path relative to the current directory\&. If \f3classpathlist\fR contains multiple paths or JAR files, then they should be separated with a colon (:) on Oracle Solaris and a semi-colon (;) on Windows\&. This option is not necessary when the doclet starting class is already in the search path\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.TP +-1\&.1 +.br +Removed from Javadoc 1\&.4 with no replacement\&. This option created documentation with the appearance and functionality of documentation generated by Javadoc 1\&.1 (it never supported nested classes)\&. If you need this option, then use Javadoc 1\&.2 or 1\&.3 instead\&. +.TP +-source \fIrelease\fR +.br +Specifies the release of source code accepted\&. The following values for the \f3release\fR parameter are allowed\&. Use the value of \f3release\fR that corresponds to the value used when you compile code with the \f3javac\fR command\&. +.RS +.TP 0.2i +\(bu +\fIRelease Value: 1\&.5\fR\&. The \f3javadoc\fR command accepts code containing generics and other language features introduced in JDK 1\&.5\&. The compiler defaults to the 1\&.5 behavior when the \f3-source\fR option is not used\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.4\fR\&. The \f3javadoc\fR command accepts code containing assertions, which were introduced in JDK 1\&.4\&. +.TP 0.2i +\(bu +\fIRelease Value: 1\&.3\fR\&. The \f3javadoc\fR command does not support assertions, generics, or other language features introduced after JDK 1\&.3\&. +.RE + +.TP +-sourcepath \fIsourcepathlist\fR +.br +Specifies the search paths for finding source files when passing package names or the \f3-subpackages\fR option into the \f3javadoc\fR command\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Note that this option is not only used to locate the source files being documented, but also to find source files that are not being documented, but whose comments are inherited by the source files being documented\&. + +You can use the \f3-sourcepath\fR option only when passing package names into the \f3javadoc\fR command\&. This will not locate source files passed into the \f3javadoc\fR command\&. To locate source files, \f3\fRchange to that directory or include the path ahead of each file, as shown at Document One or More Classes\&. If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses the class path to find the source files (see \f3-classpath\fR)\&. The default \f3-sourcepath\fR is the value of class path\&. If \f3-classpath\fR is omitted and you pass package names into the \f3javadoc\fR command, then the \f3javadoc\fR command searches in the current directory and subdirectories for the source files\&. + +Set \f3sourcepathlist\fR to the root directory of the source tree for the package you are documenting\&. + +For example, suppose you want to document a package called \f3com\&.mypackage\fR, whose source files are located at:/home/user/src/com/mypackage/*\&.java\&. Specify the sourcepath to /home/user/src, the directory that contains com\emypackage, and then supply the package name, as follows: +.sp +.nf +\f3javadoc \-sourcepath /home/user/src/ com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Notice that if you concatenate the value of sourcepath and the package name together and change the dot to a slash (/), then you have the full path to the package: + +/home/user/src/com/mypackage + +To point to two source paths: +.sp +.nf +\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-classpath \fIclasspathlist\fR +.br +Specifies the paths where the \f3javadoc\fR command searches for referenced classes These are the documented classes plus any classes referenced by those classes\&. Separate multiple paths with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. Follow the instructions in the class path documentation for specifying the \f3classpathlist\fR value\&. + +If you omit \f3-sourcepath\fR, then the \f3javadoc\fR command uses \f3-classpath\fR to find the source files and class files (for backward compatibility)\&. If you want to search for source and class files in separate paths, then use both \f3-sourcepath\fR and \f3-classpath\fR\&. + +For example, if you want to document \f3com\&.mypackage\fR, whose source files reside in the directory /home/user/src/com/mypackage, and if this package relies on a library in /home/user/libthen you would use the following command: +.sp +.nf +\f3javadoc \-sourcepath /home/user/lib \-classpath /home/user/src com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + + +Similar to other tools, if you do not specify \f3-classpath\fR, then the \f3javadoc\fR command uses the \f3CLASSPATH\fR environment variable when it is set\&. If both are not set, then the \f3javadoc\fR command searches for classes from the current directory\&. + +For an in-depth description of how the \f3javadoc\fR command uses \f3-classpath\fR to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +A class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JA\fRR, then the class path element \f3foo/*\fR is expanded to a \f3A\&.jar:b\&.JAR\fR, except that the order of JAR files is unspecified\&. All JAR files in the specified directory including hidden files are included in the list\&. A class path entry that consists of * expands to a list of all the jar files in the current directory\&. The \f3CLASSPATH\fR environment variable is similarly expanded\&. Any class path wildcard expansion occurs before the Java Virtual Machine (JVM) starts\&. No Java program ever sees unexpanded wild cards except by querying the environment, for example, by calling System\&.getenv(\f3"CLASSPATH"\fR)\&. +.TP +-subpackages \fIpackage1:package2:\&.\&.\&.\fR +.br +Generates documentation from source files in the specified packages and recursively in their subpackages\&. This option is useful when adding new subpackages to the source code because they are automatically included\&. Each package argument is any top-level subpackage (such as \f3java\fR) or fully qualified package (such as \f3javax\&.swing\fR) that does not need to contain source files\&. Arguments are separated by colons on all operating systems\&. Wild cards are not allowed\&. Use \f3-sourcepath\fR to specify where to find the packages\&. This option does not process source files that are in the source tree but do not belong to the packages\&. See Process Source Files\&. + +For example, the following command generates documentation for packages named \f3java\fR and \f3javax\&.swing\fR and all of their subpackages\&. +.sp +.nf +\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax\&.swing \fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-exclude \fIpackagename1:packagename2:\&.\&.\&.\fR +.br +Unconditionally excludes the specified packages and their subpackages from the list formed by \f3-subpackages\fR\&. It excludes those packages even when they would otherwise be included by some earlier or later \f3-subpackages\fR option\&. + +The following example would include \f3java\&.io\fR, \f3java\&.util\fR, and \f3java\&.math\fR (among others), but would exclude packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice that this example excludes \f3java\&.lang\&.ref\fR, which is a subpackage of \f3java\&.lang\fR\&. +.sp +.nf +\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude \fP +.fi +.nf +\f3 java\&.net:java\&.lang\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-bootclasspath \fIclasspathlist\fR +.br +Specifies the paths where the boot classes reside\&. These are typically the Java platform classes\&. The \f3bootclasspath\fR is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. For more information, see How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html + +Separate directories in the \f3classpathlist\fR parameters with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-extdirs \fIdirist\fR +.br +Specifies the directories where extension classes reside\&. These are any classes that use the Java Extension mechanism\&. The \f3extdirs\fR option is part of the search path the \f3javadoc\fR command uses to look up source and class files\&. See the \f3-classpath\fR option for more information\&. Separate directories in \f3dirlist\fR with semicolons (;) for Windows and colons (:) for Oracle Solaris\&. +.TP +-verbose +.br +Provides more detailed messages while the \f3javadoc\fR command runs\&. Without the \f3verbose\fR option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting\&. The verbose option causes the printing of additional messages that specify the number of milliseconds to parse each Java source file\&. +.TP +-quiet +.br +Shuts off messages so that only the warnings and errors appear to make them easier to view\&. It also suppresses the \f3version\fR string\&. +.TP +-breakiterator +.br +Uses the internationalized sentence boundary of \f3java\&.text\&.BreakIterator\fR to determine the end of the first sentence in the main description of a package, class, or member for English\&. All other locales already use the \f3BreakIterator\fR class, rather than an English language, locale-specific algorithm\&. The first sentence is copied to the package, class, or member summary and to the alphabetic index\&. From JDK 1\&.2 and later, the \f3BreakIterator\fR class is used to determine the end of a sentence for all languages except for English\&. Therefore, the \f3-breakiterator\fR option has no effect except for English from 1\&.2 and later\&. English has its own default algorithm: +.RS +.TP 0.2i +\(bu +English default sentence-break algorithm\&. Stops at a period followed by a space or an HTML block tag, such as \f3<P>\fR\&. +.TP 0.2i +\(bu +Breakiterator sentence-break algorithm\&. Stops at a period, question mark, or exclamation point followed by a space when the next word starts with a capital letter\&. This is meant to handle most abbreviations (such as "The serial no\&. is valid", but will not handle "Mr\&. Smith")\&. The \f3-breakiterator\fR option does not stop at HTML tags or sentences that begin with numbers or symbols\&. The algorithm stops at the last period in \&.\&./filename, even when embedded in an HTML tag\&. .RE -You can specify multiple \f2\-link\fP options in a given javadoc run to link to multiple documents. -.br -.br -\f3Choosing between \-linkoffline and \-link\fP: -.br -.br -Use \f2\-link\fP: -.RS 3 -.TP 2 -o -when using a relative path to the external API document, or -.TP 2 -o -when using an absolute URL to the external API document, if your shell allows a program to open a connection to that URL for reading. +.RS +In Java SE 1\&.5 the \f3-breakiterator\fR option warning messages are removed, and the default sentence-break algorithm is unchanged\&. If you have not modified your source code to eliminate the \f3-breakiterator\fR option warnings in Java SE 1\&.4\&.x, then you do not have to do anything\&. The warnings go away starting with Java SE 1\&.5\&.0\&. + .RE -Use \f2\-linkoffline\fP: -.RS 3 -.TP 2 -o -when using an absolute URL to the external API document, if your shell \f2does not allow\fP a program to open a connection to that URL for reading. This can occur if you are behind a firewall and the document you want to link to is on the other side. +.TP +-locale \fIlanguage_country_variant\fR +.br +Specifies the locale that the \f3javadoc\fR command uses when it generates documentation\&. The argument is the name of the locale, as described in \f3j\fR\f3ava\&.util\&.Locale\fR documentation, such as \f3en_US\fR (English, United States) or \f3en_US_WIN\fR (Windows variant)\&. + +\fINote:\fR The \f3-locale\fR option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet\&. Otherwise, the navigation bars appear in English\&. This is the only command-line option that depends on order\&. See Standard Doclet Options\&. + +Specifying a locale causes the \f3javadoc\fR command to choose the resource files of that locale for messages such as strings in the navigation bar, headings for lists and tables, help file contents, comments in the stylesheet\&.css file, and so on\&. It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence\&. The \f3-locale\fR option does not determine the locale of the documentation comment text specified in the source files of the documented classes\&. +.TP +-encoding +.br +Specifies the encoding name of the source files, such as \f3EUCJIS/SJIS\fR\&. If this option is not specified, then the platform default converter is used\&. See also the\f3-docencoding name\fR and \f3-charset name\fR options\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Runtime Environment (JRE) that runs the \f3javadoc\fR command\&. For example, if you must ensure that the system sets aside 32 MB of memory in which to process the generated documentation, then you would call the \f3-Xmx\fR option as follows: \f3javadoc -J-Xmx32m -J-Xms32m com\&.mypackage\fR\&. Be aware that \f3-Xms\fR is optional because it only sets the size of initial memory, which is useful when you know the minimum amount of memory required\&. + +There is no space between the \f3J\fR and the \f3flag\fR\&. + +Use the \f3-version\fR option to find out what version of the \f3javadoc\fR command you are using\&. The version number of the standard doclet appears in its output stream\&. See Running the Javadoc Command\&. +.sp +.nf +\f3javadoc \-J\-version\fP +.fi +.nf +\f3java version "1\&.7\&.0_09"\fP +.fi +.nf +\f3Java(TM) SE Runtime Environment (build 1\&.7\&.0_09\-b05)\fP +.fi +.nf +\f3Java HotSpot(TM) 64\-Bit Server VM (build 23\&.5\-b02, mixed mode)\fP +.fi +.nf +\f3\fR +.fi +.sp + +.SS STANDARD\ DOCLET\ OPTIONS +.TP +-d \fIdirectory\fR +.br +Specifies the destination directory where the \f3javadoc\fR command saves the generated HTML files\&. If you omit the \f3-d\fR option, then the files are saved to the current directory\&. The \f3directory\fR value can be absolute or relative to the current working directory\&. As of Java SE 1\&.4, the destination directory is automatically created when the \f3javadoc\fR command runs\&. + +For example, the following command generates the documentation for the package \f3com\&.mypackage\fR and saves the results in the /user/doc/ directory: \f3javadoc -d\fR\f3/user/doc/\fR\f3com\&.mypackage\fR\&. +.TP +-use +.br +Includes one Use page for each documented class and package\&. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package\&. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C\&. For example, you can look at the Use page for the \f3String\fR type\&. Because the \f3getName\fR method in the \f3java\&.awt\&.Font\fR class returns type \f3String\fR, the \f3getName\fR method uses \f3String\fR and so the \f3getName\fR method appears on the Use page for \f3String\fR\&.This documents only uses of the API, not the implementation\&. When a method uses \f3String\fR in its implementation, but does not take a string as an argument or return a string, that is not considered a use of \f3String\fR\&.To access the generated Use page, go to the class or package and click the \fIUse link\fR in the navigation bar\&. +.TP +-version +.br +Includes the @version text in the generated docs\&. This text is omitted by default\&. To find out what version of the \f3javadoc\fR command you are using, use the \f3-J-version\fR option\&. +.TP +-author +.br +Includes the \f3@author\fR text in the generated docs\&. +.TP +-splitindex +.br +Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical symbols\&. +.TP +-windowtitle \fItitle\fR +.br +Specifies the title to be placed in the HTML \f3<title>\fR tag\&. The text specified in the \f3title\fR tag appears in the window title and in any browser bookmarks (favorite places) that someone creates for this page\&. This title should not contain any HTML tags because the browser does not interpret them correctly\&. Use escape characters on any internal quotation marks within the \f3title\fR tag\&. If the \f3-windowtitle\fR option is omitted, then the \f3javadoc\fR command uses the value of the \f3-doctitle\fR option for the \f3-windowtitle\fR option\&. For example, \f3javadoc -windowtitle "Java SE Platform" com\&.mypackage\fR\&. +.TP +-doctitle \fItitle\fR +.br +Specifies the title to place near the top of the overview summary file\&. The text specified in the \f3title\fR tag is placed as a centered, level-one heading directly beneath the top navigation bar\&. The \f3title\fR tag can contain HTML tags and white space, but when it does, you must enclose the title in quotation marks\&. Internal quotation marks within the \f3title\fR tag must be escaped\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-title \fItitle\fR +.br +No longer exists\&. It existed only in Beta releases of Javadoc 1\&.2\&. It was renamed to \f3-doctitle\fR\&. This option was renamed to make it clear that it defines the document title, rather than the window title\&. +.TP +-header \fIheader\fR +.br +Specifies the header text to be placed at the top of each output file\&. The header is placed to the right of the upper navigation bar\&. The \f3header\fR can contain HTML tags and white space, but when it does, the \f3header\fR must be enclosed in quotation marks\&. Use escape characters for internal quotation marks within a header\&. For example, \f3javadoc -header "<b>Java Platform </b><br>v1\&.4" com\&.mypackage\&.\fR +.TP +-footer \fIfooter\fR +.br +Specifies the footer text to be placed at the bottom of each output file\&. The \fIfooter\fR value is placed to the right of the lower navigation bar\&. The \f3footer\fR value can contain HTML tags and white space, but when it does, the \f3footer\fR value must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within a footer\&. +.TP +-top +.br +Specifies the text to be placed at the top of each output file\&. +.TP +-bottom \fItext\fR +.br +Specifies the text to be placed at the bottom of each output file\&. The text is placed at the bottom of the page, underneath the lower navigation bar\&. The text can contain HTML tags and white space, but when it does, the text must be enclosed in quotation marks\&. Use escape characters for any internal quotation marks within text\&. +.TP +-link \fIextdocURL\fR +.br +Creates links to existing Javadoc-generated documentation of externally referenced classes\&. The \fIextdocURL\fR argument is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. You can specify multiple \f3-link\fR options in a specified \f3javadoc\fR command run to link to multiple documents\&. + +The package-list file must be found in this directory (otherwise, use the \f3-linkoffline\fR option)\&. The \f3javadoc\fR command reads the package names from the package-list file and links to those packages at that URL\&. When the \f3javadoc\fR command runs, the \f3extdocURL\fR value is copied into the \f3<A HREF>\fR links that are created\&. Therefore, \f3extdocURL\fR must be the URL to the directory, and not to a file\&. You can use an absolute link for \fIextdocURL\fR to enable your documents to link to a document on any web site, or you can use a relative link to link only to a relative location\&. If you use a relative link, then the value you pass in should be the relative path from the destination directory (specified with the \f3-d\fR option) to the directory containing the packages being linked to\&.When you specify an absolute link, you usually use an HTTP link\&. However, if you want to link to a file system that has no web server, then you can use a file link\&. Use a file link only when everyone who wants to access the generated documentation shares the same file system\&.In all cases, and on all operating systems, use a slash as the separator, whether the URL is absolute or relative, and \f3h\fR\f3ttp:\fR or \f3f\fR\f3ile:\fR as specified in the URL Memo: Uniform Resource Locators at http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.sp +.nf +\f3\-link http://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link file://<host>/<directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\-link <directory>/<directory>/\&.\&.\&./<name>\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Differences between the -linkoffline and -link options + +Use the \f3-link\fR option in the following cases: +.TP 0.2i +\(bu +When you use a relative path to the external API document\&. +.TP 0.2i +\(bu +When you use an absolute URL to the external API document if your shell lets you open a connection to that URL for reading\&. +.PP +Use the \f3-linkoffline\fR option when you use an absolute URL to the external API document, if your shell does not allow a program to open a connection to that URL for reading\&. This can occur when you are behind a firewall and the document you want to link to is on the other side\&. +.PP +\f3Example 1 Absolute Link to External Documents\fR +.PP +Use the following command if you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java platform packages, shown at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.sp +.nf +\f3javadoc \-link http://docs\&.oracle\&.com/javase/8/docs/api/ com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp +The command generates documentation for the package \f3com\&.mypackage\fR with links to the Java SE packages\&. The generated documentation contains links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other options, such as the \f3-sourcepath\fR and \f3-d\fR options, are not shown\&. +.PP +\f3Example 2 Relative Link to External Documents\fR +.PP +In this example, there are two packages with documents that are generated in different runs of the \f3javadoc\fR command, and those documents are separated by a relative path\&. The packages are \f3com\&.apipackage\fR, an API, and c\f3om\&.spipackage\fR, an Service Provide Interface (SPI)\&. You want the documentation to reside in docs/api/com/apipackage and docs/spi/com/spipackage\&. Assuming that the API package documentation is already generated, and that docs is the current directory, you document the SPI package with links to the API documentation by running: \f3javadoc -d \&./spi -link \&.\&./api com\&.spipackage\fR\&. +.PP +Notice the \f3-link\fR option is relative to the destination directory (docs/spi)\&. +.PP +Notes + +The \f3-link\fR option lets you link to classes referenced to by your code, but not documented in the current \f3javadoc\fR command run\&. For these links to go to valid pages, you must know where those HTML pages are located and specify that location with \f3extdocURL\fR\&. This allows third-party documentation to link to java\&.* documentation at http://docs\&.oracle\&.com\&.Omit the \f3-link\fR option when you want the \f3javadoc\fR command to create links only to APIs within the documentation it is generating in the current run\&. Without the \f3-link\fR option, the \f3javadoc\fR command does not create links to documentation for external references because it does not know whether or where that documentation exists\&.The \f3-link\fR option can create links in several places in the generated documentation\&. See Process Source Files\&. Another use is for cross-links between sets of packages: Execute the \f3javadoc\fR command on one set of packages, then run the \f3javadoc\fR command again on another set of packages, creating links both ways between both sets\&. +.PP +How to Reference a Class + +For a link to an externally referenced class to appear (and not just its text label), the class must be referenced in the following way\&. It is not sufficient for it to be referenced in the body of a method\&. It must be referenced in either an \f3import\fR statement or in a declaration\&. Here are examples of how the class \f3java\&.io\&.File\fR can be referenced: +.PP +\fI\fRIn any kind of import statement\&. By wildcard import, import explicitly by name, or automatically import for \f3java\&.lang\&.*\fR\&. +.PP +In Java SE 1\&.3\&.\fIn\fR and 1\&.2\&.\fIn\fR, only an explicit import by name works\&. A wildcard \f3import\fR statement does not work, nor does the automatic \f3import java\&.lang\&.*\fR\&. +.PP +\fI\fRIn a declaration: \f3void mymethod(File f) {}\fR +.PP +The reference can be in the return type or parameter type of a method, constructor, field, class, or interface, or in an implements, extends, or throws statement\&. +.PP +An important corollary is that when you use the \f3-link\fR option, there can be many links that unintentionally do not appear due to this constraint\&. The text would appear without being a link\&. You can detect these by the warnings they emit\&. The simplest way to properly reference a class and add the link would be to import that class\&. +.PP +Package List + +The \f3-link\fR option requires that a file named package-list, which is generated by the \f3javadoc\fR command, exists at the URL you specify with the \f3-link\fR option\&. The package-list file is a simple text file that lists the names of packages documented at that location\&. In the earlier example, the \f3javadoc\fR command searches for a file named package-list at the specified URL, reads in the package names, and links to those packages at that URL\&. +.PP +For example, the package list for the Java SE API is located at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.PP +The package list starts as follows: +.sp +.nf +\f3java\&.applet\fP +.fi +.nf +\f3java\&.awt\fP +.fi +.nf +\f3java\&.awt\&.color\fP +.fi +.nf +\f3java\&.awt\&.datatransfer\fP +.fi +.nf +\f3java\&.awt\&.dnd\fP +.fi +.nf +\f3java\&.awt\&.event\fP +.fi +.nf +\f3java\&.awt\&.font\fP +.fi +.nf +\f3and so on \&.\&.\&.\&.\fP +.fi +.nf +\f3\fR +.fi +.sp +When \f3javadoc\fR is run without the \f3-link\fR option and encounters a name that belongs to an externally referenced class, it prints the name with no link\&. However, when the \f3-link\fR option is used, the \f3javadoc\fR command searches the package-list file at the specified \fIextdocURL\fR location for that package name\&. When it finds the package name, it prefixes the name with \fIextdocURL\fR\&. +.PP +For there to be no broken links, all of the documentation for the external references must exist at the specified URLs\&. The \f3javadoc\fR command does not check that these pages exist, but only that the package-list exists\&. +.PP +Multiple Links + +You can supply multiple \f3-link\fR options to link to any number of externally generated documents\&. Javadoc 1\&.2 has a known bug that prevents you from supplying more than one \f3-link\fR options\&. This was fixed in Javadoc 1\&.2\&.2\&. Specify a different link option for each external document to link to \f3javadoc -link extdocURL1 -link extdocURL2 \&.\&.\&. -link extdocURLn com\&.mypackage\fR where \fIextdocURL1\fR, \fIextdocURL2\fR, \&.\f3\&.\&. extdocURLn\fR point respectively to the roots of external documents, each of which contains a file named package-list\&. +.PP +Cross Links + +Note that bootstrapping might be required when cross-linking two or more documents that were previously generated\&. If package-list does not exist for either document when you run the \f3javadoc\fR command on the first document, then the package-list does not yet exist for the second document\&. Therefore, to create the external links, you must regenerate the first document after you generate the second document\&. +.PP +In this case, the purpose of first generating a document is to create its package-list (or you can create it by hand if you are certain of the package names)\&. Then, generate the second document with its external links\&. The \f3javadoc\fR command prints a warning when a needed external package-list file does not exist\&. +.TP +-linkoffline \fIextdocURL packagelistLoc\fR +.br +This option is a variation of the \f3-link\fR option\&. They both create links to Javadoc-generated documentation for externally referenced classes\&. Use the \f3-link\fRo\f3ffline\fR option when linking to a document on the web when the \f3javadoc\fR command cannot access the document through a web connection\&. Use the \f3-linkoffline\fR option when package-list file of the external document is not accessible or does not exist at the \f3extdocURL\fR location, but does exist at a different location that can be specified by \f3packageListLoc\fR (typically local)\&. If \f3extdocURL\fR is accessible only on the World Wide Web, then the \f3-linkoffline\fR option removes the constraint that the \f3javadoc\fR command must have a web connection to generate documentation\&. Another use is as a work-around to update documents: After you have run the \f3javadoc\fR command on a full set of packages, you can run the \f3javadoc\fR command again on a smaller set of changed packages, so that the updated files can be inserted back into the original set\&. Examples follow\&. The \f3-linkoffline\fR option takes two arguments\&. The first is for the string to be embedded in the \f3<a href>\fR links, and the second tells the \f3-linkoffline\fR option where to find package-list: +.RS +.TP 0.2i +\(bu +The \f3extdocURL\fR value is the absolute or relative URL of the directory that contains the external Javadoc-generated documentation you want to link to\&. When relative, the value should be the relative path from the destination directory (specified with the \f3-d\fR option) to the root of the packages being linked to\&. For more information, see \fIextdocURL\fR in the \f3-link\fR option\&. +.TP 0.2i +\(bu +The \f3packagelistLoc\fR value is the path or URL to the directory that contains the package-list file for the external documentation\&. This can be a URL (http: or file:) or file path, and can be absolute or relative\&. When relative, make it relative to the current directory from where the \f3javadoc\fR command was run\&. Do not include the package-list file name\&. + +You can specify multiple \f3-linkoffline\fR options in a specified \f3javadoc\fR command run\&. Before Javadoc 1\&.2\&.2, the \f3-linkfile\fR options could be specified once\&. +.RE + +.PP +Absolute Links to External Documents + +You might have a situation where you want to link to the \f3java\&.lang\fR, \f3java\&.io\fR and other Java SE packages at http://docs\&.oracle\&.com/javase/8/docs/api/index\&.html +.PP +However, your shell does not have web access\&. In this case, do the following: +.TP 0.4i +1\&. +Open the package-list file in a browser at http://docs\&.oracle\&.com/javase/8/docs/api/package-list +.TP 0.4i +2\&. +Save the file to a local directory, and point to this local copy with the second argument, \f3packagelistLoc\fR\&. In this example, the package list file was saved to the current directory (\&.)\&. +.PP +The following command generates documentation for the package c\f3om\&.mypackage\fR with links to the Java SE packages\&. The generated documentation will contain links to the \f3Object\fR class, for example, in the class \f3trees\fR\&. Other necessary options, such as \f3-sourcepath\fR, are not shown\&. +.sp +.nf +\f3javadoc \-linkoffline http://docs\&.oracle\&.com/javase/8/docs/api/ \&. com\&.mypackage \fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Relative Links to External Documents + +It is not very common to use \f3-linkoffline\fR with relative paths, for the simple reason that the \f3-link\fR option is usually enough\&. When you use the \f3-linkoffline\fR option, the package-list file is usually local, and when you use relative links, the file you are linking to is also local, so it is usually unnecessary to give a different path for the two arguments to the \f3-linkoffline\fR option When the two arguments are identical, you can use the \f3-link\fR option\&. +.PP +Create a package-list File Manually + +If a package-list file does not exist yet, but you know what package names your document will link to, then you can manually create your own copy of this file and specify its path with \f3packagelistLoc\fR\&. An example would be the previous case where the package list for \f3com\&.spipackage\fR did not exist when \f3com\&.apipackage\fR was first generated\&. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published\&. This is also a way of creating package-list files for packages generated with Javadoc 1\&.0 or 1\&.1, where package-list files were not generated\&. Similarly, two companies can share their unpublished package-list files so they can release their cross-linked documentation simultaneously\&. +.PP +Link to Multiple Documents + +You can include the \f3-linkoffline\fR option once for each generated document you want to refer to: +.sp +.nf +\f3javadoc \-linkoffline extdocURL1 packagelistLoc1 \-linkoffline extdocURL2\fP +.fi +.nf +\f3packagelistLoc2 \&.\&.\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Update Documents + +You can also use the \f3-linkoffline\fR option when your project has dozens or hundreds of packages\&. If you have already run the \f3javadoc\fR command on the entire source tree, then you can quickly make small changes to documentation comments and rerun the \f3javadoc\fR command on a portion of the source tree\&. Be aware that the second run works properly only when your changes are to documentation comments and not to declarations\&. If you were to add, remove, or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, Use page, and other places\&. +.PP +First, create a new destination directory, such as update, for this new small run\&. In this example, the original destination directory is named html\&. In the simplest example, change directory to the parent of html\&. Set the first argument of the \f3-linkoffline\fR option to the current directory (\&.) and set the second argument to the relative path to html, where it can find package-list and pass in only the package names of the packages you want to update: +.sp +.nf +\f3javadoc \-d update \-linkoffline \&. html com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp +When the \f3javadoc\fR command completes, copy these generated class pages in update/com/package (not the overview or index) to the original files in html/com/package\&. +.TP +-linksource +.br +Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation\&. Links are created for classes, interfaces, constructors, methods, and fields whose declarations are in a source file\&. Otherwise, links are not created, such as for default constructors and generated classes\&. + +This option exposes all private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, regardless of the \f3-public\fR, \f3-package\fR, \f3-protected\fR, and \f3-private\fR options\&. Unless you also use the \f3-private\fR option, not all private classes or interfaces are accessible through links\&. + +Each link appears on the name of the identifier in its declaration\&. For example, the link to the source code of the \f3Button\fR class would be on the word \f3Button\fR: +.sp +.nf +\f3public class Button extends Component implements Accessible\fP +.fi +.nf +\f3\fR +.fi +.sp + + +The link to the source code of the \f3getLabel\fR method in the \f3Button\fR class is on the word \f3getLabel\fR: +.sp +.nf +\f3public String getLabel()\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-group groupheading \fIpackagepattern:packagepattern\fR +.br +Separates packages on the overview page into whatever groups you specify, one group per table\&. You specify each group with a different \f3-group\fR option\&. The groups appear on the page in the order specified on the command line\&. Packages are alphabetized within a group\&. For a specified \f3-group\fR option, the packages matching the list of \f3packagepattern\fR expressions appear in a table with the heading \fIgroupheading\fR\&. +.RS +.TP 0.2i +\(bu +The \f3groupheading\fR can be any text and can include white space\&. This text is placed in the table heading for the group\&. +.TP 0.2i +\(bu +The \f3packagepattern\fR value can be any package name at the start of any package name followed by an asterisk (*)\&. The asterisk is the only wildcard allowed and means match any characters\&. Multiple patterns can be included in a group by separating them with colons (:)\&. If you use an asterisk in a pattern or pattern list, then the pattern list must be inside quotation marks, such as \f3"java\&.lang*:java\&.util"\fR\&. .RE -.br -.br -\f3Example using absolute links to the external docs\fP \- Let us say you want to link to the \f2java.lang\fP, \f2java.io\fP and other Java Platform packages at -.na -\f2http://download.oracle.com/javase/7/docs/api/\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/. The following command generates documentation for the package \f2com.mypackage\fP with links to the Java SE Platform packages. The generated documentation will contain links to the \f2Object\fP class, for example, in the class trees. (Other options, such as \f2\-sourcepath\fP and \f2\-d\fP, are not shown.) -.nf -\f3 -.fl - % \fP\f3javadoc \-link http://download.oracle.com/javase/7/docs/api/ com.mypackage\fP -.fl -.fi -\f3Example using relative links to the external docs\fP \- Let us say you have two packages whose docs are generated in different runs of the Javadoc tool, and those docs are separated by a relative path. In this example, the packages are \f2com.apipackage\fP, an API, and \f2com.spipackage\fP, an SPI (Service Provide Interface). You want the documentation to reside in \f2docs/api/com/apipackage\fP and \f2docs/spi/com/spipackage\fP. Assuming the API package documentation is already generated, and that \f2docs\fP is the current directory, you would document the SPI package with links to the API documentation by running: -.nf -\f3 -.fl - % \fP\f3javadoc \-d ./spi \-link ../api com.spipackage\fP -.fl -.fi -Notice the \f2\-link\fP argument is relative to the destination directory (\f2docs/spi\fP). -.br -.br -\f3Details\fP \- The \f2\-link\fP option enables you to link to classes referenced to by your code but \f2not\fP documented in the current javadoc run. For these links to go to valid pages, you must know where those HTML pages are located, and specify that location with \f2extdocURL\fP. This allows, for instance, third party documentation to link to \f2java.*\fP documentation on \f2http://java.sun.com\fP. -.br -.br -Omit the \f2\-link\fP option for javadoc to create links only to API within the documentation it is generating in the current run. (Without the \f2\-link\fP option, the Javadoc tool does not create links to documentation for external references, because it does not know if or where that documentation exists.) -.br -.br -This option can create links in several places in the generated documentation. -.br -.br -Another use is for cross\-links between sets of packages: Execute javadoc on one set of packages, then run javadoc again on another set of packages, creating links both ways between both sets. -.br -.br -\f3How a Class Must be Referenced\fP \- For a link to an external referenced class to actually appear (and not just its text label), the class must be referenced in the following way. It is not sufficient for it to be referenced in the body of a method. It must be referenced in either an \f2import\fP statement or in a declaration. Here are examples of how the class \f2java.io.File\fP can be referenced: -.RS 3 -.TP 2 -o -In any kind of \f2import\fP statement: by wildcard import, import explicitly by name, or automatically import for \f2java.lang.*\fP. For example, this would suffice: -.br -\f2import java.io.*;\fP -.br -In 1.3.x and 1.2.x, only an explicit import by name works \-\- a wildcard import statement does not work, nor does the automatic import \f2java.lang.*\fP. -.TP 2 -o -In a declaration: -.br -\f2void foo(File f) {}\fP -.br -The reference and be in the return type or parameter type of a method, constructor, field, class or interface, or in an \f2implements\fP, \f2extends\fP or \f2throws\fP statement. +.RS +When you do not supply a \f3-group\fR option, all packages are placed in one group with the heading \fIPackages\fR and appropriate subheadings\&. If the subheadings do not include all documented packages (all groups), then the remaining packages appear in a separate group with the subheading Other Packages\&. + +For example, the following \f3javadoc\fR command separates the three documented packages into \fICore\fR, \fIExtension\fR, and \fIOther Packages\fR\&. The trailing dot (\&.) does not appear in \f3java\&.lang*\fR\&. Including the dot, such as \f3java\&.lang\&.*\fR omits the\f3java\&.lang\fR package\&. +.sp +.nf +\f3javadoc \-group "Core Packages" "java\&.lang*:java\&.util"\fP +.fi +.nf +\f3 \-group "Extension Packages" "javax\&.*"\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect java\&.util javax\&.servlet java\&.new\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fICore Packages\fR + +\f3java\&.lang\fR + +\f3java\&.lang\&.reflect\fR + +\f3java\&.util\fR + +\fIExtension Packages\fR + +\f3javax\&.servlet\fR + +\fIOther Packages\fR + +\f3java\&.new\fR + .RE -An important corollary is that when you use the \f2\-link\fP option, there may be many links that unintentionally do not appear due to this constraint. (The text would appear without a hypertext link.) You can detect these by the warnings they emit. The most innocuous way to properly reference a class and thereby add the link would be to import that class, as shown above. -.br -.br -\f3Package List\fP \- The \f2\-link\fP option requires that a file named \f2package\-list\fP, which is generated by the Javadoc tool, exist at the URL you specify with \f2\-link\fP. The \f2package\-list\fP file is a simple text file that lists the names of packages documented at that location. In the earlier example, the Javadoc tool looks for a file named \f2package\-list\fP at the given URL, reads in the package names and then links to those packages at that URL. -.br -.br -For example, the package list for the Java SE 6 API is located at -.na -\f2http://download.oracle.com/javase/7/docs/api/package\-list\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/package\-list. and starts as follows: -.nf -\f3 -.fl - java.applet -.fl - java.awt -.fl - java.awt.color -.fl - java.awt.datatransfer -.fl - java.awt.dnd -.fl - java.awt.event -.fl - java.awt.font -.fl - etc. -.fl -\fP -.fi -When javadoc is run without the \f2\-link\fP option, when it encounters a name that belongs to an external referenced class, it prints the name with no link. However, when the \f2\-link\fP option is used, the Javadoc tool searches the \f2package\-list\fP file at the specified \f2extdocURL\fP location for that package name. If it finds the package name, it prefixes the name with \f2extdocURL\fP. -.br -.br -In order for there to be no broken links, all of the documentation for the external references must exist at the specified URLs. The Javadoc tool will not check that these pages exist \-\- only that the package\-list exists. -.br -.br -\f3Multiple Links\fP \- You can supply multiple \f2\-link\fP options to link to any number of external generated documents. \ Javadoc 1.2 has a known bug which prevents you from supplying more than one \f2\-link\fP command. This was fixed in 1.2.2. -.br -.br -Specify a different link option for each external document to link to: -.br -.br -\ \ \f2% \fP\f4javadoc \-link\fP \f2extdocURL1\fP \f4\-link\fP \f2extdocURL2\fP \f2... \fP\f4\-link\fP \f2extdocURLn\fP \f4com.mypackage\fP -.br -.br -where \f2extdocURL1\fP,\ \f2extdocURL2\fP,\ ... \f2extdocURLn\fP point respectively to the roots of external documents, each of which contains a file named \f2package\-list\fP. -.br -.br -\f3Cross\-links\fP \- Note that "bootstrapping" may be required when cross\-linking two or more documents that have not previously been generated. In other words, if \f2package\-list\fP does not exist for either document, when you run the Javadoc tool on the first document, the \f2package\-list\fP will not yet exist for the second document. Therefore, to create the external links, you must re\-generate the first document after generating the second document. -.br -.br -In this case, the purpose of first generating a document is to create its \f2package\-list\fP (or you can create it by hand it if you're certain of the package names). Then generate the second document with its external links. The Javadoc tool prints a warning if a needed external \f2package\-list\fP file does not exist. -.TP 3 -\-linkoffline\ extdocURL\ packagelistLoc -This option is a variation of \f2\-link\fP; they both create links to javadoc\-generated documentation for external referenced classes. Use the \f2\-linkoffline\fP option when linking to a document on the web when the Javadoc tool itself is "offline" \-\- that is, it cannot access the document through a web connection. -.br -.br -More specifically, use \f2\-linkoffline\fP if the external document's \f2package\-list\fP file is not accessible or does not exist at the \f2extdocURL\fP location but does exist at a different location, which can be specified by \f2packageListLoc\fP (typically local). Thus, if \f2extdocURL\fP is accessible only on the World Wide Web, \f2\-linkoffline\fP removes the constraint that the Javadoc tool have a web connection when generating the documentation. -.br -.br -Another use is as a "hack" to update docs: After you have run javadoc on a full set of packages, then you can run javadoc again on onlya smaller set of changed packages, so that the updated files can be inserted back into the original set. Examples are given below. -.br -.br -The \f2\-linkoffline\fP option takes two arguments \-\- the first for the string to be embedded in the \f2<a href>\fP links, the second telling it where to find \f2package\-list\fP: -.RS 3 -.TP 2 -o -\f4extdocURL\fP is the absolute or relative URL of the directory containing the external javadoc\-generated documentation you want to link to. If relative, the value should be the relative path from the destination directory (specified with \f2\-d\fP) to the root of the packages being linked to. For more details, see \f2extdocURL\fP in the \f2\-link\fP option. -.TP 2 -o -\f4packagelistLoc\fP is the path or URL to the directory containing the \f2package\-list\fP file for the external documentation. This can be a URL (http: or file:) or file path, and can be absolute or relative. If relative, make it relative to the \f2current\fP directory from where javadoc was run. Do not include the \f2package\-list\fP filename. -.RE -You can specify multiple \f2\-linkoffline\fP options in a given javadoc run. (Prior to 1.2.2, it could be specified only once.) -.br -.br -\f3Example using absolute links to the external docs\fP \- Let us say you want to link to the \f2java.lang\fP, \f2java.io\fP and other Java SE Platform packages at \f2http://download.oracle.com/javase/7/docs/api/\fP, but your shell does not have web access. You could open the \f2package\-list\fP file in a browser at -.na -\f2http://download.oracle.com/javase/7/docs/api/package\-list\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/package\-list, save it to a local directory, and point to this local copy with the second argument, \f2packagelistLoc\fP. In this example, the package list file has been saved to the current directory "\f2.\fP" . The following command generates documentation for the package \f2com.mypackage\fP with links to the Java SE Platform packages. The generated documentation will contain links to the \f2Object\fP class, for example, in the class trees. (Other necessary options, such as \f2\-sourcepath\fP, are not shown.) -.nf -\f3 -.fl -% \fP\f3javadoc \-linkoffline http://download.oracle.com/javase/7/docs/api/ . com.mypackage\fP -.fl -.fi -\f3Example using relative links to the external docs\fP \- It's not very common to use \f2\-linkoffline\fP with relative paths, for the simple reason that \f2\-link\fP usually suffices. When using \f2\-linkoffline\fP, the \f2package\-list\fP file is generally local, and when using relative links, the file you are linking to is also generally local. So it is usually unnecessary to give a different path for the two arguments to \f2\-linkoffline\fP. When the two arguments are identical, you can use \f2\-link\fP. See the \f2\-link\fP relative example. -.br -.br -\f3Manually Creating a \fP\f4package\-list\fP\f3 File\fP \- If a \f2package\-list\fP file does not yet exist, but you know what package names your document will link to, you can create your own copy of this file by hand and specify its path with \f2packagelistLoc\fP. An example would be the previous case where the package list for \f2com.spipackage\fP did not exist when \f2com.apipackage\fP was first generated. This technique is useful when you need to generate documentation that links to new external documentation whose package names you know, but which is not yet published. This is also a way of creating \f2package\-list\fP files for packages generated with Javadoc 1.0 or 1.1, where \f2package\-list\fP files were not generated. Likewise, two companies can share their unpublished \f2package\-list\fP files, enabling them to release their cross\-linked documentation simultaneously. -.br -.br -\f3Linking to Multiple Documents\fP \- You can include \f2\-linkoffline\fP once for each generated document you want to refer to (each option is shown on a separate line for clarity): -.br -.br -\f2% \fP\f4javadoc \-linkoffline\fP \f2extdocURL1\fP \f2packagelistLoc1\fP \f2\\\fP -.br -\f2\ \ \ \ \ \ \ \ \ \ \fP\f4\-linkoffline\fP \f2extdocURL2\fP \f2packagelistLoc2\fP \f2\\\fP -.br -\f2\ \ \ \ \ \ \ \ \ \ ...\fP -.br -.br -\f3Updating docs\fP \- Another use for \f2\-linkoffline\fP option is useful if your project has dozens or hundreds of packages, if you have already run javadoc on the entire tree, and now, in a separate run, you want to quickly make some small changes and re\-run javadoc on just a small portion of the source tree. This is somewhat of a hack in that it works properly only if your changes are only to doc comments and not to declarations. If you were to add, remove or change any declarations from the source code, then broken links could show up in the index, package tree, inherited member lists, use page, and other places. -.br -.br -First, you create a new destination directory (call it \f2update\fP) for this new small run. Let us say the original destination directory was named \f2html\fP. In the simplest example, cd to the parent of \f2html\fP. Set the first argument of \f2\-linkoffline\fP to the current directory "." and set the second argument to the relative path to \f2html\fP, where it can find \f2package\-list\fP, and pass in only the package names of the packages you want to update: -.nf -\f3 -.fl - % \fP\f3javadoc \-d update \-linkoffline . html com.mypackage\fP -.fl -.fi -When the Javadoc tool is done, copy these generated class pages in \f2update/com/package\fP (not the overview or index), over the original files in \f2html/com/package\fP. -.TP 3 -\-linksource\ -Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation. Links are created for classes, interfaces, constructors, methods and fields whose declarations are in a source file. Otherwise, links are not created, such as for default constructors and generated classes. -.br -.br -\f3This option exposes \fP\f4all\fP\f3 private implementation details in the included source files, including private classes, private fields, and the bodies of private methods, \fP\f4regardless of the \fP\f4\-public\fP\f3, \fP\f4\-package\fP\f3, \fP\f4\-protected\fP\f3 and \fP\f4\-private\fP\f3 options.\fP Unless you also use the \f2\-private\fP option, not all private classes or interfaces will necessarily be accessible via links. -.br -.br -Each link appears on the name of the identifier in its declaration. For example, the link to the source code of the \f2Button\fP class would be on the word "Button": -.nf -\f3 -.fl - public class Button -.fl - extends Component -.fl - implements Accessible -.fl -\fP -.fi -and the link to the source code of the \f2getLabel()\fP method in the Button class would be on the word "getLabel": -.nf -\f3 -.fl - public String getLabel() -.fl -\fP -.fi -.TP 3 -\-group\ groupheading\ packagepattern:packagepattern:... -Separates packages on the overview page into whatever groups you specify, one group per table. You specify each group with a different \f2\-group\fP option. The groups appear on the page in the order specified on the command line; packages are alphabetized within a group. For a given \f2\-group\fP option, the packages matching the list of \f2packagepattern\fP expressions appear in a table with the heading \f2groupheading\fP. -.RS 3 -.TP 2 -o -\f4groupheading\fP can be any text, and can include white space. This text is placed in the table heading for the group. -.TP 2 -o -\f4packagepattern\fP can be any package name, or can be the start of any package name followed by an asterisk (\f2*\fP). The asterisk is a wildcard meaning "match any characters". This is the only wildcard allowed. Multiple patterns can be included in a group by separating them with colons (\f2:\fP). -.RE -\f3NOTE: If using an asterisk in a pattern or pattern list, the pattern list must be inside quotes, such as \fP\f4"java.lang*:java.util"\fP -.br -.br -If you do not supply any \f2\-group\fP option, all packages are placed in one group with the heading "Packages". If the all groups do not include all documented packages, any leftover packages appear in a separate group with the heading "Other Packages". -.br -.br -For example, the following option separates the four documented packages into core, extension and other packages. Notice the trailing "dot" does not appear in "java.lang*" \-\- including the dot, such as "java.lang.*" would omit the java.lang package. -.nf -\f3 -.fl - % \fP\f3javadoc \-group "Core Packages" "java.lang*:java.util" -.fl - \-group "Extension Packages" "javax.*" -.fl - java.lang java.lang.reflect java.util javax.servlet java.new\fP -.fl -.fi -This results in the groupings: -.RS 3 -.TP 3 -Core Packages -\f2java.lang\fP -\f2java.lang.reflect\fP -\f2java.util\fP -.TP 3 -Extension Packages -\f2javax.servlet\fP -.TP 3 -Other Packages -\f2java.new\fP -.RE -.TP 3 -\-nodeprecated -Prevents the generation of any deprecated API at all in the documentation. This does what \-nodeprecatedlist does, plus it does not generate any deprecated API throughout the rest of the documentation. This is useful when writing code and you don't want to be distracted by the deprecated code. -.TP 3 -\-nodeprecatedlist -Prevents the generation of the file containing the list of deprecated APIs (deprecated\-list.html) and the link in the navigation bar to that page. (However, javadoc continues to generate the deprecated API throughout the rest of the document.) This is useful if your source code contains no deprecated API, and you want to make the navigation bar cleaner. -.TP 3 -\-nosince -Omits from the generated docs the "Since" sections associated with the @since tags. -.TP 3 -\-notree -Omits the class/interface hierarchy pages from the generated docs. These are the pages you reach using the "Tree" button in the navigation bar. The hierarchy is produced by default. -.TP 3 -\-noindex -Omits the index from the generated docs. The index is produced by default. -.TP 3 -\-nohelp -Omits the HELP link in the navigation bars at the top and bottom of each page of output. -.TP 3 -\-nonavbar -Prevents the generation of the navigation bar, header and footer, otherwise found at the top and bottom of the generated pages. Has no affect on the "bottom" option. The \f2\-nonavbar\fP option is useful when you are interested only in the content and have no need for navigation, such as converting the files to PostScript or PDF for print only. -.TP 3 -\-helpfile\ path/filename -Specifies the path of an alternate help file \f2path/filename\fP that the HELP link in the top and bottom navigation bars link to. Without this option, the Javadoc tool automatically creates a help file \f2help\-doc.html\fP that is hard\-coded in the Javadoc tool. This option enables you to override this default. The \f2filename\fP can be any name and is not restricted to \f2help\-doc.html\fP \-\- the Javadoc tool will adjust the links in the navigation bar accordingly. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-helpfile /home/user/myhelp.html java.awt\fP -.fl -.fi -.TP 3 -\-stylesheetfile\ path/filename -Specifies the path of an alternate HTML stylesheet file. Without this option, the Javadoc tool automatically creates a stylesheet file \f2stylesheet.css\fP that is hard\-coded in the Javadoc tool. This option enables you to override this default. The \f2filename\fP can be any name and is not restricted to \f2stylesheet.css\fP. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-stylesheetfile /home/user/mystylesheet.css com.mypackage\fP -.fl -.fi -.TP 3 -\-serialwarn -Generates compile\-time warnings for missing @serial tags. By default, Javadoc 1.2.2 (and later versions) generates no serial warnings. (This is a reversal from earlier versions.) Use this option to display the serial warnings, which helps to properly document default serializable fields and \f2writeExternal\fP methods. -.TP 3 -\-charset\ name -Specifies the HTML character set for this document. The name should be a preferred MIME name as given in the -.na -\f2IANA Registry\fP @ -.fi -http://www.iana.org/assignments/character\-sets. For example: -.nf -\f3 -.fl - % \fP\f3javadoc \-charset "iso\-8859\-1" mypackage\fP -.fl -.fi -would insert the following line in the head of every generated page: -.nf -\f3 -.fl - <META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1"> -.fl -\fP -.fi -This META tag is described in the -.na -\f2HTML standard\fP @ -.fi -http://www.w3.org/TR/REC\-html40/charset.html#h\-5.2.2. (4197265 and 4137321) -.br -.br -Also see \-encoding and \-docencoding. -.TP 3 -\-docencoding\ name -Specifies the encoding of the generated HTML files. The name should be a preferred MIME name as given in the -.na -\f2IANA Registry\fP @ -.fi -http://www.iana.org/assignments/character\-sets. If you omit this option but use \-encoding, then the encoding of the generated HTML files is determined by \-encoding. Example: -.nf -\f3 -.fl - % \fP\f3javadoc \-docencoding "ISO\-8859\-1" mypackage\fP -.fl -.fi -Also see \-encoding and \-charset. -.TP 3 -\-keywords -Adds HTML meta keyword tags to the generated file for each class. These tags can help the page be found by search engines that look for meta tags. (Most search engines that search the entire Internet do not look at meta tags, because pages can misuse them; but search engines offered by companies that confine their search to their own website can benefit by looking at meta tags.) -.br -.br -The meta tags include the fully qualified name of the class and the unqualified names of the fields and methods. Constructors are not included because they are identical to the class name. For example, the class String starts with these keywords: -.nf -\f3 -.fl - <META NAME="keywords" CONTENT="java.lang.String class"> -.fl - <META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER"> -.fl - <META NAME="keywords" CONTENT="length()"> -.fl - <META NAME="keywords" CONTENT="charAt()"> -.fl -\fP -.fi -.TP 3 -\-tag\ \ tagname:Xaoptcmf:"taghead" -Enables the Javadoc tool to interpret a simple, one\-argument custom block tag \f2@\fP\f2tagname\fP in doc comments. So the Javadoc tool can "spell\-check" tag names, it is important to include a \f2\-tag\fP option for every custom tag that is present in the source code, disabling (with \f2X\fP) those that are not being output in the current run. -.br -.br -The colon (\f4:\fP) is always the separator. To use a colon in \f2tagname\fP, see Use of Colon in Tag Name. -.br -.br -The \f2\-tag\fP option outputs the tag's heading \f2taghead\fP in bold, followed on the next line by the text from its single argument, as shown in the example below. Like any block tag, this argument's text can contain inline tags, which are also interpreted. The output is similar to standard one\-argument tags, such as \f2@return\fP and \f2@author\fP. Omitting \f2taghead\fP causes \f2tagname\fP to appear as the heading. -.br -.br -\f3Placement of tags\fP \- The \f4Xaoptcmf\fP part of the argument determines where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f2X\fP). You can supply either \f4a\fP, to allow the tag in all places, or any combination of the other letters: -.br -.br -\f4X\fP (disable tag) -.br -\f4a\fP (all) -.br -\f4o\fP (overview) -.br -\f4p\fP (packages) -.br -\f4t\fP (types, that is classes and interfaces) -.br -\f4c\fP (constructors) -.br -\f4m\fP (methods) -.br -\f4f\fP (fields) -.br -.br -\f3Examples of single tags\fP \- An example of a tag option for a tag that can be used anywhere in the source code is: -.nf -\f3 -.fl - \-tag todo:a:"To Do:" -.fl -\fP -.fi -If you wanted @todo to be used only with constructors, methods and fields, you would use: -.nf -\f3 -.fl - \-tag todo:cmf:"To Do:" -.fl -\fP -.fi -Notice the last colon (\f2:\fP) above is not a parameter separator, but is part of the heading text (as shown below). You would use either tag option for source code that contains the tag \f2@todo\fP, such as: -.nf -\f3 -.fl - @todo The documentation for this method needs work. -.fl -\fP -.fi -\f3Use of Colon in Tag Name\fP \- A colon can be used in a tag name if it is escaped with a backslash. For this doc comment: -.nf -\f3 -.fl - /** -.fl - * @ejb:bean -.fl - */ -.fl -\fP -.fi -use this tag option: -.nf -\f3 -.fl - \-tag ejb\\\\:bean:a:"EJB Bean:" -.fl -\fP -.fi -\f3Spell\-checking tag names (Disabling tags)\fP \- Some developers put custom tags in the source code that they don't always want to output. In these cases, it is important to list all tags that are present in the source code, enabling the ones you want to output and disabling the ones you don't want to output. The presence of \f2X\fP disables the tag, while its absence enables the tag. This gives the Javadoc tool enough information to know if a tag it encounters is unknown, probably the results of a typo or a misspelling. It prints a warning in these cases. -.br -.br -You can add \f2X\fP to the placement values already present, so that when you want to enable the tag, you can simply delete the \f2X\fP. For example, if @todo is a tag that you want to suppress on output, you would use: -.nf -\f3 -.fl - \-tag todo:Xcmf:"To Do:" -.fl -\fP -.fi -or, if you'd rather keep it simple: -.nf -\f3 -.fl - \-tag todo:X -.fl -\fP -.fi -The syntax \f2\-tag todo:X\fP works even if \f2@todo\fP is defined by a taglet. -.br -.br -\f3Order of tags\fP \- The order of the \f2\-tag\fP (and \f2\-taglet\fP) options determine the order the tags are output. You can mix the custom tags with the standard tags to intersperse them. The tag options for standard tags are placeholders only for determining the order \-\- they take only the standard tag's name. (Subheadings for standard tags cannot be altered.) This is illustrated in the following example. -.br -.br -If \f2\-tag\fP is missing, then the position of \f2\-taglet\fP determines its order. If they are both present, then whichever appears last on the command line determines its order. (This happens because the tags and taglets are processed in the order that they appear on the command line. For example, if \f2\-taglet\fP and \f2\-tag\fP both have the name "todo", the one that appears last on the command line will determine its order. -.br -.br -\f3Example of a complete set of tags\fP \- This example inserts "To Do" after "Parameters" and before "Throws" in the output. By using "X", it also specifies that @example is a tag that might be encountered in the source code that should not be output during this run. Notice that if you use @argfile, you can put the tags on separate lines in an argument file like this (no line continuation characters needed): -.nf -\f3 -.fl - \-tag param -.fl - \-tag return -.fl - \-tag todo:a:"To Do:" -.fl - \-tag throws -.fl - \-tag see -.fl - \-tag example:X -.fl -\fP -.fi -When javadoc parses the doc comments, any tag encountered that is neither a standard tag nor passed in with \f2\-tag\fP or \f2\-taglet\fP is considered unknown, and a warning is thrown. -.br -.br -The standard tags are initially stored internally in a list in their default order. Whenever \f2\-tag\fP options are used, those tags get appended to this list \-\- standard tags are moved from their default position. Therefore, if a \f2\-tag\fP option is omitted for a standard tag, it remains in its default position. -.br -.br -\f3Avoiding Conflicts\fP \- If you want to slice out your own namespace, you can use a dot\-separated naming convention similar to that used for packages: \f2com.mycompany.todo\fP. Oracle will continue to create standard tags whose names do not contain dots. Any tag you create will override the behavior of a tag by the same name defined by Oracle. In other words, if you create a tag or taglet \f2@todo\fP, it will always have the same behavior you define, even if Oracle later creates a standard tag of the same name. -.br -.br -\f3Annotations vs. Javadoc Tags\fP \- In general, if the markup you want to add is intended to affect or produce documentation, it should probably be a javadoc tag; otherwise, it should be an annotation. See -.na -\f2Comparing Annotations and Javadoc Tags\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#annotations< -.br -.br -You can also create more complex block tags, or custom inline tags with the \-taglet option. -.TP 3 -\-taglet\ \ class -Specifies the class file that starts the taglet used in generating the documentation for that tag. Use the fully\-qualified name for \f2class\fP. This taglet also defines the number of text arguments that the custom tag has. The taglet accepts those arguments, processes them, and generates the output. For extensive documentation with example taglets, see: -.RS 3 -.TP 2 -o -.na -\f2Taglet Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html -.RE -Taglets are useful for block or inline tags. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes. -.br -.br -Taglets can only determine where a tag should appear and in what form. All other decisions are made by the doclet. So a taglet cannot do things such as remove a class name from the list of included classes. However, it can execute side effects, such as printing the tag's text to a file or triggering another process. -.br -.br -Use the \f2\-tagletpath\fP option to specify the path to the taglet. Here is an example that inserts the "To Do" taglet after "Parameters" and ahead of "Throws" in the generated pages: -.nf -\f3 -.fl - \-taglet com.sun.tools.doclets.ToDoTaglet -.fl - \-tagletpath /home/taglets -.fl - \-tag return -.fl - \-tag param -.fl - \-tag todo -.fl - \-tag throws -.fl - \-tag see -.fl -\fP -.fi -Alternatively, you can use the \f2\-taglet\fP option in place of its \f2\-tag\fP option, but that may be harder to read. -.TP 3 -\-tagletpath\ \ tagletpathlist -Specifies the search paths for finding taglet class files (.class). The \f2tagletpathlist\fP can contain multiple paths by separating them with a colon (\f2:\fP). The Javadoc tool will search in all subdirectories of the specified paths. -.TP 3 -\-docfilessubdirs\ -Enables deep copying of "\f2doc\-files\fP" directories. In other words, subdirectories and all contents are recursively copied to the destination. For example, the directory \f2doc\-files/example/images\fP and all its contents would now be copied. There is also an option to exclude subdirectories. -.TP 3 -\-excludedocfilessubdir\ \ name1:name2... -Excludes any "\f2doc\-files\fP" subdirectories with the given names. This prevents the copying of SCCS and other source\-code\-control subdirectories. -.TP 3 -\-noqualifier\ \ all\ | \ packagename1:packagename2:... -Omits qualifying package name from ahead of class names in output. The argument to \f2\-noqualifier\fP is either "\f2all\fP" (all package qualifiers are omitted) or a colon\-separate list of packages, with wildcards, to be removed as qualifiers. The package name is removed from places where class or interface names appear. -.br -.br -The following example omits all package qualifiers: -.nf -\f3 -.fl - \-noqualifier all -.fl -\fP -.fi -The following example omits "java.lang" and "java.io" package qualifiers: -.nf -\f3 -.fl - \-noqualifier java.lang:java.io -.fl -\fP -.fi -The following example omits package qualifiers starting with "java", and "com.sun" subpackages (but not "javax"): -.nf -\f3 -.fl - \-noqualifier java.*:com.sun.* -.fl -\fP -.fi -Where a package qualifier would appear due to the above behavior, the name can be suitably shortened \-\- see How a name is displayed. This rule is in effect whether or not \f2\-noqualifier\fP is used. -.TP 3 -\-notimestamp\ -Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page. Useful when you want to run javadoc on two source bases and diff them, as it prevents timestamps from causing a diff (which would otherwise be a diff on every page). The timestamp includes the javadoc version number, and currently looks like this: -.nf -\f3 -.fl - <!\-\- Generated by javadoc (build 1.5.0_01) on Thu Apr 02 14:04:52 IST 2009 \-\-> -.fl -\fP -.fi -.TP 3 -\-nocomment\ -Suppress the entire comment body, including the main description and all tags, generating only declarations. This option enables re\-using source files originally intended for a different purpose, to produce skeleton HTML documentation at the early stages of a new project. -.TP 3 -\-sourcetab tabLength -Specify the number of spaces each tab takes up in the source. -.RE -.SH "COMMAND LINE ARGUMENT FILES" -.LP -To shorten or simplify the javadoc command line, you can specify one or more files that themselves contain arguments to the \f2javadoc\fP command (except \f2\-J\fP options). This enables you to create javadoc commands of any length on any operating system. -.LP -An argument file can include javac options and source filenames in any combination. The arguments within a file can be space\-separated or newline\-separated. If a filename contains embedded spaces, put the whole filename in double quotes. -.LP -Filenames within an argument file are relative to the current directory, not the location of the argument file. Wildcards (*) are not allowed in these lists (such as for specifying \f2*.java\fP). Use of the '\f2@\fP' character to recursively interpret files is not supported. The \f2\-J\fP options are not supported because they are passed to the launcher, which does not support argument files. -.LP -When executing javadoc, pass in the path and name of each argument file with the '\f2@\fP' leading character. When javadoc encounters an argument beginning with the character `\f2@\fP', it expands the contents of that file into the argument list. -.SS -Example \- Single Arg File -.LP -You could use a single argument file named "\f2argfile\fP" to hold all Javadoc arguments: -.nf -\f3 -.fl - % \fP\f3javadoc @argfile\fP -.fl -.fi -.LP -This argument file could contain the contents of both files shown in the next example. -.SS -Example \- Two Arg Files -.LP -You can create two argument files \-\- one for the Javadoc options and the other for the package names or source filenames: (Notice the following lists have no line\-continuation characters.) -.LP -Create a file named "\f2options\fP" containing: -.nf -\f3 -.fl - \-d docs\-filelist -.fl - \-use -.fl - \-splitindex -.fl - \-windowtitle 'Java SE 7 API Specification' -.fl - \-doctitle 'Java SE 7 API Specification' -.fl - \-header '<b>Java(TM) SE 7</b>' -.fl - \-bottom 'Copyright © 1993\-2011 Oracle and/or its affiliates. All rights reserved.' -.fl - \-group "Core Packages" "java.*" -.fl - \-overview /java/pubs/ws/1.7.0/src/share/classes/overview\-core.html -.fl - \-sourcepath /java/pubs/ws/1.7.0/src/share/classes -.fl -\fP -.fi -.LP -Create a file named "\f2packages\fP" containing: -.nf -\f3 -.fl - com.mypackage1 -.fl - com.mypackage2 -.fl - com.mypackage3 -.fl -\fP -.fi -.LP -You would then run javadoc with: -.nf -\f3 -.fl - % \fP\f3javadoc @options @packages\fP -.fl -.fi -.SS -Example \- Arg Files with Paths -.LP -The argument files can have paths, but any filenames inside the files are relative to the current working directory (not \f2path1\fP or \f2path2\fP): -.nf -\f3 -.fl - % \fP\f3javadoc @path1/options @path2/packages\fP -.fl -.fi -.SS -Example \- Option Arguments -.LP -Here's an example of saving just an argument to a javadoc option in an argument file. We'll use the \f2\-bottom\fP option, since it can have a lengthy argument. You could create a file named "\f2bottom\fP" containing its text argument: -.nf -\f3 -.fl -<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font> -.fl -\fP -.fi -.LP -Then run the Javadoc tool with: -.nf -\f3 -.fl - % \fP\f3javadoc \-bottom @bottom @packages\fP -.fl -.fi -.LP -Or you could include the \f2\-bottom\fP option at the start of the argument file, and then just run it as: -.nf -\f3 -.fl - % \fP\f3javadoc @bottom @packages\fP -.fl -.fi -.SH "Name" -Running -.SH "RUNNING JAVADOC" -.LP -\f3Version Numbers\fP \- The version number of javadoc can be determined using \f3javadoc \-J\-version\fP. The version number of the standard doclet appears in its output stream. It can be turned off with \f2\-quiet\fP. -.LP -\f3Public programmatic interface\fP \- To invoke the Javadoc tool from within programs written in the Java language. This interface is in \f2com.sun.tools.javadoc.Main\fP (and javadoc is re\-entrant). For more details, see -.na -\f2Standard Doclet\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/javadoc/standard\-doclet.html#runningprogrammatically. -.LP -\f3Running Doclets\fP \- The instructions given below are for invoking the standard HTML doclet. To invoke a custom doclet, use the \-doclet and \-docletpath options. For full, working examples of running a particular doclet, see the -.na -\f2MIF Doclet documentation\fP @ -.fi -http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html. -.SH "SIMPLE EXAMPLES" -.LP -You can run javadoc on entire packages or individual source files. Each package name has a corresponding directory name. In the following examples, the source files are located at \f2/home/src/java/awt/*.java\fP. The destination directory is \f2/home/html\fP. -.SS -Documenting One or More Packages -.LP -To document a package, the source files (\f2*.java\fP) for that package must be located in a directory having the same name as the package. If a package name is made up of several identifiers (separated by dots, such as \f2java.awt.color\fP), each subsequent identifier must correspond to a deeper subdirectory (such as \f2java/awt/color\fP). You may split the source files for a single package among two such directory trees located at different places, as long as \f2\-sourcepath\fP points to them both \-\- for example \f2src1/java/awt/color\fP and \f2src2/java/awt/color\fP. -.LP -You can run javadoc either by changing directories (with \f2cd\fP) or by using \f2\-sourcepath\fP option. The examples below illustrate both alternatives. -.RS 3 -.TP 2 -o -\f3Case 1 \- Run recursively starting from one or more packages\fP \- This example uses \-sourcepath so javadoc can be run from any directory and \-subpackages (a new 1.4 option) for recursion. It traverses the subpackages of the \f2java\fP directory excluding packages rooted at \f2java.net\fP and \f2java.lang\fP. Notice this excludes \f2java.lang.ref\fP, a subpackage of \f2java.lang\fP). -.nf -\f3 -.fl - % \fP\f3javadoc \fP\f3\-d\fP\f3 /home/html \fP\f3\-sourcepath\fP\f3 /home/src \fP\f3\-subpackages\fP\f3 java \fP\f3\-exclude\fP\f3 java.net:java.lang\fP -.fl -.fi -.LP -To also traverse down other package trees, append their names to the \f2\-subpackages\fP argument, such as \f2java:javax:org.xml.sax\fP. -.TP 2 -o -\f3Case 2 \- Run on explicit packages after changing to the "root" source directory\fP \- Change to the parent directory of the fully\-qualified package. Then run javadoc, supplying names of one or more packages you want to document: -.nf -\f3 -.fl - % \fP\f3cd /home/src/\fP -.fl - % \f3javadoc \-d /home/html java.awt java.awt.event\fP -.fl -.fi -.TP 2 -o -\f3Case 3 \- Run from any directory on explicit packages in a single directory tree\fP \- In this case, it doesn't matter what the current directory is. Run javadoc supplying \f2\-sourcepath\fP with the parent directory of the top\-level package, and supplying names of one or more packages you want to document: -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt java.awt.event\fP -.fl -.fi -.TP 2 -o -\f3Case 4 \- Run from any directory on explicit packages in multiple directory trees\fP \- This is the same as case 3, but for packages in separate directory trees. Run javadoc supplying \f2\-sourcepath\fP with the path to each tree's root (colon\-separated) and supply names of one or more packages you want to document. All source files for a given package do not need to be located under a single root directory \-\- they just need to be found somewhere along the sourcepath. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event\fP -.fl -.fi -.RE -.LP -Result: All cases generate HTML\-formatted documentation for the public and protected classes and interfaces in packages \f2java.awt\fP and \f2java.awt.event\fP and save the HTML files in the specified destination directory (\f2/home/html\fP). Because two or more packages are being generated, the document has three HTML frames \-\- for the list of packages, the list of classes, and the main class pages. -.SS -Documenting One or More Classes -.LP -The second way to run the Javadoc tool is by passing in one or more source files (\f2.java\fP). You can run javadoc either of the following two ways \-\- by changing directories (with \f2cd\fP) or by fully\-specifying the path to the \f2.java\fP files. Relative paths are relative to the current directory. The \f2\-sourcepath\fP option is ignored when passing in source files. You can use command line wildcards, such as asterisk (*), to specify groups of classes. -.RS 3 -.TP 2 -o -\f3Case 1 \- Changing to the source directory\fP \- Change to the directory holding the \f2.java\fP files. Then run javadoc, supplying names of one or more source files you want to document. -.nf -\f3 -.fl - % \fP\f3cd /home/src/java/awt\fP -.fl - % \f3javadoc \-d /home/html Button.java Canvas.java Graphics*.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the classes \f2Button\fP, \f2Canvas\fP and classes beginning with \f2Graphics\fP. Because source files rather than package names were passed in as arguments to javadoc, the document has two frames \-\- for the list of classes and the main page. -.TP 2 -o -\f3Case 2 \- Changing to the package root directory\fP \- This is useful for documenting individual source files from different subpackages off the same root. Change to the package root directory, and supply the source files with paths from the root. -.nf -\f3 -.fl - % \fP\f3cd /home/src/\fP -.fl - % \f3javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the classes \f2Button\fP and \f2Applet\fP. -.TP 2 -o -\f3Case 3 \- From any directory\fP \- In this case, it doesn't matter what the current directory is. Run javadoc supplying the absolute path (or path relative to the current directory) to the \f2.java\fP files you want to document. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java\fP -.fl -.fi -This example generates HTML\-formatted documentation for the class \f2Button\fP and classes beginning with \f2Graphics\fP. -.RE -.SS -Documenting Both Packages and Classes -.LP -You can document entire packages and individual classes at the same time. Here's an example that mixes two of the previous examples. You can use \f2\-sourcepath\fP for the path to the packages but not for the path to the individual classes. -.nf -\f3 -.fl - % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java\fP -.fl -.fi -.LP -This example generates HTML\-formatted documentation for the package \f2java.awt\fP and class \f2Applet\fP. (The Javadoc tool determines the package name for \f2Applet\fP from the package declaration, if any, in the \f2Applet.java\fP source file.) -.SH "REAL WORLD EXAMPLE" -.LP -The Javadoc tool has many useful options, some of which are more commonly used than others. Here is effectively the command we use to run the Javadoc tool on the Java platform API. We use 180MB of memory to generate the documentation for the 1500 (approx.) public and protected classes in the Java SE Platform, Standard Edition, v1.2. -.LP -The same example is shown twice \-\- first as executed on the command line, then as executed from a makefile. It uses absolute paths in the option arguments, which enables the same \f2javadoc\fP command to be run from any directory. -.SS -Command Line Example -.LP -The following example may be too long for some shells such as DOS. You can use a command line argument file (or write a shell script) to workaround this limitation. -.nf -\f3 -.fl -% javadoc \-sourcepath /java/jdk/src/share/classes \\ -.fl - \-overview /java/jdk/src/share/classes/overview.html \\ -.fl - \-d /java/jdk/build/api \\ -.fl - \-use \\ -.fl - \-splitIndex \\ -.fl - \-windowtitle 'Java Platform, Standard Edition 7 API Specification' \\ -.fl - \-doctitle 'Java Platform, Standard Edition 7 API Specification' \\ -.fl - \-header '<b>Java(TM) SE 7</b>' \\ -.fl - \-bottom '<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font>' \\ -.fl - \-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \\ -.fl - \-group "Extension Packages" "javax.*" \\ -.fl - \-J\-Xmx180m \\ -.fl - @packages -.fl -\fP -.fi -.LP -where \f2packages\fP is the name of a file containing the packages to process, such as \f2java.applet java.lang\fP. None of the options should contain any newline characters between the single quotes. (For example, if you copy and paste this example, delete the newline characters from the \f2\-bottom\fP option.) See the other notes listed below. -.SS -Makefile Example -.LP -This is an example of a GNU makefile. For an example of a Windows makefile, see -.na -\f2creating a makefile for Windows\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html#makefiles. -.nf -\f3 -.fl -javadoc \-\fP\f3sourcepath\fP\f3 $(SRCDIR) \\ /* Sets path for source files */ -.fl - \-\fP\f3overview\fP\f3 $(SRCDIR)/overview.html \\ /* Sets file for overview text */ -.fl - \-\fP\f3d\fP\f3 /java/jdk/build/api \\ /* Sets destination directory */ -.fl - \-\fP\f3use\fP\f3 \\ /* Adds "Use" files */ -.fl - \-\fP\f3splitIndex\fP\f3 \\ /* Splits index A\-Z */ -.fl - \-\fP\f3windowtitle\fP\f3 $(WINDOWTITLE) \\ /* Adds a window title */ -.fl - \-\fP\f3doctitle\fP\f3 $(DOCTITLE) \\ /* Adds a doc title */ -.fl - \-\fP\f3header\fP\f3 $(HEADER) \\ /* Adds running header text */ -.fl - \-\fP\f3bottom\fP\f3 $(BOTTOM) \\ /* Adds text at bottom */ -.fl - \-\fP\f3group\fP\f3 $(GROUPCORE) \\ /* 1st subhead on overview page */ -.fl - \-\fP\f3group\fP\f3 $(GROUPEXT) \\ /* 2nd subhead on overview page */ -.fl - \-\fP\f3J\fP\f3\-Xmx180m \\ /* Sets memory to 180MB */ -.fl - java.lang java.lang.reflect \\ /* Sets packages to document */ -.fl - java.util java.io java.net \\ -.fl - java.applet -.fl - -.fl -WINDOWTITLE = 'Java(TM) SE 7 API Specification' -.fl -DOCTITLE = 'Java(TM) Platform Standard Edition 7 API Specification' -.fl -HEADER = '<b>Java(TM) SE 7</font>' -.fl -BOTTOM = '<font size="\-1"> -.fl - <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> -.fl - Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> -.fl - Oracle is a registered trademark of Oracle Corporation and/or its affiliates. -.fl - Other names may be trademarks of their respective owners.</font>' -.fl -GROUPCORE = '"Core Packages" "java.*:com.sun.java.*:org.omg.*"' -.fl -GROUPEXT = '"Extension Packages" "javax.*"' -.fl -SRCDIR = '/java/jdk/1.7.0/src/share/classes' -.fl -\fP -.fi -.LP -Single quotes are used to surround makefile arguments. -.LP -\f3NOTES\fP -.RS 3 -.TP 2 -o -If you omit the \f2\-windowtitle\fP option, the Javadoc tool copies the doc title to the window title. The \f2\-windowtitle\fP text is basically the same as the \f2\-doctitle\fP but without HTML tags, to prevent those tags from appearing as raw text in the window title. -.TP 2 -o -If you omit the \f2\-footer\fP option, as done here, the Javadoc tool copies the header text to the footer. -.TP 2 -o -Other important options you might want to use but not needed in this example are \-\f2classpath\fP and \-\f2link\fP. -.RE -.SH "TROUBLESHOOTING" -.SS -General Troubleshooting -.RS 3 -.TP 2 -o -\f3Javadoc FAQ\fP \- Commonly\-encountered bugs and troubleshooting tips can be found on the -.na -\f2Javadoc FAQ\fP @ -.fi -http://java.sun.com/j2se/javadoc/faq/index.html#B -.TP 2 -o -\f3Bugs and Limitations\fP \- You can also see some bugs listed at Important Bug Fixes and Changes. -.TP 2 -o -\f3Version number\fP \- See version numbers. -.TP 2 -o -\f3Documents only legal classes\fP \- When documenting a package, javadoc only reads files whose names are composed of legal class names. You can prevent javadoc from parsing a file by including, for example, a hyphen "\-" in its filename. -.RE -.SS -Errors and Warnings -.LP -Error and warning messages contain the filename and line number to the declaration line rather than to the particular line in the doc comment. -.RS 3 -.TP 2 -o -\f2"error: cannot read: Class1.java"\fP the Javadoc tool is trying to load the class Class1.java in the current directory. The class name is shown with its path (absolute or relative), which in this case is the same as \f2./Class1.java\fP. -.RE -.SH "ENVIRONMENT" -.RS 3 -.TP 3 -CLASSPATH -Environment variable that provides the path which javadoc uses to find user class files. This environment variable is overridden by the \f2\-classpath\fP option. Separate directories with a colon, for example: -.:/home/classes:/usr/local/java/classes -.RE -.SH "SEE ALSO" -.RS 3 -.TP 2 -o -javac(1) -.TP 2 -o -java(1) -.TP 2 -o -jdb(1) -.TP 2 -o -javah(1) -.TP 2 -o -javap(1) -.TP 2 -o -.na -\f2Javadoc Home Page\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-jsp\-135444.html -.TP 2 -o -.na -\f2How to Write Doc Comments for Javadoc\fP @ -.fi -http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html -.TP 2 -o -.na -\f2Setting the Class Path\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#general -.TP 2 -o -.na -\f2How Javac and Javadoc Find Classes\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfiles (tools.jar) -.RE - +.TP +-nodeprecated +.br +Prevents the generation of any deprecated API in the documentation\&. This does what the \f3-nodeprecatedlist\fR option does, and it does not generate any deprecated API throughout the rest of the documentation\&. This is useful when writing code when you do not want to be distracted by the deprecated code\&. +.TP +-nodeprecatedlist +.br +Prevents the generation of the file that contains the list of deprecated APIs (deprecated-list\&.html) and the link in the navigation bar to that page\&. The \f3javadoc\fR command continues to generate the deprecated API throughout the rest of the document\&. This is useful when your source code contains no deprecated APIs, and you want to make the navigation bar cleaner\&. +.TP +-nosince +.br +Omits from the generated documents the \f3Since\fR sections associated with the \f3@since\fR tags\&. +.TP +-notree +.br +Omits the class/interface hierarchy pages from the generated documents\&. These are the pages you reach using the Tree button in the navigation bar\&. The hierarchy is produced by default\&. +.TP +-noindex +.br +Omits the index from the generated documents\&. The index is produced by default\&. +.TP +-nohelp +.br +Omits the HELP link in the navigation bars at the top and bottom of each page of output\&. +.TP +-nonavbar +.br +Prevents the generation of the navigation bar, header, and footer, that are usually found at the top and bottom of the generated pages\&. The \f3-nonavbar\fR option has no affect on the \f3-bottom\fR option\&. The \f3-nonavbar\fR option is useful when you are interested only in the content and have no need for navigation, such as when you are converting the files to PostScript or PDF for printing only\&. +.TP +-helpfile \fIpath\efilename\fR +.br +Specifies the path of an alternate help file path\efilename that the HELP link in the top and bottom navigation bars link to\&. Without this option, the \f3javadoc\fR command creates a help file help-doc\&.html that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to help-doc\&.html\&. The \f3javadoc\fR command adjusts the links in the navigation bar accordingly, for example: +.sp +.nf +\f3javadoc \-helpfile /home/user/myhelp\&.html java\&.awt\&.\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-stylesheet \fIpath/filename\fR +.br +Specifies the path of an alternate HTML stylesheet file\&. Without this option, the \f3javadoc\fR command automatically creates a stylesheet file stylesheet\&.css that is hard-coded in the \f3javadoc\fR command\&. This option lets you override the default\&. The file name can be any name and is not restricted to stylesheet\&.css, for example: +.sp +.nf +\f3javadoc \-stylesheet file /home/user/mystylesheet\&.css com\&.mypackage\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-serialwarn +.br +Generates compile-time warnings for missing \f3@serial\fR tags\&. By default, Javadoc 1\&.2\&.2 and later versions generate no serial warnings\&. This is a reversal from earlier releases\&. Use this option to display the serial warnings, which helps to properly document default serializable fields and \f3writeExternal\fR methods\&. +.TP +-charset \fIname\fR +.br +Specifies the HTML character set for this document\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +For example, \f3javadoc -charset "iso-8859-1" mypackage\fR inserts the following line in the head of every generated page: +.sp +.nf +\f3<META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1">\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This \f3META\fR tag is described in the HTML standard (4197265 and 4137321), HTML Document Representation, at http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 + +See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-docencoding \fIname\fR +.br +Specifies the encoding of the generated HTML files\&. The name should be a preferred MIME name as specified in the IANA Registry, Character Sets at http://www\&.iana\&.org/assignments/character-sets + +If you omit the \f3-docencoding\fR option but use the \f3-encoding\fR option, then the encoding of the generated HTML files is determined by the \f3-encoding\fR option, for example: \f3javadoc -docencoding"iso-8859-1" mypackage\fR\&. See also the \f3-encoding\fR and \f3-docencoding name\fR options\&. +.TP +-keywords +.br +Adds HTML keyword <META> tags to the generated file for each class\&. These tags can help search engines that look for <META> tags find the pages\&. Most search engines that search the entire Internet do not look at <META> tags, because pages can misuse them\&. Search engines offered by companies that confine their searches to their own website can benefit by looking at <META> tags\&. The <META> tags include the fully qualified name of the class and the unqualified names of the fields and methods\&. Constructors are not included because they are identical to the class name\&. For example, the class \f3String\fR starts with these keywords: +.sp +.nf +\f3<META NAME="keywords" CONTENT="java\&.lang\&.String class">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="length()">\fP +.fi +.nf +\f3<META NAME="keywords" CONTENT="charAt()">\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-tag \fItagname\fR:Xaoptcmf:"\fItaghead\fR" +.br +Enables the \f3javadoc\fR command to interpret a simple, one-argument \f3@tagname\fR custom block tag in documentation comments\&. For the \f3javadoc\fR command to spell-check tag names, it is important to include a \f3-tag\fR option for every custom tag that is present in the source code, disabling (with \f3X\fR) those that are not being output in the current run\&.The colon (:) is always the separator\&. The \f3-tag\fR option outputs the tag heading \fItaghead\fR in bold, followed on the next line by the text from its single argument\&. Similar to any block tag, the argument text can contain inline tags, which are also interpreted\&. The output is similar to standard one-argument tags, such as the \f3@return\fR and \f3@author\fR tags\&. Omitting a value for \fItaghead\fR causes \f3tagname\fR to be the heading\&. + +\fIPlacement of tags\fR: The \f3Xaoptcmf\fR arguments determine where in the source code the tag is allowed to be placed, and whether the tag can be disabled (using \f3X\fR)\&. You can supply either \f3a\fR, to allow the tag in all places, or any combination of the other letters: + +\f3X\fR (disable tag) + +\f3a\fR (all) + +\f3o\fR (overview) + +\f3p\fR (packages) + +\f3t\fR (types, that is classes and interfaces) + +\f3c\fR (constructors) + +\f3m\fR (methods) + +\f3f\fR (fields) + +\fIExamples of single tags\fR: An example of a tag option for a tag that can be used anywhere in the source code is: \f3-tag todo:a:"To Do:"\fR\&. + +If you want the \f3@todo\fR tag to be used only with constructors, methods, and fields, then you use: \f3-tag todo:cmf:"To Do:"\fR\&. + +Notice the last colon (:) is not a parameter separator, but is part of the heading text\&. You would use either tag option for source code that contains the \f3@todo\fR tag, such as: \f3@todo The documentation for this method needs work\fR\&. + +\fIColons in tag names\fR: Use a backslash to escape a colon that you want to use in a tag name\&. Use the \f3-tag ejb\e\e:bean:a:"EJB Bean:"\fR option for the following documentation comment: +.sp +.nf +\f3/**\fP +.fi +.nf +\f3 * @ejb:bean\fP +.fi +.nf +\f3 */\fP +.fi +.nf +\f3\fR +.fi +.sp + + +\fISpell-checking tag names\fR: Some developers put custom tags in the source code that they do not always want to output\&. In these cases, it is important to list all tags that are in the source code, enabling the ones you want to output and disabling the ones you do not want to output\&. The presence of \f3X\fR disables the tag, while its absence enables the tag\&. This gives the \f3javadoc\fR command enough information to know whether a tag it encounters is unknown, which is probably the results of a typographical error or a misspelling\&. The \f3javadoc\fR command prints a warning in these cases\&. You can add \f3X\fR to the placement values already present, so that when you want to enable the tag, you can simply delete the \f3X\fR\&. For example, if the \f3@todo\fR tag is a tag that you want to suppress on output, then you would use: \f3-tag todo:Xcmf:"To Do:"\fR\&. If you would rather keep it simple, then use this: \f3-tag todo:X\fR\&. The syntax \f3-tag todo:X\fR works even when the \f3@todo\fR tag is defined by a taglet\&. + +\fIOrder of tags\fR: The order of the \f3-ta\fR\f3g\fR and \f3-taglet\fR options determines the order the tags are output\&. You can mix the custom tags with the standard tags to intersperse them\&. The tag options for standard tags are placeholders only for determining the order\&. They take only the standard tag\&'s name\&. Subheadings for standard tags cannot be altered\&. This is illustrated in the following example\&.If the \f3-tag\fR option is missing, then the position of the \f3-tagle\fR\f3t\fR option determines its order\&. If they are both present, then whichever appears last on the command line determines its order\&. This happens because the tags and taglets are processed in the order that they appear on the command line\&. For example, if the \f3-taglet\fR and \f3-tag\fR options have the name \f3todo\fR value, then the one that appears last on the command line determines the order\&. + +\fIExample of a complete set of tags\fR: This example inserts To Do after Parameters and before Throws in the output\&. By using \f3X\fR, it also specifies that the \f3@example\fR tag might be encountered in the source code that should not be output during this run\&. If you use the \f3@argfile\fR tag, then you can put the tags on separate lines in an argument file similar to this (no line continuation characters needed): +.sp +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag todo:a:"To Do:"\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\-tag example:X\fP +.fi +.nf +\f3\fR +.fi +.sp + + +When the \f3javadoc\fR command parses the documentation comments, any tag encountered that is neither a standard tag nor passed in with the \f3-tag\fR or \f3-taglet\fR options is considered unknown, and a warning is thrown\&. + +The standard tags are initially stored internally in a list in their default order\&. Whenever the \f3-tag\fR options are used, those tags get appended to this list\&. Standard tags are moved from their default position\&. Therefore, if a \f3-tag\fR option is omitted for a standard tag, then it remains in its default position\&. + +\fIAvoiding conflicts\fR: If you want to create your own namespace, then you can use a dot-separated naming convention similar to that used for packages: \f3com\&.mycompany\&.todo\fR\&. Oracle will continue to create standard tags whose names do not contain dots\&. Any tag you create will override the behavior of a tag by the same name defined by Oracle\&. If you create a \f3@todo\fR tag or taglet, then it always has the same behavior you define, even when Oracle later creates a standard tag of the same name\&. + +\fIAnnotations vs\&. Javadoc tags\fR: In general, if the markup you want to add is intended to affect or produce documentation, then it should be a Javadoc tag\&. Otherwise, it should be an annotation\&. See Custom Tags and Annotations in How to Write Doc Comments for the Javadoc Tool at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html#annotations + +You can also create more complex block tags or custom inline tags with the \f3-taglet\fR option\&. +.TP +-taglet \fIclass\fR +.br +Specifies the class file that starts the taglet used in generating the documentation for that tag\&. Use the fully qualified name for the \f3class\fR value\&. This taglet also defines the number of text arguments that the custom tag has\&. The taglet accepts those arguments, processes them, and generates the output\&. For extensive documentation with example taglets, see: Taglet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/taglet/overview\&.html + +Taglets are useful for block or inline tags\&. They can have any number of arguments and implement custom behavior, such as making text bold, formatting bullets, writing out the text to a file, or starting other processes\&. Taglets can only determine where a tag should appear and in what form\&. All other decisions are made by the doclet\&. A taglet cannot do things such as remove a class name from the list of included classes\&. However, it can execute side effects, such as printing the tag\&'s text to a file or triggering another process\&. Use the \f3-tagletpath\fR option to specify the path to the taglet\&. The following example inserts the To Do taglet after Parameters and ahead of Throws in the generated pages\&. Alternately, you can use the \f3-taglet\fR option in place of its \f3-tag\fR option, but that might be difficult to read\&. +.sp +.nf +\f3\-taglet com\&.sun\&.tools\&.doclets\&.ToDoTaglet\fP +.fi +.nf +\f3\-tagletpath /home/taglets \fP +.fi +.nf +\f3\-tag return\fP +.fi +.nf +\f3\-tag param\fP +.fi +.nf +\f3\-tag todo\fP +.fi +.nf +\f3\-tag throws\fP +.fi +.nf +\f3\-tag see\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-tagletpath \fItagletpathlist\fR +.br +Specifies the search paths for finding taglet class files\&. The \f3tagletpathlist\fR can contain multiple paths by separating them with a colon (:)\&. The \f3javadoc\fR command searches all subdirectories of the specified paths\&. +.TP +-docfilesubdirs +.br +Enables deep copying of doc-files directories\&. Subdirectories and all contents are recursively copied to the destination\&. For example, the directory doc-files/example/images and all of its contents would be copied\&. There is also an option to exclude subdirectories\&. +.TP +-excludedocfilessubdir \fIname1:name2\fR +.br +Excludes any doc-files subdirectories with the specified names\&. This prevents the copying of SCCS and other source-code-control subdirectories\&. +.TP +-noqualifier all | \fIpackagename1\fR:\fIpackagename2\&.\&.\&.\fR +.br +Omits qualifying package names from class names in output\&. The argument to the \f3-noqualifier\fR option is either \f3all\fR (all package qualifiers are omitted) or a colon-separate list of packages, with wild cards, to be removed as qualifiers\&. The package name is removed from places where class or interface names appear\&. See Process Source Files\&. + +The following example omits all package qualifiers: \f3-noqualifier all\fR\&. + +The following example omits \f3java\&.lang\fR and \f3java\&.io\fR package qualifiers: \f3-noqualifier java\&.lang:java\&.io\fR\&. + +The following example omits package qualifiers starting with \f3java\fR, and \f3com\&.sun\fR subpackages, but not \f3javax\fR: \f3-noqualifier java\&.*:com\&.sun\&.*\fR\&. + +Where a package qualifier would appear due to the previous behavior, the name can be suitably shortened\&. See How a Name Appears\&. This rule is in effect whether or not the \f3-noqualifier\fR option is used\&. +.TP +-notimestamp +.br +Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page\&. The \f3-notimestamp\fR option is useful when you want to run the \f3javadoc\fR command on two source bases and get the differences between \f3diff\fR them, because it prevents time stamps from causing a \f3diff\fR (which would otherwise be a \f3diff\fR on every page)\&. The time stamp includes the \f3javadoc\fR command release number, and currently appears similar to this: \f3<!-- Generated by javadoc (build 1\&.5\&.0_01) on Thu Apr 02 14:04:52 IST 2009 -->\fR\&. +.TP +-nocomment +.br +Suppresses the entire comment body, including the main description and all tags, and generate only declarations\&. This option lets you reuse source files that were originally intended for a different purpose so that you can produce skeleton HTML documentation at the early stages of a new project\&. +.TP +-sourcetab \fItablength\fR +.br +Specifies the number of spaces each tab uses in the source\&. +.SH COMMAND-LINE\ ARGUMENT\ FILES +To shorten or simplify the \f3javadoc\fR command, you can specify one or more files that contain arguments to the \f3javadoc\fR command (except \f3-J\fR options)\&. This enables you to create \f3javadoc\fR commands of any length on any operating system\&. +.PP +An argument file can include \f3javac\fR options and source file names in any combination\&. The arguments within a file can be space-separated or newline-separated\&. If a file name contains embedded spaces, then put the whole file name in double quotation marks\&. +.PP +File Names within an argument file are relative to the current directory, not the location of the argument file\&. Wild cards (\f3*\fR) are not allowed in these lists (such as for specifying *\&.java)\&. Using the at sign (@) to recursively interpret files is not supported\&. The \f3-J\fR options are not supported because they are passed to the launcher, which does not support argument files\&. +.PP +When you run the \f3javadoc\fR command, pass in the path and name of each argument file with the @ leading character\&. When the \f3javadoc\fR command encounters an argument beginning with the at sign (@), it expands the contents of that file into the argument list\&. +.PP +\f3Example 1 Single Argument File\fR +.PP +You could use a single argument file named \f3argfile\fR to hold all \f3javadoc\fR command arguments: \f3javadoc @argfile\fR\&. The argument file \f3\fRcontains the contents of both files, as shown in the next example\&. +.PP +\f3Example 2 Two Argument Files\fR +.PP +You can create two argument files: One for the \f3javadoc\fR command options and the other for the package names or source file names\&. Notice the following lists have no line-continuation characters\&. +.PP +Create a file named options that contains: +.sp +.nf +\f3\-d docs\-filelist \fP +.fi +.nf +\f3\-use \fP +.fi +.nf +\f3\-splitindex\fP +.fi +.nf +\f3\-windowtitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-doctitle \&'Java SE 7 API Specification\&'\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&'\fP +.fi +.nf +\f3\-bottom \&'Copyright © 1993\-2011 Oracle and/or its affiliates\&. All rights reserved\&.\&'\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*"\fP +.fi +.nf +\f3\-overview /java/pubs/ws/1\&.7\&.0/src/share/classes/overview\-core\&.html\fP +.fi +.nf +\f3\-sourcepath /java/pubs/ws/1\&.7\&.0/src/share/classes\fP +.fi +.nf +\f3\fR +.fi +.sp +Create a file named packages that contains: +.sp +.nf +\f3com\&.mypackage1\fP +.fi +.nf +\f3com\&.mypackage2\fP +.fi +.nf +\f3com\&.mypackage3\fP +.fi +.nf +\f3\fR +.fi +.sp +Run the \f3javadoc\fR command as follows: +.sp +.nf +\f3javadoc @options @packages\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Argument Files with Paths\fR +.PP +The argument files can have paths, but any file names inside the files are relative to the current working directory (not \f3path1\fR or \f3path2\fR): +.sp +.nf +\f3javadoc @path1/options @path2/packages\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 4 Option Arguments\fR +.PP +The following example saves an argument to a \f3javadoc\fR command option in an argument file\&. The \f3-bottom\fR option is used because it can have a lengthy argument\&. You could create a file named bottom to contain the text argument: +.sp +.nf +\f3<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&. <br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\fP +.fi +.nf +\f3\fR +.fi +.sp +Run the \f3javadoc\fR command as follows:\f3javadoc -bottom @bottom @packages\fR\&. +.PP +You can also include the \f3-bottom\fR option at the start of the argument file and run the \f3javadoc\fR command as follows: \f3javadoc @bottom @packages\fR\&. +.SH RUNNING\ THE\ JAVADOC\ COMMAND +The release number of the \f3javadoc\fR command can be determined with the \f3javadoc -J-version\fR option\&. The release number of the standard doclet appears in the output stream\&. It can be turned off with the \f3-quiet\fR option\&. +.PP +Use the public programmatic interface to call the \f3javadoc\fR command from within programs written in the Java language\&. This interface is in \f3com\&.sun\&.tools\&.javadoc\&.Main\fR (and the \f3javadoc\fR command is reentrant)\&. For more information, see The Standard Doclet at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/standard-doclet\&.html#runningprogrammatically +.PP +The following instructions call the standard HTML doclet\&. To call a custom doclet, use the \f3-doclet\fR and \f3-docletpath\fR options\&. See Doclet Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/doclet/overview\&.html +.SS SIMPLE\ EXAMPLES +You can run the \f3javadoc\fR command on entire packages or individual source files\&. Each package name has a corresponding directory name\&. +.PP +In the following examples, the source files are located at /home/src/java/awt/*\&.java\&. The destination directory is /home/html\&. +.PP +Document One or More Packages + +To document a package, the source files for that package must be located in a directory that has the same name as the package\&. +.PP +If a package name has several identifiers (separated by dots, such as \f3java\&.awt\&.color\fR), then each subsequent identifier must correspond to a deeper subdirectory (such as java/awt/color)\&. +.PP +You can split the source files for a single package among two such directory trees located at different places, as long as \f3-sourcepath\fR points to them both\&. For example, src1/java/awt/color and src2/java/awt/color\&. +.PP +You can run the \f3javadoc\fR command either by changing directories (with the \f3cd\fR command) or by using the \f3-sourcepath\fR option\&. The following examples illustrate both alternatives\&. +.PP +\f3Example 1 Recursive Run from One or More Packages\fR +.PP +This example uses \f3-sourcepath\fR so the \f3javadoc\fR command can be run from any directory and \f3-subpackages\fR (a new 1\&.4 option) for recursion\&. It traverses the subpackages of the java directory excluding packages rooted at \f3java\&.net\fR and \f3java\&.lang\fR\&. Notice this excludes \f3java\&.lang\&.ref\fR, a subpackage of \f3java\&.lang\fR\&. To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as \f3java:javax:org\&.xml\&.sax\fR\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Change to Root and Run Explicit Packages\fR +.PP +Change to the parent directory of the fully qualified package\&. Then, run the \f3javadoc\fR command with the names of one or more packages that you want to document: +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +To also traverse down other package trees, append their names to the \f3-subpackages\fR argument, such as j\f3ava:javax:org\&.xml\&.sax\fR\&. +.PP +\f3Example 3 Run from Any Directory on Explicit Packages in One Tree\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with the parent directory of the top-level package\&. Provide the names of one or more packages that you want to document: +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 4 Run from Any Directory on Explicit Packages in Multiple Trees\fR +.PP +Run the \f3javadoc\fR command and use the \f3-sourcepath\fR option with a colon-separated list of the paths to each tree\&'s root\&. Provide the names of one or more packages that you want to document\&. All source files for a specified package do not need to be located under a single root directory, but they must be found somewhere along the source path\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java\&.awt java\&.awt\&.event\fP +.fi +.nf +\f3\fR +.fi +.sp +The result is that all cases generate HTML-formatted documentation for the \f3public\fR and \f3protected\fR classes and interfaces in packages j\f3ava\&.awt\fR and \f3java\&.awt\&.even\fRt and save the HTML files in the specified destination directory\&. Because two or more packages are being generated, the document has three HTML frames: one for the list of packages, another for the list of classes, and the third for the main class pages\&. +.PP +Document One or More Classes + +The second way to run the \f3javadoc\fR command is to pass one or more source files\&. You can run \f3javadoc\fR either of the following two ways: by changing directories (with the \f3cd\fR command) or by fully specifying the path to the source files\&. Relative paths are relative to the current directory\&. The \f3-sourcepath\fR option is ignored when passing source files\&. You can use command-line wild cards, such as an asterisk (*), to specify groups of classes\&. +.PP +\f3Example 1 Change to the Source Directory\fR +.PP +Change to the directory that holds the source files\&. Then run the \f3javadoc\fR command with the names of one or more source files you want to document\&. +.PP +This example generates HTML-formatted documentation for the classes \f3Button\fR, \f3Canvas,\fR and classes that begin with \f3Graphics\fR\&. Because source files rather than package names were passed in as arguments to the \f3javadoc\fR command, the document has two frames: one for the list of classes and the other for the main page\&. +.sp +.nf +\f3cd /home/src/java/awt\fP +.fi +.nf +\f3javadoc \-d /home/html Button\&.java Canvas\&.java Graphics*\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Change to the Root Directory of the Package\fR +.PP +This is useful for documenting individual source files from different subpackages off of the same root\&. Change to the package root directory, and supply the source files with paths from the root\&. +.sp +.nf +\f3cd /home/src/\fP +.fi +.nf +\f3javadoc \-d /home/html java/awt/Button\&.java java/applet/Applet\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Document Files from Any Directory\fR +.PP +In this case, it does not matter what the current directory is\&. Run the \f3javadoc\fR command with the absolute path (or path relative to the current directory) to the source files you want to document\&. +.sp +.nf +\f3javadoc \-d /home/html /home/src/java/awt/Button\&.java\fP +.fi +.nf +\f3/home/src/java/awt/Graphics*\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Document Packages and Classes + +You can document entire packages and individual classes at the same time\&. Here is an example that mixes two of the previous examples\&. You can use the \f3-sourcepath\fR option for the path to the packages but not for the path to the individual classes\&. +.sp +.nf +\f3javadoc \-d /home/html \-sourcepath /home/src java\&.awt\fP +.fi +.nf +\f3/home/src/java/applet/Applet\&.java\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS REAL-WORLD\ EXAMPLES +The following command-line and \f3makefile\fR versions of the \f3javadoc\fR command run on the Java platform APIs\&. It uses 180 MB of memory to generate the documentation for the 1500 (approximately) public and protected classes in the Java SE 1\&.2\&. Both examples use absolute paths in the option arguments, so that the same \f3javadoc\fR command can be run from any directory\&. +.PP +Command-Line Example + +The following command might be too long for some shells\&. You can use a command-line argument file (or write a shell script) to overcome this limitation\&. +.PP +In the example, \f3packages\fR is the name of a file that contains the packages to process, such as \f3java\&.applet\fR\f3java\&.lang\fR\&. None of the options should contain any newline characters between the single quotation marks\&. For example, if you copy and paste this example, then delete the newline characters from the \f3-bottom\fR option\&. +.sp +.nf +\f3javadoc \-sourcepath /java/jdk/src/share/classes \e\fP +.fi +.nf +\f3\-overview /java/jdk/src/share/classes/overview\&.html \e\fP +.fi +.nf +\f3\-d /java/jdk/build/api \e\fP +.fi +.nf +\f3\-use \e\fP +.fi +.nf +\f3\-splitIndex \e\fP +.fi +.nf +\f3\-windowtitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-doctitle \&'Java Platform, Standard Edition 7 API Specification\&' \e\fP +.fi +.nf +\f3\-header \&'<b>Java\(tm SE 7</b>\&' \e\fP +.fi +.nf +\f3\-bottom \&'<font size="\-1">\fP +.fi +.nf +\f3<a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3Other names may be trademarks of their respective owners\&.</font>\&' \e\fP +.fi +.nf +\f3\-group "Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*" \e\fP +.fi +.nf +\f3\-group "Extension Packages" "javax\&.*" \e\fP +.fi +.nf +\f3\-J\-Xmx180m \e \fP +.fi +.nf +\f3@packages\fP +.fi +.nf +\f3\fR +.fi +.sp + +.PP +Programmatic Interface + +The Javadoc Access API enables the user to invoke the Javadoc tool directly from a Java application without executing a new process\&. +.PP +For example, the following statements are equivalent to the command \f3javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java\&.net:java\&.lang com\&.example\fR: +.sp +.nf +\f3import javax\&.tools\&.DocumentationTool;\fP +.fi +.nf +\f3import javax\&.tools\&.ToolProvider;\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3public class JavaAccessSample{\fP +.fi +.nf +\f3 public static void main(String[] args){\fP +.fi +.nf +\f3 DocumentationTool javadoc = ToolProvider\&.getSystemDocumentationTool();\fP +.fi +.nf +\f3 int rc = javadoc\&.run( null, null, null,\fP +.fi +.nf +\f3 "\-d", "/home/html",\fP +.fi +.nf +\f3 "\-sourcepath", "home/src",\fP +.fi +.nf +\f3 "\-subpackages", "java",\fP +.fi +.nf +\f3 "\-exclude", "java\&.net:java\&.lang",\fP +.fi +.nf +\f3 "com\&.example");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fR +.fi +.sp +The first three arguments of the \f3run\fR method specify input, standard output, and standard error streams\&. \f3Null\fR is the default value for \f3System\&.in\fR, \f3System\&.out\fR, and \f3System\&.err\fR, respectively\&. +.SS THE\ MAKEFILE\ EXAMPLE +This is an example of a GNU \f3makefile\fR\&. Single quotation marks surround \f3makefile\fR arguments\&. For an example of a Windows \f3makefile\fR, see the \f3makefiles\fR section of the Javadoc FAQ at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html#makefiles +.sp +.nf +\f3javadoc \-sourcepath $(SRCDIR) \e /* Sets path for source files */\fP +.fi +.nf +\f3 \-overview $(SRCDIR)/overview\&.html \e /* Sets file for overview text */\fP +.fi +.nf +\f3 \-d /java/jdk/build/api \e /* Sets destination directory */\fP +.fi +.nf +\f3 \-use \e /* Adds "Use" files */\fP +.fi +.nf +\f3 \-splitIndex \e /* Splits index A\-Z */\fP +.fi +.nf +\f3 \-windowtitle $(WINDOWTITLE) \e /* Adds a window title */\fP +.fi +.nf +\f3 \-doctitle $(DOCTITLE) \e /* Adds a doc title */\fP +.fi +.nf +\f3 \-header $(HEADER) \e /* Adds running header text */\fP +.fi +.nf +\f3 \-bottom $(BOTTOM) \e /* Adds text at bottom */\fP +.fi +.nf +\f3 \-group $(GROUPCORE) \e /* 1st subhead on overview page */\fP +.fi +.nf +\f3 \-group $(GROUPEXT) \e /* 2nd subhead on overview page */\fP +.fi +.nf +\f3 \-J\-Xmx180m \e /* Sets memory to 180MB */\fP +.fi +.nf +\f3 java\&.lang java\&.lang\&.reflect \e /* Sets packages to document */\fP +.fi +.nf +\f3 java\&.util java\&.io java\&.net \e\fP +.fi +.nf +\f3 java\&.applet\fP +.fi +.nf +\f3\fR +.fi +.nf +\f3WINDOWTITLE = \&'Java\(tm SE 7 API Specification\&'\fP +.fi +.nf +\f3DOCTITLE = \&'Java\(tm Platform Standard Edition 7 API Specification\&'\fP +.fi +.nf +\f3HEADER = \&'<b>Java\(tm SE 7</font>\&'\fP +.fi +.nf +\f3BOTTOM = \&'<font size="\-1">\fP +.fi +.nf +\f3 <a href="http://bugreport\&.sun\&.com/bugreport/">Submit a bug or feature</a><br/>\fP +.fi +.nf +\f3 Copyright © 1993, 2011, Oracle and/or its affiliates\&. All rights reserved\&.<br/>\fP +.fi +.nf +\f3 Oracle is a registered trademark of Oracle Corporation and/or its affiliates\&.\fP +.fi +.nf +\f3 Other names may be trademarks of their respective owners\&.</font>\&'\fP +.fi +.nf +\f3GROUPCORE = \&'"Core Packages" "java\&.*:com\&.sun\&.java\&.*:org\&.omg\&.*"\&'\fP +.fi +.nf +\f3GROUPEXT = \&'"Extension Packages" "javax\&.*"\&'\fP +.fi +.nf +\f3SRCDIR = \&'/java/jdk/1\&.7\&.0/src/share/classes\&'\fP +.fi +.nf +\f3\fR +.fi +.sp +.SS NOTES +.TP 0.2i +\(bu +If you omit the \f3-windowtitle\fR option, then the \f3javadoc\fR command copies the document title to the window title\&. The \f3-windowtitle\fR option text is similar to the the \f3-doctitle\fR option, but without HTML tags to prevent those tags from appearing as raw text in the window title\&. +.TP 0.2i +\(bu +If you omit the \f3-footer\fR option, then the \f3javadoc\fR command copies the header text to the footer\&. +.TP 0.2i +\(bu +Other important options you might want to use, but were not needed in the previous example, are the \f3-classpath\fR and \f3-link\fR options\&. +.SH GENERAL\ TROUBLESHOOTING +.TP 0.2i +\(bu +The \f3javadoc\fR command reads only files that contain valid class names\&. If the \f3javadoc\fR command is not correctly reading the contents of a file, then verify that the class names are valid\&. See Process Source Files\&. +.TP 0.2i +\(bu +See the Javadoc FAQ for information about common bugs and for troubleshooting tips at http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137483\&.html +.SH ERRORS\ AND\ WARNINGS +Error and warning messages contain the file name and line number to the declaration line rather than to the particular line in the documentation comment\&. +.PP +For example, this message \f3error: cannot read: Class1\&.java\fR means that the \f3javadoc\fR command is trying to load \f3Class1\&.jav\fR\f3a\fR in the current directory\&. The class name is shown with its path (absolute or relative)\&. +.SH ENVIRONMENT +.TP +CLASSPATH +\f3CLASSPATH\fR is the environment variable that provides the path that the \f3javadoc\fR command uses to find user class files\&. This environment variable is overridden by the \f3-classpath\fR option\&. Separate directories with a semicolon for Windows or a colon for Oracle Solaris\&. + +\fIWindows example\fR: \f3\&.;C:\eclasses;C:\ehome\ejava\eclasses\fR + +\fIOracle Solaris example\fR: \f3\&.:/home/classes:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.SH RELATED\ DOCUMENTS +.TP 0.2i +\(bu +Javadoc Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/javadoc/index\&.html +.TP 0.2i +\(bu +How Classes Are Found http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html +.TP 0.2i +\(bu +How to Write Doc Comments for the Javadoc Tool http://www\&.oracle\&.com/technetwork/java/javase/documentation/index-137868\&.html +.TP 0.2i +\(bu +URL Memo, Uniform Resource Locators http://www\&.ietf\&.org/rfc/rfc1738\&.txt +.TP 0.2i +\(bu +HTML standard, HTML Document Representation (4197265 and 4137321) http://www\&.w3\&.org/TR/REC-html40/charset\&.html#h-5\&.2\&.2 +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/javah.1 b/jdk/src/solaris/doc/sun/man/man1/javah.1 index 16dfa9bcc93..5b8979e55c3 100644 --- a/jdk/src/solaris/doc/sun/man/man1/javah.1 +++ b/jdk/src/solaris/doc/sun/man/man1/javah.1 @@ -1,138 +1,159 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javah 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javah.1 +.\" +.if n .pl 99999 +.TH javah 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javah \- C Header and Stub File Generator -.LP -.LP -\f3javah\fP produces C header files and C source files from a Java class. These files provide the connective glue that allow your Java and C code to interact. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -javah [ \fP\f3options\fP\f3 ] fully\-qualified\-classname. . . -.fl -\fP -.fi +.SH NAME +javah \- Generates C header and source files from a Java class\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3javah\fP generates C header and source files that are needed to implement native methods. The generated header and source files are used by C programs to reference an object's instance variables from native source code. The .h file contains a struct definition whose layout parallels the layout of the corresponding class. The fields in the struct correspond to instance variables in the class. -.LP -.LP -The name of the header file and the structure declared within it are derived from the name of the class. If the class passed to \f3javah\fP is inside a package, the package name is prepended to both the header file name and the structure name. Underscores (_) are used as name delimiters. -.LP -.LP -By default \f3javah\fP creates a header file for each class listed on the command line and puts the files in the current directory. Use the \f2\-stubs\fP option to create source files. Use the \f2\-o\fP option to concatenate the results for all listed classes into a single file. -.LP -.LP -The new native method interface, Java Native Interface (JNI), does not require header information or stub files. \f3javah\fP can still be used to generate native method function proptotypes needed for JNI\-style native methods. \f3javah\fP produces JNI\-style output by default, and places the result in the .h file. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-o outputfile -Concatenates the resulting header or source files for all the classes listed on the command line into \f2outputfile\fP. Only one of \f3\-o\fP or \f3\-d\fP may be used. -.TP 3 -\-d directory -Sets the directory where \f3javah\fP saves the header files or the stub files. Only one of \f3\-d\fP or \f3\-o\fP may be used. -.TP 3 -\-stubs -Causes \f3javah\fP to generate C declarations from the Java object file. -.TP 3 -\-verbose -Indicates verbose output and causes \f3javah\fP to print a message to stdout concerning the status of the generated files. -.TP 3 -\-help -Print help message for \f3javah\fP usage. -.TP 3 -\-version -Print out \f3javah\fP version information. -.TP 3 -\-jni -Causes \f3javah\fP to create an output file containing JNI\-style native method function prototypes. This is the default output, so use of \f3\-jni\fP is optional. -.TP 3 -\-classpath path -Specifies the path \f3javah\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is: -.nf -\f3 -.fl - .:<your_path> -.fl -\fP -.fi -For example: -.nf -\f3 -.fl - .:/home/avh/classes:/usr/local/java/classes -.fl -\fP -.fi -As a special convenience, a class path element containing a basename of \f2*\fP is considered equivalent to specifying a list of all the files in the directory with the extension \f2.jar\fP or \f2.JAR\fP (a java program cannot tell the difference between the two invocations). +\fBjavah\fR [ \fIoptions\fR ] f\fIully\-qualified\-class\-name \&.\&.\&.\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIfully-qualified-class-name\fR +The fully qualified location of the classes to be converted to C header and source files\&. +.SH DESCRIPTION +The \f3javah\fR command generates C header and source files that are needed to implement native methods\&. The generated header and source files are used by C programs to reference an object\&'s instance variables from native source code\&. The \f3\&.h\fR file contains a \f3struct\fR definition with a layout that parallels the layout of the corresponding class\&. The fields in the \f3struct\fR correspond to instance variables in the class\&. +.PP +The name of the header file and the structure declared within it are derived from the name of the class\&. When the class passed to the \f3javah\fR command is inside a package, the package name is added to the beginning of both the header file name and the structure name\&. Underscores (_) are used as name delimiters\&. +.PP +By default the \f3javah\fR command creates a header file for each class listed on the command line and puts the files in the current directory\&. Use the \f3-stubs\fR option to create source files\&. Use the \f3-o\fR option to concatenate the results for all listed classes into a single file\&. +.PP +The Java Native Interface (JNI) does not require header information or stub files\&. The \f3javah\fR command can still be used to generate native method function prototypes needed for JNI-style native methods\&. The \f3javah\fR command produces JNI-style output by default and places the result in the \f3\&.h\fR file\&. +.SH OPTIONS +.TP +-o \fIoutputfile\fR .br +Concatenates the resulting header or source files for all the classes listed on the command line into an output file\&. Only one of \f3-o\fR or \f3-d\fR can be used\&. +.TP +-d \fIdirectory\fR .br -For example, if directory \f2foo\fP contains \f2a.jar\fP and \f2b.JAR\fP, then the class path element \f2foo/*\fP is expanded to a \f2A.jar:b.JAR\fP, except that the order of jar files is unspecified. All jar files in the specified directory, even hidden ones, are included in the list. A classpath entry consisting simply of \f2*\fP expands to a list of all the jar files in the current directory. The \f2CLASSPATH\fP environment variable, where defined, will be similarly expanded. Any classpath wildcard expansion occurs before the Java virtual machine is started \-\- no Java program will ever see unexpanded wildcards except by querying the environment. For example; by invoking \f2System.getenv("CLASSPATH")\fP. -.TP 3 -\-bootclasspath path -Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java 2 platform located in \f2jre/lib/rt.jar\fP and several other jar files. -.TP 3 -\-old -Specifies that old JDK1.0\-style header files should be generated. -.TP 3 -\-force -Specifies that output files should always be written. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE +Sets the directory where the \f3javah\fR command saves the header files or the stub files\&. Only one of \f3-d\fR or \f3-o\fR can be used\&. +.TP +-stubs +.br +Causes the \f3javah\fR command to generate C declarations from the Java object file\&. +.TP +-verbose +.br +Indicates verbose output and causes the \f3javah\fR command to print a message to \f3stdout\fR about the status of the generated files\&. +.TP +-help +.br +Prints a help message for \f3javah\fR usage\&. +.TP +-version +.br +Prints \f3javah\fR command release information\&. +.TP +-jni +.br +Causes the \f3javah\fR command to create an output file containing JNI-style native method function prototypes\&. This is the default output; use of \f3-jni\fR is optional\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javah\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons on Oracle Solaris and semicolons on Windows\&. The general format for path is: -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 -CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons, for example, -.nf -\f3 -.fl -.:/home/avh/classes:/usr/local/java/classes -.fl -\fP -.fi -.RE +\fIOracle Solaris\fR: -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), jdb(1), javap(1), javadoc(1) -.LP - +\&.:\fIyour-path\fR + +Example: \f3\&.:/home/avh/classes:/usr/local/java/classes\fR + +\fIWindows\fR: + +\&.;\fIyour-path\fR + +Example: \f3\&.;C:\eusers\edac\eclasses;C:\etools\ejava\eclasses\fR + +As a special convenience, a class path element that contains a base name of * is considered equivalent to specifying a list of all the files in the directory with the extension \f3\&.jar\fR or \f3\&.JAR\fR\&. + +For example, if directory \f3mydir\fR contains \f3a\&.jar\fR and \f3b\&.JAR\fR, then the class path element \f3mydir/*\fR is expanded to a \f3A\fR\f3\&.jar:b\&.JAR\fR, except that the order of jar files is unspecified\&. All JAR files in the specified directory, including hidden ones, are included in the list\&. A class path entry that consists of * expands to a list of all the JAR files in the current directory\&. The \f3CLASSPATH\fR environment variable, where defined, is similarly expanded\&. Any class path wild card expansion occurs before the Java Virtual Machine (JVM) is started\&. A Java program will never see unexpanded wild cards except by querying the environment\&. For example, by calling \f3System\&.getenv("CLASSPATH")\fR\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre\elib\ert\&.jar\fR and several other JAR files\&. +.TP +-old +.br +Specifies that old JDK 1\&.0-style header files should be generated\&. +.TP +-force +.br +Specifies that output files should always be written\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javap(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/javap.1 b/jdk/src/solaris/doc/sun/man/man1/javap.1 index aa6e8d0114c..353a13fb0fd 100644 --- a/jdk/src/solaris/doc/sun/man/man1/javap.1 +++ b/jdk/src/solaris/doc/sun/man/man1/javap.1 @@ -1,317 +1,443 @@ -." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH javap 1 "10 May 2011" +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: javap.1 +.\" +.if n .pl 99999 +.TH javap 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -javap \- The Java Class File Disassembler -.LP -.LP -Disassembles class files. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -javap [ \fP\f3options\fP\f3 ] classes -.fl -\fP -.fi +.SH NAME +javap \- Disassembles one or more class files\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3javap\fP command disassembles one or more class files. Its output depends on the options used. If no options are used, \f3javap\fP prints out the package, protected, and public fields and methods of the classes passed to it. \f3javap\fP prints its output to stdout. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -classes -List of one or more classes (separated by spaces) to be processed for annotations (such as \f2DocFooter.class\fP). You may specify a class that can be found in the class path, by its file name (for example, \f2/home/user/myproject/src/DocFooter.class\fP), or with a URL (for example, \f2file:///home/user/myproject/src/DocFooter.class\fP). -.RE +\fBjavap\fR [\fIoptions\fR] \fIclassfile\fR\&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassfile\fR +One or more classes separated by spaces to be processed for annotations such as DocFooter\&.class\&. You can specify a class that can be found in the class path, by its file name or with a URL such as \f3file:///home/user/myproject/src/DocFooter\&.class\fR\&. +.SH DESCRIPTION +The \f3javap\fR command disassembles one or more class files\&. The output depends on the options used\&. When no options are used, then the \f3javap\fR command prints the package, protected and public fields, and methods of the classes passed to it\&. The \f3javap\fR command prints its output to \f3stdout\fR\&. +.SH OPTIONS +.TP +-help, --help, -? +.br +Prints a help message for the \f3javap\fR command\&. +.TP +-version +.br +Prints release information\&. +.TP +-l +.br +Prints line and local variable tables\&. +.TP +-public +.br +Shows only public classes and members\&. +.TP +-protected +.br +Shows only protected and public classes and members\&. +.TP +-private, -p +.br +Shows all classes and members\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the JVM\&. For example: +.sp +.nf +\f3javap \-J\-version\fP +.fi +.nf +\f3javap \-J\-Djava\&.security\&.manager \-J\-Djava\&.security\&.policy=MyPolicy MyClassName\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -For example, compile the following class declaration: -.LP -.nf -\f3 -.fl -import java.awt.*; -.fl -import java.applet.*; -.fl -.fl -public class DocFooter extends Applet { -.fl - String date; -.fl - String email; -.fl - -.fl - public void init() { -.fl - resize(500,100); -.fl - date = getParameter("LAST_UPDATED"); -.fl - email = getParameter("EMAIL"); -.fl - } -.fl - -.fl - public void paint(Graphics g) { -.fl - g.drawString(date + " by ",100, 15); -.fl - g.drawString(email,290,15); -.fl - } -.fl -} -.fl -\fP -.fi - -.LP -.LP -The output from \f3javap DocFooter.class\fP yields: -.LP -.nf -\f3 -.fl -Compiled from "DocFooter.java" -.fl -public class DocFooter extends java.applet.Applet { -.fl - java.lang.String date; -.fl - java.lang.String email; -.fl - public DocFooter(); -.fl - public void init(); -.fl - public void paint(java.awt.Graphics); -.fl -} -.fl -\fP -.fi - -.LP -.LP -The output from \f3javap \-c DocFooter.class\fP yields: -.LP -.nf -\f3 -.fl -Compiled from "DocFooter.java" -.fl -public class DocFooter extends java.applet.Applet { -.fl - java.lang.String date; -.fl - -.fl - java.lang.String email; -.fl - -.fl - public DocFooter(); -.fl - Code: -.fl - 0: aload_0 -.fl - 1: invokespecial #1 // Method java/applet/Applet."<init>":()V -.fl - 4: return -.fl - -.fl - public void init(); -.fl - Code: -.fl - 0: aload_0 -.fl - 1: sipush 500 -.fl - 4: bipush 100 -.fl - 6: invokevirtual #2 // Method resize:(II)V -.fl - 9: aload_0 -.fl - 10: aload_0 -.fl - 11: ldc #3 // String LAST_UPDATED -.fl - 13: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String; -.fl - 16: putfield #5 // Field date:Ljava/lang/String; -.fl - 19: aload_0 -.fl - 20: aload_0 -.fl - 21: ldc #6 // String EMAIL -.fl - 23: invokevirtual #4 // Method getParameter:(Ljava/lang/String;)Ljava/lang/String; -.fl - 26: putfield #7 // Field email:Ljava/lang/String; -.fl - 29: return -.fl - -.fl - public void paint(java.awt.Graphics); -.fl - Code: -.fl - 0: aload_1 -.fl - 1: new #8 // class java/lang/StringBuilder -.fl - 4: dup -.fl - 5: invokespecial #9 // Method java/lang/StringBuilder."<init>":()V -.fl - 8: aload_0 -.fl - 9: getfield #5 // Field date:Ljava/lang/String; -.fl - 12: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder; -.fl - 15: ldc #11 // String by -.fl - 17: invokevirtual #10 // Method java/lang/StringBuilder.append:(Ljava/lang/String;)Ljava/lang/StringBuilder; -.fl - 20: invokevirtual #12 // Method java/lang/StringBuilder.toString:()Ljava/lang/String; -.fl - 23: bipush 100 -.fl - 25: bipush 15 -.fl - 27: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V -.fl - 30: aload_1 -.fl - 31: aload_0 -.fl - 32: getfield #7 // Field email:Ljava/lang/String; -.fl - 35: sipush 290 -.fl - 38: bipush 15 -.fl - 40: invokevirtual #13 // Method java/awt/Graphics.drawString:(Ljava/lang/String;II)V -.fl - 43: return -.fl -} -.fl -\fP -.fi - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-help \-\-help \-? -Prints out help message for \f3javap\fP. -.TP 3 -\-version -Prints out version information. -.TP 3 -\-l -Prints out line and local variable tables. -.TP 3 -\-public -Shows only public classes and members. -.TP 3 -\-protected -Shows only protected and public classes and members. -.TP 3 -\-package -Shows only package, protected, and public classes and members. This is the default. -.TP 3 -\-private \-p -Shows all classes and members. -.TP 3 -\-Jflag -Pass \f2flag\fP directly to the runtime system. Some examples: -.nf -\f3 -.fl -javap \-J\-version -.fl -javap \-J\-Djava.security.manager \-J\-Djava.security.policy=MyPolicy MyClassName -.fl -\fP -.fi -.TP 3 -\-s -Prints internal type signatures. -.TP 3 -\-sysinfo -Shows system information (path, size, date, MD5 hash) of the class being processed. -.TP 3 -\-constants -Shows static final constants. -.TP 3 -\-c -Prints out disassembled code, i.e., the instructions that comprise the Java bytecodes, for each of the methods in the class. These are documented in the -.na -\f2Java Virtual Machine Specification\fP @ -.fi -http://java.sun.com/docs/books/vmspec/. -.TP 3 -\-verbose -Prints stack size, number of \f2locals\fP and \f2args\fP for methods. -.TP 3 -\-classpath path -Specifies the path \f3javap\fP uses to look up classes. Overrides the default or the CLASSPATH environment variable if it is set. -.TP 3 -\-bootclasspath path -Specifies path from which to load bootstrap classes. By default, the bootstrap classes are the classes implementing the core Java platform located in \f2jre/lib/rt.jar\fP and several other jar files. -.TP 3 -\-extdirs dirs -Overrides location at which installed extensions are searched for. The default location for extensions is the value of \f2java.ext.dirs\fP. -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), jdb(1), javah(1), javadoc(1) -.LP - +For more information about JVM options, see the \f3java(1)\fR command documentation\&. +.TP +-s +.br +Prints internal type signatures\&. +.TP +-sysinfo +.br +Shows system information (path, size, date, MD5 hash) of the class being processed\&. +.TP +-constants +.br +Shows \f3static final\fR constants\&. +.TP +-c +.br +Prints disassembled code, for example, the instructions that comprise the Java bytecodes, for each of the methods in the class\&. +.TP +-verbose +.br +Prints stack size, number of locals and arguments for methods\&. +.TP +-classpath \fIpath\fR +.br +Specifies the path the \f3javap\fR command uses to look up classes\&. Overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. +.TP +-bootclasspath \fIpath\fR +.br +Specifies the path from which to load bootstrap classes\&. By default, the bootstrap classes are the classes that implement the core Java platform located in \f3jre/lib/rt\&.jar\fR and several other JAR files\&. +.TP +-extdir \fIdirs\fR +.br +Overrides the location at which installed extensions are searched for\&. The default location for extensions is the value of \f3java\&.ext\&.dirs\fR\&. +.SH EXAMPLE +Compile the following \f3DocFooter\fR class: +.sp +.nf +\f3import java\&.awt\&.*;\fP +.fi +.nf +\f3import java\&.applet\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class DocFooter extends Applet {\fP +.fi +.nf +\f3 String date;\fP +.fi +.nf +\f3 String email;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void init() {\fP +.fi +.nf +\f3 resize(500,100);\fP +.fi +.nf +\f3 date = getParameter("LAST_UPDATED");\fP +.fi +.nf +\f3 email = getParameter("EMAIL");\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void paint(Graphics g) {\fP +.fi +.nf +\f3 g\&.drawString(date + " by ",100, 15);\fP +.fi +.nf +\f3 g\&.drawString(email,290,15);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +The output from the \f3javap DocFooter\&.class\fR command yields the following: +.sp +.nf +\f3Compiled from "DocFooter\&.java"\fP +.fi +.nf +\f3public class DocFooter extends java\&.applet\&.Applet {\fP +.fi +.nf +\f3 java\&.lang\&.String date;\fP +.fi +.nf +\f3 java\&.lang\&.String email;\fP +.fi +.nf +\f3 public DocFooter();\fP +.fi +.nf +\f3 public void init();\fP +.fi +.nf +\f3 public void paint(java\&.awt\&.Graphics);\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +The output from \f3javap -c DocFooter\&.class\fR command yields the following: +.sp +.nf +\f3Compiled from "DocFooter\&.java"\fP +.fi +.nf +\f3public class DocFooter extends java\&.applet\&.Applet {\fP +.fi +.nf +\f3 java\&.lang\&.String date;\fP +.fi +.nf +\f3 java\&.lang\&.String email;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public DocFooter();\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_0 \fP +.fi +.nf +\f3 1: invokespecial #1 // Method\fP +.fi +.nf +\f3java/applet/Applet\&."<init>":()V\fP +.fi +.nf +\f3 4: return \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void init();\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_0 \fP +.fi +.nf +\f3 1: sipush 500\fP +.fi +.nf +\f3 4: bipush 100\fP +.fi +.nf +\f3 6: invokevirtual #2 // Method resize:(II)V\fP +.fi +.nf +\f3 9: aload_0 \fP +.fi +.nf +\f3 10: aload_0 \fP +.fi +.nf +\f3 11: ldc #3 // String LAST_UPDATED\fP +.fi +.nf +\f3 13: invokevirtual #4 // Method\fP +.fi +.nf +\f3 getParameter:(Ljava/lang/String;)Ljava/lang/String;\fP +.fi +.nf +\f3 16: putfield #5 // Field date:Ljava/lang/String;\fP +.fi +.nf +\f3 19: aload_0 \fP +.fi +.nf +\f3 20: aload_0 \fP +.fi +.nf +\f3 21: ldc #6 // String EMAIL\fP +.fi +.nf +\f3 23: invokevirtual #4 // Method\fP +.fi +.nf +\f3 getParameter:(Ljava/lang/String;)Ljava/lang/String;\fP +.fi +.nf +\f3 26: putfield #7 // Field email:Ljava/lang/String;\fP +.fi +.nf +\f3 29: return \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public void paint(java\&.awt\&.Graphics);\fP +.fi +.nf +\f3 Code:\fP +.fi +.nf +\f3 0: aload_1 \fP +.fi +.nf +\f3 1: new #8 // class java/lang/StringBuilder\fP +.fi +.nf +\f3 4: dup \fP +.fi +.nf +\f3 5: invokespecial #9 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&."<init>":()V\fP +.fi +.nf +\f3 8: aload_0 \fP +.fi +.nf +\f3 9: getfield #5 // Field date:Ljava/lang/String;\fP +.fi +.nf +\f3 12: invokevirtual #10 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;\fP +.fi +.nf +\f3 15: ldc #11 // String by \fP +.fi +.nf +\f3 17: invokevirtual #10 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.append:(Ljava/lang/String;)Ljava/lang/StringBuilder;\fP +.fi +.nf +\f3 20: invokevirtual #12 // Method\fP +.fi +.nf +\f3 java/lang/StringBuilder\&.toString:()Ljava/lang/String;\fP +.fi +.nf +\f3 23: bipush 100\fP +.fi +.nf +\f3 25: bipush 15\fP +.fi +.nf +\f3 27: invokevirtual #13 // Method\fP +.fi +.nf +\f3 java/awt/Graphics\&.drawString:(Ljava/lang/String;II)V\fP +.fi +.nf +\f3 30: aload_1 \fP +.fi +.nf +\f3 31: aload_0 \fP +.fi +.nf +\f3 32: getfield #7 // Field email:Ljava/lang/String;\fP +.fi +.nf +\f3 35: sipush 290\fP +.fi +.nf +\f3 38: bipush 15\fP +.fi +.nf +\f3 40: invokevirtual #13 // Method\fP +.fi +.nf +\f3java/awt/Graphics\&.drawString:(Ljava/lang/String;II)V\fP +.fi +.nf +\f3 43: return \fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jdb(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javadoc(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jcmd.1 b/jdk/src/solaris/doc/sun/man/man1/jcmd.1 index 3e0cd2a19fa..f789bdc5286 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jcmd.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jcmd.1 @@ -1,124 +1,114 @@ -." Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jcmd 1 "22 Novembre 2011" +'\" t +.\" Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jcmd.1 +.\" +.if n .pl 99999 +.TH jcmd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jcmd \- Diagnostic Command +.SH NAME +jcmd \- Sends diagnostic command requests to a running Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf + +\fBjcmd\fR [\fB\-l\fR|\fB\-h\fR|\fB\-help\fR] +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fBPerfCounter\&.print\fR +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fB\-f\fR \fIfilename\fR +.fi +.nf + +\fBjcmd\fR \fIpid\fR|\fImain\-class\fR \fIcommand\fR[ \fIarguments\fR] +.fi +.sp +.SH DESCRIPTION +The \f3jcmd\fR utility is used to send diagnostic command requests to the JVM\&. It must be used on the same machine on which the JVM is running, and have the same effective user and group identifiers that were used to launch the JVM\&. +.PP +\fINote:\fR To invoke diagnostic commands from a remote machine or with different identiers, you can use the \f3com\&.sun\&.management\&.DiagnosticCommandMBean\fR interface\&. For more information about the \f3DiagnosticCommandMBean\fR interface, see the API documentation at http://download\&.java\&.net/jdk8/docs/jre/api/management/extension/com/sun/management/DiagnosticCommandMBean\&.html +.PP +If you run \f3jcmd\fR without arguments or with the \f3-l\fR option, it prints the list of running Java process identifiers with the main class and command-line arguments that were used to launch the process\&. Running \f3jcmd\fR with the \f3-h\fR or \f3-help\fR option prints the tool\(cqs help message\&. +.PP +If you specify the processes identifier (\fIpid\fR) or the main class (\fImain-class\fR) as the first argument, \f3jcmd\fR sends the diagnostic command request to the Java process with the specified identifier or to all Java processes with the specified name of the main class\&. You can also send the diagnostic command request to all available Java processes by specifying \f30\fR as the process identifier\&. Use one of the following as the diagnostic command request: +.TP +Perfcounter\&.print +Prints the performance counters available for the specified Java process\&. The list of performance counters might vary with the Java process\&. +.TP +-f \fIfilename\fR .br - -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jcmd\fP [ option ] -.fl -\f3jcmd\fP <\fIpid\fR | \fImain class\fR> PerfCounter.print -.fl -\f3jcmd\fP <\fIpid\fR | \fImain class\fR> \fIcommand\fR [\fIarguments\fR] -.fl -\f3jcmd\fP <\fIpid\fR | \fImain class\fR> -f \fIfile\fR -.fl -.fl -.fi - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jcmd\fP is a utility to send diagnostic command requests to a Java -Virtual Machine supporting this feature. Used without arguments or with the \-l option, jcmd prints the list of running Java processes with their process id, their main class and their command line arguments. When a process id is specified on the command line, jcmd sends the diagnostic command request to the process with this id. When a main class is specified on the command line, jcmd sends the diagnostic command request to all Java processes with this main class. With the PerfCounter.print argument, jcmd prints the performance counters available on the targeted Java process(es). With the \-f option, jcmd sends to the targeted Java process(es) the diagnostic commands stored in the file \fIfile\fR. -.LP -\fP -.fi - -.SH "OPTIONS" -.LP -.LP -Options are mutually exclusive. Options, if used, should follow immediately after the command name. -.LP -.RS 3 -.TP 3 -\-l -prints the list of running Java processes with their process id, their -main class and their command line arguments. -.TP 3 -\-h -prints a help message. -.br -.br -.TP 3 -\-help -prints a help message -.br -.RE - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -\fIpid\fR -Identifies the process which will receive the diagnostic command requests. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) or jcmd(1) may be used. -.RE -.LP -.RS 3 -.TP 3 -\fImain class\fR -Main class of the process which will receive the diagnostic command requests. If several running Java processes share this main class, the diagnostic command request will be sent to all these processes. To get a list of Java processes running on a machine, jps(1) or jcmd(1) may be used. -.RE -.RS 3 -.TP 3 +The name of the file from which to read diagnostic commands and send them to the specified Java process\&. Used only with the \f3-f\fR option\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. +.TP \fIcommand\fR [\fIarguments\fR] -Invoke the diagnostic command called \fIcommand\fR on the targeted Java -process(es). The list of available diagnostic commands for a given -process can be obtained by invoking the 'help' command on this process. -Each diagnostic command has its own set of \fIarguments\fR which can be -obtained by invoking the 'help' command followed by the command name. -.RE -.RS 3 -.TP 3 -\fIPerfCounter.print\fR -Print the performance counters available on the targeted Java -process(es). The list of performance counters may vary with the Java -process. -.RE -.RS 3 -.TP 3 -\fI-f file\fR -Read commands from \fIfile\fR and invoke them on the targeted Java -process(es). In \fIfile\fR, each command must be written on a single line. -Lines starting with # are ignored. Processing of \fIfile\fR ends when -all lines have been invoked or when a line containing the 'stop' keyword -is read. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jps(1) -.RE +The command to be sent to the specified Java process\&. The list of available diagnostic commands for a given process can be obtained by sending the \f3help\fR command to this process\&. Each diagnostic command has its own set of arguments\&. To see the description, syntax, and a list of available arguments for a command, use the name of the command as the argument for the \f3help\fR command\&. - +\fINote:\fR If any arguments contain spaces, you must surround them with single or double quotation marks (\f3\&'\fR or \f3"\fR)\&. In addition, you must escape single or double quotation marks with a backslash (\f3\e\fR) to prevent the operating system shell from processing quotation marks\&. Alternatively, you can surround these arguments with single quotation marks and then with double quotation marks (or with double quotation marks and then with single quotation marks)\&. +.SH OPTIONS +Options are mutually exclusive\&. +.TP +-f \fIfilename\fR +.br +Reads commands from the specified file\&. This option can be used only if you specify the process identifier or the main class as the first argument\&. Each command in the file must be written on a single line\&. Lines starting with a number sign (\f3#\fR) are ignored\&. Processing of the file ends when all lines have been read or when a line containing the \f3stop\fR keyword is read\&. +.TP +-h, -help +.br +Prints a help message\&. +.TP +-l +.br +Prints the list of running Java processes identifiers with the main class and command-line arguments\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jconsole.1 b/jdk/src/solaris/doc/sun/man/man1/jconsole.1 index 14d87bb83c5..8afd342a36b 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jconsole.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jconsole.1 @@ -1,137 +1,113 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jconsole 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Troubleshooting, Profiling, Monitoring and Management Tools +.\" Title: jconsole.1 +.\" +.if n .pl 99999 +.TH jconsole 1 "21 November 2013" "JDK 8" "Java Troubleshooting, Profiling, Monitoring and Management Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jconsole \- Java Monitoring and Management Console -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jconsole\fP [ \f2options\fP ] [ connection ... ] -.fl +.SH NAME +jconsole \- Starts a graphical console that lets you monitor and manage Java applications\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi +\fBjconsole\fR [ \fIoptions\fR ] [ connection \&.\&.\&. ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +connection = \fIpid\fR | \fIhost\fR:\fIport\fR | \fIjmxURL\fR +The \f3pid\fR value is the process ID of a local Java Virtual Machine (JVM)\&. The JVM must be running with the same user ID as the user ID running the \f3jconsole\fR command\&.The \f3host:port\fR values are the name of the host system on which the JVM is running, and the port number specified by the system property \f3com\&.sun\&.management\&.jmxremote\&.port\fR when the JVM was started\&.The \f3jmxUrl\fR value is the address of the JMX agent to be connected to as described in JMXServiceURL\&. -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -connection = pid | host:port | jmxUrl -.RS 3 -.TP 2 -o -\f2pid\fP Process ID of a local Java VM. The Java VM must be running with the same user ID as the user ID running jconsole. See -.na -\f2JMX Monitoring and Management\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. -.TP 2 -o -\f2host\fP:\f2port\fP Name of the host system on which the Java VM is running and the port number specified by the system property \f2com.sun.management.jmxremote.port\fP when the Java VM was started. See -.na -\f2JMX Monitoring and Management\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/agent.html for details. -.TP 2 -o -\f2jmxUrl\fP Address of the JMX agent to be connected to as described in -.na -\f2JMXServiceURL\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html. -.RE -.RE +For more information about the \f3connection\fR parameter, see Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jconsole\fP command launches a graphical console tool that enables you to monitor and manage Java applications and virtual machines on a local or remote machine. -.LP -.LP -On Windows, \f3jconsole\fP does not associate with a console window. It will, however, display a dialog box with error information if the \f3jconsole\fP command fails for some reason. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-interval=n -Set the update interval to \f2n\fP seconds (default is 4 seconds). -.TP 3 -\-notile -Do not tile windows initially (for two or more connections). -.TP 3 -\-pluginpath plugins -Specify a list of directories or JAR files which are searched for JConsole plugins. The \f2plugins\fP path should contain a provider\-configuration file named: +See also the \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.SH DESCRIPTION +The \f3jconsole\fR command starts a graphical console tool that lets you monitor and manage Java applications and virtual machines on a local or remote machine\&. +.PP +On Windows, the \f3jconsole\fR command does not associate with a console window\&. It does, however, display a dialog box with error information when the \f3jconsole\fR command fails\&. +.SH OPTIONS +.TP +-interval\fI=n\fR .br -.nf -\f3 -.fl - META\-INF/services/com.sun.tools.jconsole.JConsolePlugin -.fl -\fP -.fi -containing one line for each plugin specifying the fully qualified class name of the class implementing the -.na -\f2com.sun.tools.jconsole.JConsolePlugin\fP @ -.fi -http://download.oracle.com/javase/7/docs/jdk/api/jconsole/spec/com/sun/tools/jconsole/JConsolePlugin.html class. -.TP 3 -\-version -Output version information and exit. -.TP 3 -\-help -Output help message and exit. -.TP 3 -\-J<flag> -Pass <flag> to the Java virtual machine on which jconsole is run. -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -.na -\f2Using JConsole\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/jconsole.html -.TP 2 -o -.na -\f2Monitoring and Management for Java Platform\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/management/index.html -.RE - -.LP - +Sets the update interval to \fIn\fR seconds (default is 4 seconds)\&. +.TP +-notile +.br +Does not tile windows initially (for two or more connections)\&. +.TP +-pluginpath \fIplugins\fR +.br +Specifies a list of directories or JAR files to be searched for \f3JConsole\fR plug-ins\&. The \fIplugins\fR path should contain a provider-configuration file named \f3META-INF/services/com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR that contains one line for each plug-in\&. The line specifies the fully qualified class name of the class implementing the \f3com\&.sun\&.tools\&.jconsole\&.JConsolePlugin\fR class\&. +.TP +-version +.br +Displays release information and exits\&. +.TP +-help +.br +Displays a help message\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the JVM on which the \f3jconsole\fR command is run\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using JConsole at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/jconsole\&.html +.TP 0.2i +\(bu +Monitoring and Management Using JMX Technology at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/management/agent\&.html +.TP 0.2i +\(bu +The \f3JMXServiceURL\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/javax/management/remote/JMXServiceURL\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jdb.1 b/jdk/src/solaris/doc/sun/man/man1/jdb.1 index e89a60b9748..4304f15e8a9 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jdb.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jdb.1 @@ -1,330 +1,271 @@ -." Copyright (c) 1995, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jdb 1 "10 May 2011" +'\" t +.\" Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdb.1 +.\" +.if n .pl 99999 +.TH jdb 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jdb \- The Java Debugger -.LP -.LP -\f3jdb\fP helps you find and fix bugs in Java language programs. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jdb\fP [ options ] [ class ] [ arguments ] -.fl -.fi +.SH NAME +jdb \- Finds and fixes bugs in Java platform programs\&. +.SH SYNOPSIS +.sp +.nf -.LP -.RS 3 -.TP 3 -options -Command\-line options, as specified below. -.TP 3 -class -Name of the class to begin debugging. -.TP 3 -arguments -Arguments passed to the \f2main()\fP method of \f2class\fP. -.RE +\fBjdb\fR [\fIoptions\fR] [\fIclassname\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fRname +Name of the main class to debug\&. +.TP +\fIarguments\fR +Arguments passed to the \f3main()\fR method of the class\&. +.SH DESCRIPTION +The Java Debugger (JDB) is a simple command-line debugger for Java classes\&. The \f3jdb\fR command and its options call the JDB\&. The \f3jdb\fR command demonstrates the Java Platform Debugger Architecture (JDBA) and provides inspection and debugging of a local or remote Java Virtual Machine (JVM)\&. See Java Platform Debugger Architecture (JDBA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.SS START\ A\ JDB\ SESSION +There are many ways to start a JDB session\&. The most frequently used way is to have JDB launch a new JVM with the main class of the application to be debugged\&. Do this by substituting the \f3jdb\fR command for the \f3java\fR command in the command line\&. For example, if your application\&'s main class is \f3MyClass\fR, then use the following command to debug it under JDB: +.sp +.nf +\f3jdb MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +When started this way, the \f3jdb\fR command calls a second JVM with the specified parameters, loads the specified class, and stops the JVM before executing that class\&'s first instruction\&. +.PP +Another way to use the \f3jdb\fR command is by attaching it to a JVM that is already running\&. Syntax for starting a JVM to which the \f3jdb\fR command attaches when the JVM is running is as follows\&. This loads in-process debugging libraries and specifies the kind of connection to be made\&. +.sp +.nf +\f3java \-agentlib:jdwp=transport=dt_socket,server=y,suspend=n MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp +You can then attach the \f3jdb\fR command to the JVM with the following command: +.sp +.nf +\f3jdb \-attach 8000\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3MyClass\fR argument is not specified in the \f3jdb\fR command line in this case because the \f3jdb\fR command is connecting to an existing JVM instead of launching a new JVM\&. +.PP +There are many other ways to connect the debugger to a JVM, and all of them are supported by the \f3jdb\fR command\&. The Java Platform Debugger Architecture has additional documentation on these connection options\&. +.SS BASIC\ JDB\ COMMANDS +The following is a list of the basic \f3jdb\fR commands\&. The JDB supports other commands that you can list with the \f3-help\fR option\&. +.TP +help or ? +The \f3help\fR or \f3?\fR commands display the list of recognized commands with a brief description\&. +.TP +run +After you start JDB and set breakpoints, you can use the \f3run\fR command to execute the debugged application\&. The \f3run\fR command is available only when the \f3jdb\fR command starts the debugged application as opposed to attaching to an existing JVM\&. +.TP +cont +Continues execution of the debugged application after a breakpoint, exception, or step\&. +.TP +print +Displays Java objects and primitive values\&. For variables or fields of primitive types, the actual value is printed\&. For objects, a short description is printed\&. See the dump command to find out how to get more information about an object\&. -.LP -.SH "DESCRIPTION" -.LP -.LP -The Java Debugger, \f3jdb\fP, is a simple command\-line debugger for Java classes. It is a demonstration of the -.na -\f2Java Platform Debugger Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/index.html that provides inspection and debugging of a local or remote Java Virtual Machine. -.LP -.SS -Starting a jdb Session -.LP -.LP -There are many ways to start a jdb session. The most frequently used way is to have \f3jdb\fP launch a new Java Virtual Machine (VM) with the main class of the application to be debugged. This is done by substituting the command \f3jdb\fP for \f3java\fP in the command line. For example, if your application's main class is MyClass, you use the following command to debug it under JDB: -.LP -.nf -\f3 -.fl - % jdb MyClass -.fl -\fP -.fi +\fINote:\fR To display local variables, the containing class must have been compiled with the \f3javac -g\fR option\&. -.LP -.LP -When started this way, \f3jdb\fP invokes a second Java VM with any specified parameters, loads the specified class, and stops the VM before executing that class's first instruction. -.LP -.LP -Another way to use \f3jdb\fP is by attaching it to a Java VM that is already running. Syntax for Starting a VM to which jdb will attach when the VM is running is as follows. This loads in\-process debugging libraries and specifies the kind of connection to be made. -.LP -.nf -\f3 -.fl -\-agentlib:jdwp=transport=dt_socket,server=y,suspend=n -.fl -\fP -.fi +The \f3print\fR command supports many simple Java expressions including those with method invocations, for example: +.sp +.nf +\f3print MyClass\&.myStaticField\fP +.fi +.nf +\f3print myObj\&.myInstanceField\fP +.fi +.nf +\f3print i + j + k (i, j, k are primities and either fields or local variables)\fP +.fi +.nf +\f3print myObj\&.myMethod() (if myMethod returns a non\-null)\fP +.fi +.nf +\f3print new java\&.lang\&.String("Hello")\&.length()\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -For example, the following command will run the MyClass application, and allow \f3jdb\fP to connect to it at a later time. -.LP -.nf -\f3 -.fl - % java \-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n MyClass -.fl -\fP -.fi +.TP +dump +For primitive values, the \f3dump\fR command is identical to the \f3print\fR command\&. For objects, the \f3dump\fR command prints the current value of each field defined in the object\&. Static and instance fields are included\&. The \f3dump\fR command supports the same set of expressions as the \f3print\fR command\&. +.TP +threads +List the threads that are currently running\&. For each thread, its name and current status are printed and an index that can be used in other commands\&. In this example, the thread index is 4, the thread is an instance of \f3java\&.lang\&.Thread\fR, the thread name is \f3main\fR, and it is currently running\&. +.sp +.nf +\f34\&. (java\&.lang\&.Thread)0x1 main running\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -You can then attach \f3jdb\fP to the VM with the following commmand: -.LP -.nf -\f3 -.fl - % jdb \-attach 8000 -.fl -\fP -.fi +.TP +thread +Select a thread to be the current thread\&. Many \f3jdb\fR commands are based on the setting of the current thread\&. The thread is specified with the thread index described in the threads command\&. +.TP +where +The \f3where\fR command with no arguments dumps the stack of the current thread\&. The \f3where\fR\f3all\fR command dumps the stack of all threads in the current thread group\&. The \f3where\fR\f3threadindex\fR command dumps the stack of the specified thread\&. -.LP -.LP -Note that "MyClass" is not specified in the \f3jdb\fP command line in this case because \f3jdb\fP is connecting to an existing VM instead of launching a new one. -.LP -.LP -There are many other ways to connect the debugger to a VM, and all of them are supported by \f3jdb\fP. The Java Platform Debugger Architecture has additional -.na -\f2documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection options. For information on starting a J2SE 1.4.2 or early VM for use with \f3jdb\fP see the -.na -\f21.4.2 documentation\fP @ -.fi -http://java.sun.com/j2se/1.4.2/docs/guide/jpda/conninv.html -.LP -.SS -Basic jdb Commands -.LP -.LP -The following is a list of the basic \f3jdb\fP commands. The Java debugger supports other commands which you can list using \f3jdb\fP's \f2help\fP command. -.LP -.RS 3 -.TP 3 -help, or ? -The most important \f3jdb\fP command, \f2help\fP displays the list of recognized commands with a brief description. -.TP 3 -run -After starting \f3jdb\fP, and setting any necessary breakpoints, you can use this command to start the execution the debugged application. This command is available only when \f3jdb\fP launches the debugged application (as opposed to attaching to an existing VM). -.TP 3 -cont -Continues execution of the debugged application after a breakpoint, exception, or step. -.TP 3 -print -Displays Java objects and primitive values. For variables or fields of primitive types, the actual value is printed. For objects, a short description is printed. See the \f2dump\fP command below for getting more information about an object. +If the current thread is suspended either through an event such as a breakpoint or through the \f3suspend\fR command, then local variables and fields can be displayed with the \f3print\fR and \f3dump\fR commands\&. The \f3up\fR and \f3down\fR commands select which stack frame is the current stack frame\&. +.SS BREAKPOINTS +Breakpoints can be set in JDB at line numbers or at the first instruction of a method, for example: +.TP 0.2i +\(bu +The command \f3stop at MyClass:22\fR sets a breakpoint at the first instruction for line 22 of the source file containing \f3MyClass\fR\&. +.TP 0.2i +\(bu +The command \f3stop in java\&.lang\&.String\&.length\fR sets a breakpoint at the beginning of the method \f3java\&.lang\&.String\&.length\fR\&. +.TP 0.2i +\(bu +The command \f3stop in MyClass\&.<clinit>\fR uses \f3<clinit>\fR to identify the static initialization code for \f3MyClass\fR\&. +.PP +When a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint\&. For example, \f3MyClass\&.myMethod(int,java\&.lang\&.String)\fR or \f3MyClass\&.myMethod()\fR\&. +.PP +The \f3clear\fR command removes breakpoints using the following syntax: \f3clear MyClass:45\fR\&. Using the \f3clear\fR or \f3stop\fR command with no argument displays a list of all breakpoints currently set\&. The \f3cont\fR command continues execution\&. +.SS STEPPING +The \f3step\fR command advances execution to the next line whether it is in the current stack frame or a called method\&. The \f3next\fR command advances execution to the next line in the current stack frame\&. +.SS EXCEPTIONS +When an exception occurs for which there is not a \f3catch\fR statement anywhere in the throwing thread\&'s call stack, the JVM typically prints an exception trace and exits\&. When running under JDB, however, control returns to JDB at the offending throw\&. You can then use the \f3jdb\fR command to diagnose the cause of the exception\&. +.PP +Use the \f3catch\fR command to cause the debugged application to stop at other thrown exceptions, for example: \f3catch java\&.io\&.FileNotFoundException\fR or \f3catch\fR\f3mypackage\&.BigTroubleException\fR\&. Any exception that is an instance of the specified class or subclass stops the application at the point where it is thrown\&. +.PP +The \f3ignore\fR command negates the effect of an earlier \f3catch\fR command\&. The \f3ignore\fR command does not cause the debugged JVM to ignore specific exceptions, but only to ignore the debugger\&. +.SH OPTIONS +When you use the \f3jdb\fR command instead of the \f3java\fR command on the command line, the \f3jdb\fR command accepts many of the same options as the \f3java\fR command, including \f3-D\fR, \f3-classpath\fR, and \f3-X\fR options\&. The following list contains additional options that are accepted by the \f3jdb\fR command\&. +.PP +Other options are supported to provide alternate mechanisms for connecting the debugger to the JVM it is to debug\&. For additional documentation about these connection alternatives, see Java Platform Debugger Architecture (JPDA) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/jpda/index\&.html +.TP +-help .br +Displays a help message\&. +.TP +-sourcepath \fIdir1:dir2: \&. \&. \&.\fR .br -\f2NOTE: To display local variables, the containing class must have been compiled with the \fP\f2javac(1)\fP\f2 \fP\f2\-g\fP option. +Uses the specified path to search for source files in the specified path\&. If this option is not specified, then use the default path of dot (\&.)\&. +.TP +-attach \fIaddress\fR .br +Attaches the debugger to a running JVM with the default connection mechanism\&. +.TP +-listen \fIaddress\fR .br -\f2print\fP supports many simple Java expressions including those with method invocations, for example: -.RS 3 -.TP 2 -o -\f2print MyClass.myStaticField\fP -.TP 2 -o -\f2print myObj.myInstanceField\fP -.TP 2 -o -\f2print i + j + k\fP \f2(i, j, k are primities and either fields or local variables)\fP -.TP 2 -o -\f2print myObj.myMethod()\fP \f2(if myMethod returns a non\-null)\fP -.TP 2 -o -\f2print new java.lang.String("Hello").length()\fP -.RE -.TP 3 -dump -For primitive values, this command is identical to \f2print\fP. For objects, it prints the current value of each field defined in the object. Static and instance fields are included. +Waits for a running JVM to connect to the specified address with a standard connector\&. +.TP +-launch .br +Starts the debugged application immediately upon startup of JDB\&. The \f3-launch\fR option removes the need for the \f3run\fR command\&. The debugged application is launched and then stopped just before the initial application class is loaded\&. At that point, you can set any necessary breakpoints and use the \f3cont\fR command to continue execution\&. +.TP +-listconnectors .br -The \f2dump\fP command supports the same set of expressions as the \f2print\fP command. -.TP 3 -threads -List the threads that are currently running. For each thread, its name and current status are printed, as well as an index that can be used for other commands, for example: -.nf -\f3 -.fl -4. (java.lang.Thread)0x1 main running -.fl -\fP -.fi -In this example, the thread index is 4, the thread is an instance of java.lang.Thread, the thread name is "main", and it is currently running, -.TP 3 -thread -Select a thread to be the current thread. Many \f3jdb\fP commands are based on the setting of the current thread. The thread is specified with the thread index described in the \f2threads\fP command above. -.TP 3 -where -\f2where\fP with no arguments dumps the stack of the current thread. \f2where all\fP dumps the stack of all threads in the current thread group. \f2where\fP \f2threadindex\fP dumps the stack of the specified thread. +List the connectors available in this JVM\&. +.TP +-connect connector-name:\fIname1=value1\fR .br +Connects to the target JVM with the named connector and listed argument values\&. +.TP +-dbgtrace [\fIflags\fR] .br -If the current thread is suspended (either through an event such as a breakpoint or through the \f2suspend\fP command), local variables and fields can be displayed with the \f2print\fP and \f2dump\fP commands. The \f2up\fP and \f2down\fP commands select which stack frame is current. -.RE - -.LP -.SS -Breakpoints -.LP -.LP -Breakpoints can be set in \f3jdb\fP at line numbers or at the first instruction of a method, for example: -.LP -.RS 3 -.TP 2 -o -\f2stop at MyClass:22\fP \f2(sets a breakpoint at the first instruction for line 22 of the source file containing MyClass)\fP -.TP 2 -o -\f2stop in java.lang.String.length\fP \f2(sets a breakpoint at the beginnig of the method \fP\f2java.lang.String.length\fP) -.TP 2 -o -\f2stop in MyClass.<init>\fP \f2(<init> identifies the MyClass constructor)\fP -.TP 2 -o -\f2stop in MyClass.<clinit>\fP \f2(<clinit> identifies the static initialization code for MyClass)\fP -.RE - -.LP -.LP -If a method is overloaded, you must also specify its argument types so that the proper method can be selected for a breakpoint. For example, "\f2MyClass.myMethod(int,java.lang.String)\fP", or "\f2MyClass.myMethod()\fP". -.LP -.LP -The \f2clear\fP command removes breakpoints using a syntax as in "\f2clear\ MyClass:45\fP". Using the \f2clear\fP or command with no argument displays a list of all breakpoints currently set. The \f2cont\fP command continues execution. -.LP -.SS -Stepping -.LP -.LP -The \f2step\fP commands advances execution to the next line whether it is in the current stack frame or a called method. The \f2next\fP command advances execution to the next line in the current stack frame. -.LP -.SS -Exceptions -.LP -.LP -When an exception occurs for which there isn't a catch statement anywhere in the throwing thread's call stack, the VM normally prints an exception trace and exits. When running under \f3jdb\fP, however, control returns to \f3jdb\fP at the offending throw. You can then use \f3jdb\fP to diagnose the cause of the exception. -.LP -.LP -Use the \f2catch\fP command to cause the debugged application to stop at other thrown exceptions, for example: "\f2catch java.io.FileNotFoundException\fP" or "\f2catch mypackage.BigTroubleException\fP. Any exception which is an instance of the specifield class (or of a subclass) will stop the application at the point where it is thrown. -.LP -.LP -The \f2ignore\fP command negates the effect of a previous \f2catch\fP command. -.LP -.LP -\f2NOTE: The \fP\f2ignore\fP command does not cause the debugged VM to ignore specific exceptions, only the debugger. -.LP -.SH "Command Line Options" -.LP -.LP -When you use \f3jdb\fP in place of the Java application launcher on the command line, \f3jdb\fP accepts many of the same options as the java command, including \f2\-D\fP, \f2\-classpath\fP, and \f2\-X<option>\fP. -.LP -.LP -The following additional options are accepted by \f3jdb\fP: -.LP -.RS 3 -.TP 3 -\-help -Displays a help message. -.TP 3 -\-sourcepath <dir1:dir2:...> -Uses the given path in searching for source files in the specified path. If this option is not specified, the default path of "." is used. -.TP 3 -\-attach <address> -Attaches the debugger to previously running VM using the default connection mechanism. -.TP 3 -\-listen <address> -Waits for a running VM to connect at the specified address using standard connector. -.TP 3 -\-listenany -Waits for a running VM to connect at any available address using standard connector. -.TP 3 -\-launch -Launches the debugged application immediately upon startup of jdb. This option removes the need for using the \f2run\fP command. The debuged application is launched and then stopped just before the initial application class is loaded. At that point you can set any necessary breakpoints and use the \f2cont\fP to continue execution. -.TP 3 -\-listconnectors -List the connectors available in this VM -.TP 3 -\-connect <connector\-name>:<name1>=<value1>,... -Connects to target VM using named connector with listed argument values. -.TP 3 -\-dbgtrace [flags] -Prints info for debugging jdb. -.TP 3 -\-tclient -Runs the application in the Java HotSpot(tm) VM (Client). -.TP 3 -\-tserver -Runs the application in the Java HotSpot(tm) VM (Server). -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine used to run jdb. (Options for the application Java virtual machine are passed to the \f3run\fP command.) For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.LP -Other options are supported for alternate mechanisms for connecting the debugger and the VM it is to debug. The Java Platform Debugger Architecture has additional -.na -\f2documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html on these connection alternatives. -.LP -.SS -Options Forwarded to Debuggee Process -.LP -.RS 3 -.TP 3 -\-v \-verbose[:class|gc|jni] -Turns on verbose mode. -.TP 3 -\-D<name>=<value> -Sets a system property. -.TP 3 -\-classpath <directories separated by ":"> -Lists directories in which to look for classes. -.TP 3 -\-X<option> -Non\-standard target VM option -.RE - -.LP -.SH "SEE ALSO" -.LP -.LP -javac(1), java(1), javah(1), javap(1), javadoc(1). -.LP - +Prints information for debugging the \f3jdb\fR command\&. +.TP +-tclient +.br +Runs the application in the Java HotSpot VM client\&. +.TP +-tserver +.br +Runs the application in the Java HotSpot VM server\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the JVM, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH OPTIONS\ FORWARDED\ TO\ THE\ DEBUGGER\ PROCESS +.TP +-v -verbose[:\fIclass\fR|gc|jni] +.br +Turns on verbose mode\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property\&. +.TP +-classpath \fIdir\fR +.br +Lists directories separated by colons in which to look for classes\&. +.TP +-X\fIoption\fR +.br +Nonstandard target JVM option\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +javah(1) +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jdeps.1 b/jdk/src/solaris/doc/sun/man/man1/jdeps.1 new file mode 100644 index 00000000000..9b8f698f6a2 --- /dev/null +++ b/jdk/src/solaris/doc/sun/man/man1/jdeps.1 @@ -0,0 +1,532 @@ +'\" t +.\" Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jdeps.1 +.\" +.if n .pl 99999 +.TH jdeps 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jdeps \- Java class dependency analyzer\&. +.SH SYNOPSIS +.sp +.nf + +\fBjdeps\fR [\fIoptions\fR] \fIclasses\fR \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIclass\fR\fIes\fR +Name of the classes to analyze\&. You can specify a class that can be found in the class path, by its file name, a directory, or a JAR file\&. +.SH DESCRIPTION +The \fI\fR\f3jdeps\fR command shows the package-level or class-level dependencies of Java class files\&. The input class can be a path name to a \f3\&.class\fR file, a directory, a JAR file, or it can be a fully qualified class name to analyze all class files\&. The options determine the output\&. By default, \f3jdeps\fR outputs the dependencies to the system output\&. It can generate the dependencies in DOT language (see the \f3-dotoutput\fR option)\&. +.SH OPTIONS +.TP +-dotoutput <\fIdir\fR> +.br +Destination directory for DOT file output\&. If specified, \f3jdeps\fR will generate one dot file per each analyzed archive named <\fIarchive-file-name\fR>\&.dot listing the dependencies, and also a summary file named summary\&.dot listing the dependencies among the archives\&. +.TP +-s, -summary +.br +Prints dependency summary only\&. +.TP +-v, -verbose +.br +Prints all class-level dependencies\&. +.TP +-verbose:package +.br +Prints package-level dependencies excluding dependencies within the same archive\&. +.TP +-verbose:class +.br +Prints class-level dependencies excluding dependencies within the same archive\&. +.TP +-cp <\fIpath\fR>, -classpath <\fIpath\fR> +.br +Specifies where to find class files\&. + +See also Setting the Class Path\&. +.TP +-p <\fIpkg name\fR>, -package <\fIpkg name\fR> +.br +Finds dependencies in the specified package\&. You can specify this option multiple times for different packages\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-e <\fIregex\fR>, -regex <\fIregex\fR> +.br +Finds dependencies in packages matching the specified regular expression pattern\&. The \f3-p\fR and \f3-e\fR options are mutually exclusive\&. +.TP +-include <\fIregex\fR> +.br +Restricts analysis to classes matching pattern\&. This option filters the list of classes to be analyzed\&. It can be used together with \f3-p\fR and \f3-e\fR which apply pattern to the dependencies\&. +.TP +-P, -profile +.br +Shows profile or the file containing a package\&. +.TP +-apionly +.br +Restricts analysis to APIs, for example, dependences from the signature of \f3public\fR and \f3protected\fR members of public classes including field type, method parameter types, returned type, and checked exception types\&. +.TP +-R, -recursive +.br +Recursively traverses all dependencies\&. +.TP +-version +.br +Prints version information\&. +.TP +-h, -?, -help +.br +Prints help message for \f3jdeps\fR\&. +.SH EXAMPLES +Analyzing the dependencies of Notepad\&.jar\&. +.sp +.nf +\f3$ jdeps demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt \fP +.fi +.nf +\f3 \-> java\&.awt\&.event \fP +.fi +.nf +\f3 \-> java\&.beans \fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.logging \fP +.fi +.nf +\f3 \-> javax\&.swing \fP +.fi +.nf +\f3 \-> javax\&.swing\&.border \fP +.fi +.nf +\f3 \-> javax\&.swing\&.event \fP +.fi +.nf +\f3 \-> javax\&.swing\&.text \fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree \fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo \fP +.fi +.nf +\f3\fP +.fi +.sp +Use -P or -profile option to show on which profile that Notepad depends\&. +.sp +.nf +\f3$ jdeps \-profile demo/jfc/Notepad/Notepad\&.jar \fP +.fi +.nf +\f3demo/jfc/Notepad/Notepad\&.jar \-> /usr/java/jre/lib/rt\&.jar (Full JRE)\fP +.fi +.nf +\f3 <unnamed> (Notepad\&.jar)\fP +.fi +.nf +\f3 \-> java\&.awt Full JRE\fP +.fi +.nf +\f3 \-> java\&.awt\&.event Full JRE\fP +.fi +.nf +\f3 \-> java\&.beans Full JRE\fP +.fi +.nf +\f3 \-> java\&.io compact1\fP +.fi +.nf +\f3 \-> java\&.lang compact1\fP +.fi +.nf +\f3 \-> java\&.net compact1\fP +.fi +.nf +\f3 \-> java\&.util compact1\fP +.fi +.nf +\f3 \-> java\&.util\&.logging compact1\fP +.fi +.nf +\f3 \-> javax\&.swing Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.border Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.event Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.text Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.tree Full JRE\fP +.fi +.nf +\f3 \-> javax\&.swing\&.undo Full JRE\fP +.fi +.nf +\f3\fP +.fi +.sp +Analyzing the immediate dependencies of a specific class in a given classpath, for example the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class in the tools\&.jar file\&. +.sp +.nf +\f3$ jdeps \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-verbose:class\fR option to find class-level dependencies or use the \f3-v\fR or \f3-verbose\fR option to include dependencies from the same JAR file\&. +.sp +.nf +\f3$ jdeps \-verbose:class \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps\&.Main (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io\&.PrintWriter \fP +.fi +.nf +\f3 \-> java\&.lang\&.Exception \fP +.fi +.nf +\f3 \-> java\&.lang\&.Object \fP +.fi +.nf +\f3 \-> java\&.lang\&.String \fP +.fi +.nf +\f3 \-> java\&.lang\&.System \fP +.fi +.nf +\f3\fP +.fi +.sp +Use the \f3-R\fR or \f3-recursive\fR option to analyze the transitive dependencies of the \f3com\&.sun\&.tools\&.jdeps\&.Main\fR class\&. +.sp +.nf +\f3$ jdeps \-R \-cp lib/tools\&.jar com\&.sun\&.tools\&.jdeps\&.Main\fP +.fi +.nf +\f3lib/tools\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 com\&.sun\&.tools\&.classfile (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.nio\&.charset \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 com\&.sun\&.tools\&.jdeps (tools\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.nio\&.file \fP +.fi +.nf +\f3 \-> java\&.nio\&.file\&.attribute \fP +.fi +.nf +\f3 \-> java\&.text \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3/usr/java/jre/lib/jce\&.jar \-> /usr/java/jre/lib/rt\&.jar\fP +.fi +.nf +\f3 javax\&.crypto (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.io \fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.lang\&.reflect \fP +.fi +.nf +\f3 \-> java\&.net \fP +.fi +.nf +\f3 \-> java\&.nio \fP +.fi +.nf +\f3 \-> java\&.security \fP +.fi +.nf +\f3 \-> java\&.security\&.cert \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3 \-> java\&.util\&.concurrent \fP +.fi +.nf +\f3 \-> java\&.util\&.jar \fP +.fi +.nf +\f3 \-> java\&.util\&.regex \fP +.fi +.nf +\f3 \-> java\&.util\&.zip \fP +.fi +.nf +\f3 \-> javax\&.security\&.auth \fP +.fi +.nf +\f3 \-> sun\&.security\&.jca JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 \-> sun\&.security\&.util JDK internal API (rt\&.jar)\fP +.fi +.nf +\f3 javax\&.crypto\&.spec (jce\&.jar)\fP +.fi +.nf +\f3 \-> java\&.lang \fP +.fi +.nf +\f3 \-> java\&.security\&.spec \fP +.fi +.nf +\f3 \-> java\&.util \fP +.fi +.nf +\f3/usr/java/jre/lib/rt\&.jar \-> /usr/java/jre/lib/jce\&.jar\fP +.fi +.nf +\f3 java\&.security (rt\&.jar)\fP +.fi +.nf +\f3 \-> javax\&.crypto\fP +.fi +.nf +\f3\fP +.fi +.sp +Generate dot files of the dependencies of Notepad demo\&. +.sp +.nf +\f3$ jdeps \-dotoutput dot demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +\f3jdeps\fR will create one dot file for each given JAR file named <\fIfilename\fR>\&.dot in the dot directory specified in the \f3-dotoutput\fR option, and also a summary file named summary\&.dot that will list the dependencies among the JAR files +.sp +.nf +\f3$ cat dot/Notepad\&.jar\&.dot \fP +.fi +.nf +\f3digraph "Notepad\&.jar" {\fP +.fi +.nf +\f3 // Path: demo/jfc/Notepad/Notepad\&.jar\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.awt\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.beans";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.io";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.lang";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.net";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util";\fP +.fi +.nf +\f3 "<unnamed>" \-> "java\&.util\&.logging";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.border";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.event";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.text";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.tree";\fP +.fi +.nf +\f3 "<unnamed>" \-> "javax\&.swing\&.undo";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3$ cat dot/summary\&.dot\fP +.fi +.nf +\f3digraph "summary" {\fP +.fi +.nf +\f3 "Notepad\&.jar" \-> "rt\&.jar";\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +javap(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jhat.1 b/jdk/src/solaris/doc/sun/man/man1/jhat.1 index 62c72f68521..c53dc0fce38 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jhat.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jhat.1 @@ -1,141 +1,137 @@ -." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jhat 1 "10 May 2011" +'\" t +.\" Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jhat.1 +.\" +.if n .pl 99999 +.TH jhat 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jhat \- Java Heap Analysis Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jhat\fP [ \f2options\fP ] <heap\-dump\-file> -.fl +.SH NAME +jhat \- Analyzes the Java heap\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -heap\-dump\-file -Java binary heap dump file to be browsed. For a dump file that contains multiple heap dumps, you may specify which dump in the file by appending "#<number> to the file name, i.e. "foo.hprof#3". -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jhat\fP command parses a java heap dump file and launches a webserver. jhat enables you to browse heap dumps using your favorite webbrowser. jhat supports pre\-designed queries (such as 'show all instances of a known class "Foo"') as well as \f3OQL\fP (\f3O\fPbject \f3Q\fPuery \f3L\fPanguage) \- a SQL\-like query language to query heap dumps. Help on OQL is available from the OQL help page shown by jhat. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ -.LP -.LP -There are several ways to generate a java heap dump: -.LP -.RS 3 -.TP 2 -o -Use jmap(1) \-dump option to obtain a heap dump at runtime; -.TP 2 -o -Use jconsole(1) option to obtain a heap dump via -.na -\f2HotSpotDiagnosticMXBean\fP @ -.fi -http://download.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean.html at runtime; -.TP 2 -o -Heap dump will be generated when OutOfMemoryError is thrown by specifying \-XX:+HeapDumpOnOutOfMemoryError VM option; -.TP 2 -o -Use -.na -\f2hprof\fP @ -.fi -http://java.sun.com/developer/technicalArticles/Programming/HPROF.html. -.RE - -.LP -.LP -\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-stack false/true -Turn off tracking object allocation call stack. Note that if allocation site information is not available in the heap dump, you have to set this flag to false. Default is true. -.TP 3 -\-refs false/true -Turn off tracking of references to objects. Default is true. By default, back pointers (objects pointing to a given object a.k.a referrers or in\-coming references) are calculated for all objects in the heap. -.TP 3 -\-port port\-number -Set the port for the jhat's HTTP server. Default is 7000. -.TP 3 -\-exclude exclude\-file -Specify a file that lists data members that should be excluded from the "reachable objects" query. For example, if the file lists \f2java.lang.String.value\fP, then, whenever list of objects reachable from a specific object "o" are calculated, reference paths involving \f2java.lang.String.value\fP field will not considered. -.TP 3 -\-baseline baseline\-dump\-file -Specify a baseline heap dump. Objects in both heap dumps with the same object ID will be marked as not being "new". Other objects will be marked as "new". This is useful while comparing two different heap dumps. -.TP 3 -\-debug int -Set debug level for this tool. 0 means no debug output. Set higher values for more verbose modes. -.TP 3 -\-version -Report version number and exit. -.TP 3 -\-h -Output help message and exit. -.TP 3 -\-help -Output help message and exit. -.TP 3 -\-J<flag> -Pass <flag> to the Java virtual machine on which jhat is run. For example, \-J\-Xmx512m to use a maximum heap size of 512MB. -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jmap(1) -.TP 2 -o -jconsole(1) -.TP 2 -o -.na -\f2hprof \- Heap and CPU profiling tool\fP @ -.fi -http://java.sun.com/developer/technicalArticles/Programming/HPROF.html -.RE - -.LP - +\fBjhat\fR [ \fIoptions\fR ] \fIheap\-dump\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIheap-dump-file\fR +Java binary heap dump file to be browsed\&. For a dump file that contains multiple heap dumps, you can specify which dump in the file by appending \f3#<number>\fR to the file name, for example, \f3myfile\&.hprof#3\fR\&. +.SH DESCRIPTION +The \f3jhat\fR command parses a Java heap dump file and starts a web server\&. The \f3jhat\fR command lets you to browse heap dumps with your favorite web browser\&. The \f3jhat\fR command supports predesigned queries such as show all instances of a known class \f3MyClass\fR, and Object Query Language (OQL)\&. OQL is similar to SQL, except for querying heap dumps\&. Help on OQL is available from the OQL help page shown by the \f3jhat\fR command\&. With the default port, OQL help is available at http://localhost:7000/oqlhelp/ +.PP +There are several ways to generate a Java heap dump: +.TP 0.2i +\(bu +Use the \f3jmap -dump\fR option to obtain a heap dump at runtime\&. See jmap(1)\&. +.TP 0.2i +\(bu +Use the \f3jconsole\fR option to obtain a heap dump through \f3HotSpotDiagnosticMXBean\fR at runtime\&. See jconsole(1) and the \f3HotSpotDiagnosticMXBean\fR interface description at http://docs\&.oracle\&.com/javase/8/docs/jre/api/management/extension/com/sun/management/HotSpotDiagnosticMXBean\&.html +.TP 0.2i +\(bu +Heap dump is generated when an \f3OutOfMemoryError\fR is thrown by specifying the \f3-XX:+HeapDumpOnOutOfMemoryError\fR Java Virtual Machine (JVM) option\&. +.TP 0.2i +\(bu +Use the \f3hprof\fR command\&. See the HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.SH OPTIONS +.TP +-stack false|true +.br +Turns off tracking object allocation call stack\&. If allocation site information is not available in the heap dump, then you have to set this flag to \f3false\fR\&. The default is \f3true\fR\&. +.TP +-refs false|true +.br +Turns off tracking of references to objects\&. Default is \f3true\fR\&. By default, back pointers, which are objects that point to a specified object such as referrers or incoming references, are calculated for all objects in the heap\&. +.TP +-port \fIport-number\fR +.br +Sets the port for the \f3jhat\fR HTTP server\&. Default is 7000\&. +.TP +-exclude \fIexclude-file\fR +.br +Specifies a file that lists data members that should be excluded from the reachable objects query\&. For example, if the file lists \f3java\&.lang\&.String\&.value\fR, then, then whenever the list of objects that are reachable from a specific object \f3o\fR are calculated, reference paths that involve \f3java\&.lang\&.String\&.value\fR field are not considered\&. +.TP +-baseline \fIexclude-file\fR +.br +Specifies a baseline heap dump\&. Objects in both heap dumps with the same object ID are marked as not being new\&. Other objects are marked as new\&. This is useful for comparing two different heap dumps\&. +.TP +-debug \fIint\fR +.br +Sets the debug level for this tool\&. A level of 0 means no debug output\&. Set higher values for more verbose modes\&. +.TP +-version +.br +Reports the release number and exits +.TP +-h +.br +Dsiplays a help message and exits\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR to the Java Virtual Machine on which the \f3jhat\fR command is running\&. For example, \f3-J-Xmx512m\fR to use a maximum heap size of 512 MB\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jconsole(1) +.TP 0.2i +\(bu +HPROF: A Heap/CPU Profiling Tool at http://docs\&.oracle\&.com/javase/8/docs/technotes/samples/hprof\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jinfo.1 b/jdk/src/solaris/doc/sun/man/man1/jinfo.1 index ea072ffce64..42a5ebd3b18 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jinfo.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jinfo.1 @@ -1,147 +1,133 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jinfo 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jinfo.1 +.\" +.if n .pl 99999 +.TH jinfo 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jinfo \- Configuration Info -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jinfo\fP [ option ] pid -.fl -\f3jinfo\fP [ option ] executable core -.fl -\f3jinfo\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi +.SH NAME +jinfo \- Generates configuration information\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -option -Options are mutually exclusive. Option, if used, should follow immediately after the command name. -.RE +\fBjinfo\fR [ \fIoption\fR ] \fIpid\fR +.fi +.nf -.LP -.RS 3 -.TP 3 -pid -process id for which the configuration info is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.RE +\fBjinfo\fR [ \fIoption \fR] \fIexecutable core\fR +.fi +.nf -.LP -.RS 3 -.TP 3 -executable -Java executable from which the core dump was produced. -.RE - -.LP -.RS 3 -.TP 3 -core -core file for which the configuration info is to be printed. -.RE - -.LP -.RS 3 -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. -.RE - -.LP -.RS 3 -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jinfo\fP prints Java configuration information for a given Java process or core file or a remote debug server. Configuration information includes Java System properties and Java virtual machine command line flags. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: +\fBjinfo\fR [ \fIoption \fR] \fI[ servier\-id ] remote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoption\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the configuration information is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the configuration information is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jinfo\fR command prints Java configuration information for a specified Java process or core file or a remote debug server\&. The configuration information includes Java system properties and Java Virtual Machine (JVM) command-line flags\&. If the specified process is running on a 64-bit JVM, then you might need to specify the \f3-J-d64\fR option, for example: \f3jinfo\fR\f3-J-d64 -sysprops pid\fR\&. +.PP +This utility is unsupported and might not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of the jvm\&.dll that is used by the target process or the location from which the crash dump file was produced\&. For example, \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR \&. +.SH OPTIONS +.TP +no-option +Prints both command-line flags and system property name-value pairs\&. +.TP +-flag \fIname\fR .br -jinfo \-J\-d64 \-sysprops pid -.LP -.LP -\f3NOTE \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' need to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP -.LP -.LP -\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -<no option> -prints both command line flags as well as System properties name, value pairs. +Prints the name and value of the specified command-line flag\&. +.TP +-flag \fI[+|-]name\fR .br -.TP 3 -\-flag name -prints the name and value of the given command line flag. +enables or disables the specified Boolean command-line flag\&. +.TP +-flag \fIname=value\fR .br -.TP 3 -\-flag [+|\-]name -enables or disables the given boolean command line flag. +Sets the specified command-line flag to the specified value\&. +.TP +-flags .br -.TP 3 -\-flag name=value -sets the given command line flag to the specified value. +Prints command-line flags passed to the JVM\&. +.TP +-sysprops .br -.TP 3 -\-flags -prints command line flags passed to the JVM. pairs. +Prints Java system properties as name-value pairs\&. +.TP +-h .br -.TP 3 -\-sysprops -prints Java System properties as name, value pairs. +Prints a help message\&. +.TP +-help .br -.TP 3 -\-h -prints a help message -.TP 3 -\-help -prints a help message -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jps(1) -.TP 2 -o -jsadebugd(1) -.RE - -.LP - +Prints a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jjs.1 b/jdk/src/solaris/doc/sun/man/man1/jjs.1 new file mode 100644 index 00000000000..47b5602ac10 --- /dev/null +++ b/jdk/src/solaris/doc/sun/man/man1/jjs.1 @@ -0,0 +1,352 @@ +'\" t +.\" Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Basic Tools +.\" Title: jjs.1 +.\" +.if n .pl 99999 +.TH jjs 1 "21 November 2013" "JDK 8" "Basic Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- + +.SH NAME +jjs \- Invokes the Nashorn engine\&. +.SH SYNOPSIS +.sp +.nf +\f3\fBjjs\fR [\fIoptions\fR] [\fIscript\-files\fR] [\-\- \fIarguments\fR]\fP +.fi +.sp +.TP +\fIoptions\fR +One or more options of the \f3jjs\fR command, separated by spaces\&. For more information, see Options\&. +.TP +\fIscript-files\fR +One or more script files which you want to interpret using Nashorn, separated by spaces\&. If no files are specified, an interactive shell is started\&. +.TP +\fIarguments\fR +All values after the double hyphen marker (\f3--\fR) are passed through to the script or the interactive shell as arguments\&. These values can be accessed by using the \f3arguments\fR property (see )\&. +.SH DESCRIPTION +The \f3jjs\fR command-line tool is used to invoke the Nashorn engine\&. You can use it to interpret one or several script files, or to run an interactive shell\&. +.SH OPTIONS +The options of the \f3jjs\fR command control the conditions under which scripts are interpreted by Nashorn\&. +.TP +-ccs=\fIsize\fR , --class-cache-size=\fIsize\fR +.br +Sets the class cache size (in bytes)\&. Append the letter \f3k\fR or \f3K\fR to indicate kilobytes (KB), \f3m\fR or \f3M\fR to indicate megabytes (MB), \f3g\fR or \f3G\fR to indicate gigabytes (GB)\&. By default, the class cache size is set to 50 bytes\&. The following example shows how to set it to 1024 bytes (1 KB): +.sp +.nf +\f3\-css=100\fP +.fi +.nf +\f3\-css=1k\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +-co, --compile-only +.br +Compiles the script without running it\&. +.TP +-cp \fIpath\fR , --classpath \fIpath\fR +.br +Specifies the path to the supporting class files To set multiple paths, the option can be repeated, or you can separate each path with a colon (:)\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a system property to be passed to the script by assigning a value to a property name\&. The following example shows how to invoke Nashorn in interactive mode and assign \f3myValue\fR to the property named \f3myKey\fR: +.sp +.nf +\f3>> \fIjjs \-DmyKey=myValue\fR\fP +.fi +.nf +\f3jjs> \fIjava\&.lang\&.System\&.getProperty("myKey")\fR\fP +.fi +.nf +\f3myValue\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This option can be repeated to set multiple properties\&. +.TP +-d=\fIpath\fR , --dump-debug-dir=\fIpath\fR +.br +Specifies the path to the directory where class files are dumped\&. +.TP +--debug-lines +.br +Generates a line number table in the class file\&. By default, this option is enabled\&. To disable it, specify \f3--debug-lines=false\fR\&. +.TP +--debug-locals +.br +Generates a local variable table in the class file\&. +.TP +-doe, --dump-on-error +.br +Provides a full stack trace when an arror occurs\&. By default, only a brief error message is printed\&. +.TP +--early-lvalue-error +.br +Reports invalid lvalue expressions as early errors (that is, when the code is parsed)\&. By default, this option is enabled\&. To disable it, specify \f3--early-lvalue-error=false\fR\&. When disabled, invalid lvalue expressions will not be reported until the code is executed\&. +.TP +--empty-statements +.br +Preserves empty statements in the Java abstract syntax tree\&. +.TP +-fv, --fullversion +.br +Prints the full Nashorn version string\&. +.TP +--function-statement-error +.br +Prints an error message when a function declaration is used as a statement\&. +.TP +--function-statement-warning +.br +Prints a warning message when a function declaration is used as a statement\&. +.TP +-fx +.br +Launches the script as a JavaFX application\&. +.TP +-h, -help +.br +Prints the list of options and their descriptions\&. +.TP +-J\fIoption\fR +.br +Passes the specified \f3java\fR launcher option to the JVM\&. The following example shows how to invoke Nashorn in interactive mode and set the maximum memory used by the JVM to 4 GB: +.sp +.nf +\f3>> \fIjjs \-J\-Xmx4g\fR\fP +.fi +.nf +\f3jjs> \fIjava\&.lang\&.Runtime\&.getRuntime()\&.maxMemory()\fR\fP +.fi +.nf +\f33817799680\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp + + +This option can be repeated to pass multiple \f3java\fR command options\&. +.TP +--lazy-compilation +.br +Enables lazy code generation strategies (that is, the entire script is not compiled at once)\&. This option is experimental\&. +.TP +--loader-per-compile +.br +Creates a new class loader per compile\&. By default, this option is enabled\&. To disable it, specify \f3--loader-per-compile=false\fR\&. +.TP +--log=\fIsubsystem\fR:\fIlevel\fR +.br +Performs logging at a given level for the specified subsystems\&. You can specify logging levels for multiple subsystems separating them with commas\&. For example: +.sp +.nf +\f3\-\-log=fields:finest,codegen:info\fP +.fi +.nf +\f3\fR +.fi +.sp + +.TP +--package=\fIname\fR +.br +Specifies the package to which generated class files are added\&. +.TP +--parse-only +.br +Parses the code without compiling\&. +.TP +--print-ast +.br +Prints the abstract syntax tree\&. +.TP +--print-code +.br +Prints bytecode\&. +.TP +--print-lower-ast +.br +Prints the lowered abstract syntax tree\&. +.TP +--print-lower-parse +.br +Prints the lowered parse tree\&. +.TP +--print-no-newline +.br +Forces other \f3--print*\fR options to print the output on one line\&. +.TP +--print-parse +.br +Prints the parse tree\&. +.TP +--print-symbols +.br +Prints the symbol table\&. +.TP +-pcs, --profile-callsites +.br +Dumps callsite profile data\&. +.TP +-scripting +.br +Enables shell scripting features\&. +.TP +--stderr=\fIfilename\fR|\fIstream\fR|\fItty\fR +.br +Redirects the standard error stream to the specified file, stream (for example, to \f3stdout\fR), or text terminal\&. +.TP +--stdout=\fIfilename\fR|\fIstream\fR|\fItty\fR +.br +Redirects the standard output stream to the specified file, stream (for example, to \f3stderr\fR), or text terminal\&. +.TP +-strict +.br +Enables strict mode, which enforces stronger adherence to the standard (ECMAScript Edition 5\&.1), making it easier to detect common coding errors\&. +.TP +-t=\fIzone\fR , -timezone=\fIzone\fR +.br +Sets the specified time zone for script execution\&. It overrides the time zone set in the OS and used by the \f3Date\fR object\&. +.TP +-tcs=\fIparameter\fR , --trace-callsites=\fIparameter\fR +.br +Enables callsite trace mode\&. Possible parameters are the following: +.RS +.TP +miss +Trace callsite misses\&. +.TP +enterexit +Trace callsite enter/exit\&. +.TP +objects +Print object properties\&. +.RE + +.TP +--verify-code +.br +Verifies bytecode before running\&. +.TP +-v, -version +.br +Prints the Nashorn version string\&. +.TP +-xhelp +.br +Prints extended help for command-line options\&. +.SH EXAMPLES +\f3Example 1 Running a Script with Nashorn\fR +.sp +.nf +\f3jjs script\&.js\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 2 Running Nashorn in Interactive Mode\fR +.sp +.nf +\f3>> \fIjjs\fR\fP +.fi +.nf +\f3jjs> \fIprintln("Hello, World!")\fR\fP +.fi +.nf +\f3Hello, World!\fP +.fi +.nf +\f3jjs> \fIquit()\fR\fP +.fi +.nf +\f3>>\fP +.fi +.nf +\f3\fR +.fi +.sp +\f3Example 3 Passing Arguments to Nashorn\fR +.sp +.nf +\f3>> \fIjjs \-\- a b c\fR\fP +.fi +.nf +\f3jjs> \fIarguments\&.join(", ")\fR\fP +.fi +.nf +\f3a, b, c\fP +.fi +.nf +\f3jjs>\fP +.fi +.nf +\f3\fR +.fi +.sp +.SH SEE\ ALSO +\f3jrunscript\fR +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jmap.1 b/jdk/src/solaris/doc/sun/man/man1/jmap.1 index f906dedc681..cada22c54fd 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jmap.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jmap.1 @@ -1,160 +1,144 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jmap 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jmap.1 +.\" +.if n .pl 99999 +.TH jmap 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jmap \- Memory Map -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jmap\fP [ option ] pid -.fl -\f3jmap\fP [ option ] executable core -.fl -\f3jmap\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi +.SH NAME +jmap \- Prints shared object memory maps or heap memory details for a process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -option -Options are mutually exclusive. Option, if used, should follow immediately after the command name. -.TP 3 -pid -process id for which the memory map is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.br -.TP 3 -executable -Java executable from which the core dump was produced. -.br -.TP 3 -core -core file for which the memory map is to be printed. -.br -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. -.br -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.br -.RE +\fBjmap\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jmap\fP prints shared object memory maps or heap memory details of a given process or core file or a remote debug server. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: -.LP -.nf -\f3 -.fl -jmap \-J\-d64 \-heap pid -.fl -\fP -.fi +\fBjmap\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf -.LP -.LP -\f3NOTE: This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \fP\f4PATH\fP\f3 environment variable should contain the location of \fP\f4jvm.dll\fP\f3 used by the target process or the location from which the Crash Dump file was produced.\fP -.LP -.LP -\f3For example, \fP\f4set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP +\fBjmap\fR [ \fIoptions\fR ] [ \fIpid\fR ] \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the memory map is to be printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the memory map is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jmap\fR command prints shared object memory maps or heap memory details of a specified process, core file, or remote debug server\&. If the specified process is running on a 64-bit Java Virtual Machine (JVM), then you might need to specify the \f3-J-d64\fR option, for example: \f3jmap\fR\f3-J-d64 -heap pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future releases of the JDK\&. On Windows Systems where the \f3dbgeng\&.dll\fR file is not present, Debugging Tools For Windows must be installed to make these tools work\&. The \f3PATH\fR environment variable should contain the location of the \f3jvm\&.dll\fR file that is used by the target process or the location from which the crash dump file was produced, for example: \f3set PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH OPTIONS +.TP +<no option> +When no option is used, the \f3jmap\fR command prints shared object mappings\&. For each shared object loaded in the target JVM, the start address, size of the mapping, and the full path of the shared object file are printed\&. This behavior is similar to the Oracle Solaris \f3pmap\fR utility\&. +.TP +-dump:[live,] format=b, file=\fIfilename\fR .br - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -<no option> -When no option is used jmap prints shared object mappings. For each shared object loaded in the target VM, start address, the size of the mapping, and the full path of the shared object file are printed. This is similar to the Solaris \f3pmap\fP utility. +Dumps the Java heap in \f3hprof\fR binary format to \f3filename\fR\&. The \f3live\fR suboption is optional, but when specified, only the active objects in the heap are dumped\&. To browse the heap dump, you can use the jhat(1) command to read the generated file\&. +.TP +-finalizerinfo .br -.TP 3 -\-dump:[live,]format=b,file=<filename> -Dumps the Java heap in hprof binary format to filename. The \f2live\fP suboption is optional. If specified, only the live objects in the heap are dumped. To browse the heap dump, you can use jhat(1) (Java Heap Analysis Tool) to read the generated file. +Prints information about objects that are awaiting finalization\&. +.TP +-heap .br -.TP 3 -\-finalizerinfo -Prints information on objects awaiting finalization. +Prints a heap summary of the garbage collection used, the head configuration, and generation-wise heap usage\&. In addition, the number and size of interned Strings are printed\&. +.TP +-histo[:live] .br -.TP 3 -\-heap -Prints a heap summary. GC algorithm used, heap configuration and generation wise heap usage are printed. +Prints a histogram of the heap\&. For each Java class, the number of objects, memory size in bytes, and the fully qualified class names are printed\&. The JVM internal class names are printed with an asterisk (*) prefix\&. If the \f3live\fR suboption is specified, then only active objects are counted\&. +.TP +-clstats .br -.TP 3 -\-histo[:live] -Prints a histogram of the heap. For each Java class, number of objects, memory size in bytes, and fully qualified class names are printed. VM internal class names are printed with '*' prefix. If the \f2live\fP suboption is specified, only live objects are counted. +Prints class loader wise statistics of Java heap\&. For each class loader, its name, how active it is, address, parent class loader, and the number and size of classes it has loaded are printed\&. +.TP +-F .br -.TP 3 -\-permstat -Prints class loader wise statistics of permanent generation of Java heap. For each class loader, its name, liveness, address, parent class loader, and the number and size of classes it has loaded are printed. In addition, the number and size of interned Strings are printed. +Force\&. Use this option with the \f3jmap -dump\fR or \f3jmap -histo\fR option when the pid does not respond\&. The \f3live\fR suboption is not supported in this mode\&. +.TP +-h .br -.TP 3 -\-F -Force. Use with jmap \-dump or jmap \-histo option if the pid does not respond. The \f2live\fP suboption is not supported in this mode. +Prints a help message\&. +.TP +-help .br -.TP 3 -\-h -Prints a help message. +Prints a help message\&. +.TP +-J\fIflag\fR .br -.br -.TP 3 -\-help -Prints a help message. -.br -.br -.TP 3 -\-J<flag> -Passes <flag> to the Java virtual machine on which jmap is run. -.br -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -pmap(1) -.TP 2 -o -jhat(1) -.TP 2 -o -jps(1) -.TP 2 -o -jsadebugd(1) -.RE - -.LP - +Passes \f3flag\fR to the Java Virtual Machine where the \f3jmap\fR command is running\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jhat(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jps.1 b/jdk/src/solaris/doc/sun/man/man1/jps.1 index 1ec15e124ea..f03c31d9755 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jps.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jps.1 @@ -1,250 +1,205 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jps 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jps.1 +.\" +.if n .pl 99999 +.TH jps 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jps \- Java Virtual Machine Process Status Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jps\fP [ \f2options\fP ] [ \f2hostid\fP ] +.SH NAME +jps \- Lists the instrumented Java Virtual Machines (JVMs) on the target system\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjps\fR [ \fIoptions\fR ] [ \fIhostid\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.TP +\fIhostid\fR +The identifier of the host for which the process report should be generated\&. The \f3hostid\fR can include optional components that indicate the communications protocol, port number, and other implementation specific data\&. See Host Identifier\&. +.SH DESCRIPTION +The \f3jps\fR command lists the instrumented Java HotSpot VMs on the target system\&. The command is limited to reporting information on JVMs for which it has the access permissions\&. +.PP +If the \f3jps\fR command is run without specifying a \f3hostid\fR, then it searches for instrumented JVMs on the local host\&. If started with a \f3hostid\fR, then it searches for JVMs on the indicated host, using the specified protocol and port\&. A \f3jstatd\fR process is assumed to be running on the target host\&. +.PP +The \f3jps\fR command reports the local JVM identifier, or \f3lvmid\fR, for each instrumented JVM found on the target system\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the JVM process\&. With no options, \f3jps\fR lists each Java application\&'s \f3lvmid\fR followed by the short form of the application\&'s class name or jar file name\&. The short form of the class name or JAR file name omits the class\&'s package information or the JAR files path information\&. +.PP +The \f3jps\fR command uses the Java launcher to find the class name and arguments passed to the main method\&. If the target JVM is started with a custom launcher, then the class or JAR file name and the arguments to the \f3main\fR method are not available\&. In this case, the \f3jps\fR command outputs the string \f3Unknown\fR for the class name or JAR file name and for the arguments to the \f3main\fR method\&. +.PP +The list of JVMs produced by the \f3jps\fR command can be limited by the permissions granted to the principal running the command\&. The command only lists the JVMs for which the principle has access rights as determined by operating system-specific access control mechanisms\&. +.SH OPTIONS +The \f3jps\fR command supports a number of options that modify the output of the command\&. These options are subject to change or removal in the future\&. +.TP +-q .br - -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -hostid -The host identifier of the host for which the process report should be generated. The \f2hostid\fP may include optional components that indicate the communications protocol, port number, and other implementation specific data. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jps\fP tool lists the instrumented HotSpot Java Virtual Machines (JVMs) on the target system. The tool is limited to reporting information on JVMs for which it has the access permissions. -.LP -.LP -If \f3jps\fP is run without specifying a \f2hostid\fP, it will look for instrumented JVMs on the local host. If started with a \f2hostid\fP, it will look for JVMs on the indicated host, using the specified protocol and port. A \f3jstatd\fP process is assumed to be running on the target host. -.LP -.LP -The \f3jps\fP command will report the local VM identifier, or \f2lvmid\fP, for each instrumented JVM found on the target system. The \f3lvmid\fP is typically, but not necessarily, the operating system's process identifier for the JVM process. With no options, \f3jps\fP will list each Java application's \f2lvmid\fP followed by the short form of the application's class name or jar file name. The short form of the class name or JAR file name omits the class's package information or the JAR files path information. -.LP -.LP -The \f3jps\fP command uses the \f3java\fP launcher to find the class name and arguments passed to the \f2main\fP method. If the target JVM is started with a custom launcher, the class name (or JAR file name) and the arguments to the \f2main\fP method will not be available. In this case, the \f3jps\fP command will output the string \f2Unknown\fP for the class name or JAR file name and for the arguments to the main method. -.LP -.LP -The list of JVMs produced by the \f3jps\fP command may be limited by the permissions granted to the principal running the command. The command will only list the JVMs for which the principle has access rights as determined by operating system specific access control mechanisms. -.LP -.LP -\f3NOTE:\fP This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME platforms. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jps\fP command supports a number of options that modify the output of the command. These options are subject to change or removal in the future. -.LP -.RS 3 -.TP 3 -\-q -Suppress the output of the class name, JAR file name, and arguments passed to the \f2main\fP method, producing only a list of local VM identifiers. -.TP 3 -\-m -Output the arguments passed to the main method. The output may be null for embedded JVMs. -.TP 3 -\-l -Output the full package name for the application's main class or the full path name to the application's JAR file. -.TP 3 -\-v -Output the arguments passed to the JVM. -.TP 3 -\-V -Output the arguments passed to the JVM through the flags file (the .hotspotrc file or the file specified by the \-XX:Flags=<\f2filename\fP> argument). -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3jps\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.RE - -.LP -.SS -HOST IDENTIFIER -.LP -.LP -The host identifier, or \f2hostid\fP is a string that indicates the target system. The syntax of the \f2hostid\fP string largely corresponds to the syntax of a URI: -.LP -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][[//]\fP\f4hostname\fP\f3][:\fP\f4port\fP\f3][/\fP\f4servername\fP\f3]\fP +Suppresses the output of the class name, JAR file name, and arguments passed to the \f3main\fR method, producing only a list of local JVM identifiers\&. +.TP +-m .br -\f3 -.fl -\fP -.fi - -.LP -.RS 3 -.TP 3 -protocol -The communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific, optimized, local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP. -.TP 3 -hostname -A hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host. -.TP 3 -port -The default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used. -.TP 3 -servername -The treatment of this parameter depends on the implementation. For the optimized, local protocol, this field is ignored. For the \f3rmi\fP protocol, this parameter is a string representing the name of the RMI remote object on the remote host. See the \f3\-n\fP option for the jstatd(1) command. -.RE - -.LP -.SH "OUTPUT FORMAT" -.LP -.LP -The output of the \f3jps\fP command follows the following pattern: -.LP -.nf -\f3 -.fl -\fP\f4lvmid\fP\f3 [ [ \fP\f4classname\fP\f3 | \fP\f4JARfilename\fP\f3 | "Unknown"] [ \fP\f4arg\fP\f3* ] [ \fP\f4jvmarg\fP\f3* ] ]\fP +Displays the arguments passed to the \f3main\fR method\&. The output may be \f3null\fR for embedded JVMs\&. +.TP +-l .br -\f3 -.fl -\fP -.fi - -.LP -.LP -Where all output tokens are separated by white space. An \f2arg\fP that includes embedded white space will introduce ambiguity when attempting to map arguments to their actual positional parameters. +Displays the full package name for the application\&'s \f3main\fR class or the full path name to the application\&'s JAR file\&. +.TP +-v .br +Displays the arguments passed to the JVM\&. +.TP +-V .br -\f3NOTE\fP: You are advised not to write scripts to parse \f3jps\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jps\fP output, expect to modify them for future releases of this tool. +Suppresses the output of the class name, JAR file name, and arguments passed to the main method, producing only a list of local JVM identifiers\&. +.TP +-J\f3option\fR .br - -.LP -.SH "EXAMPLES" -.LP -.LP -This section provides examples of the \f3jps\fP command. -.LP -.LP -Listing the instrumented JVMs on the local host: -.LP -.nf -\f3 -.fl -\fP\f3jps\fP -.br - -.fl -18027 Java2Demo.JAR -.br - -.fl -18032 jps -.br - -.fl -18005 jstat -.br - -.fl -.fi - -.LP -.LP -Listing the instrumented JVMs on a remote host: -.LP -.LP -This example assumes that the \f3jstat\fP server and either the its internal RMI registry or a separate external \f3rmiregistry\fP process are running on the remote host on the default port (port 1099). It also assumes that the local host has appropriate permissions to access the remote host. This example also includes the \f2\-l\fP option to output the long form of the class names or JAR file names. -.LP -.nf -\f3 -.fl -\fP\f3jps \-l remote.domain\fP -.br - -.fl -3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR -.br - -.fl -2857 sun.tools.jstatd.jstatd -.br - -.fl -.fi - -.LP -.LP -Listing the instrumented JVMs on a remote host with a non\-default port for the RMI registry -.LP -.LP -This example assumes that the \f3jstatd\fP server, with an internal RMI registry bound to port 2002, is running on the remote host. This example also uses the \f2\-m\fP option to include the arguments passed to the \f2main\fP method of each of the listed Java applications. -.LP -.nf -\f3 -.fl -\fP\f3jps \-m remote.domain:2002\fP -.br - -.fl -3002 /opt/jdk1.7.0/demo/jfc/Java2D/Java2Demo.JAR -.br - -.fl -3102 sun.tools.jstatd.jstatd \-p 2002 -.fl -.fi - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jstat(1) \- the Java virtual machine Statistics Monitoring Tool -.TP 2 -o -jstatd(1) \- the jstat daemon -.TP 2 -o -rmiregistry(1) \- the Java Remote Object Registry -.RE - -.LP - +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH HOST\ IDENTIFIER +The host identifier, or \f3hostid\fR is a string that indicates the target system\&. The syntax of the \f3hostid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][[//]hostname][:port][/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \f3protocol\fR is omitted and a \f3hostname\fR is not specified, then the default protocol is a platform-specific, optimized, local protocol\&. If the protocol is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +hostname +A hostname or IP address that indicates the target host\&. If you omit the \f3hostname\fR parameter, then the target host is the local host\&. +.TP +port +The default port for communicating with the remote server\&. If the \f3hostname\fR parameter is omitted or the \f3protocol\fR parameter specifies an optimized, local protocol, then the \f3port\fR parameter is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation specific\&. For the default \f3rmi\fR protocol, the \f3port\fR parameter indicates the port number for the rmiregistry on the remote host\&. If the \f3port\fR parameter is omitted, and the \f3protocol\fR parameter indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +servername +The treatment of this parameter depends on the implementation\&. For the optimized, local protocol, this field is ignored\&. For the \f3rmi\fR protocol, this parameter is a string that represents the name of the RMI remote object on the remote host\&. See the \f3jstatd\fR command \f3-n\fRoption for more information\&. +.SH OUTPUT\ FORMAT +The output of the \f3jps\fR command follows the following pattern: +.sp +.nf +\f3lvmid [ [ classname | JARfilename | "Unknown"] [ arg* ] [ jvmarg* ] ]\fP +.fi +.nf +\f3\fP +.fi +.sp +All output tokens are separated by white space\&. An \f3arg\fR value that includes embedded white space introduces ambiguity when attempting to map arguments to their actual positional parameters\&. +.PP +\fINote:\fR It is recommended that you do not write scripts to parse \f3jps\fR output because the format might change in future releases\&. If you write scripts that parse \f3jps\fR output, then expect to modify them for future releases of this tool\&. +.SH EXAMPLES +This section provides examples of the \f3jps\fR command\&. +.PP +List the instrumented JVMs on the local host: +.sp +.nf +\f3jps\fP +.fi +.nf +\f318027 Java2Demo\&.JAR\fP +.fi +.nf +\f318032 jps\fP +.fi +.nf +\f318005 jstat\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host\&. This example assumes that the \f3jstat\fR server and either the its internal RMI registry or a separate external rmiregistry process are running on the remote host on the default port (port 1099)\&. It also assumes that the local host has appropriate permissions to access the remote host\&. This example also includes the \f3-l\fR option to output the long form of the class names or JAR file names\&. +.sp +.nf +\f3jps \-l remote\&.domain\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f32857 sun\&.tools\&.jstatd\&.jstatd\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example lists the instrumented JVMs on a remote host with a non-default port for the RMI registry\&. This example assumes that the \f3jstatd\fR server, with an internal RMI registry bound to port 2002, is running on the remote host\&. This example also uses the \f3-m\fR option to include the arguments passed to the \f3main\fR method of each of the listed Java applications\&. +.sp +.nf +\f3jps \-m remote\&.domain:2002\fP +.fi +.nf +\f33002 /opt/jdk1\&.7\&.0/demo/jfc/Java2D/Java2Demo\&.JAR\fP +.fi +.nf +\f33102 sun\&.tools\&.jstatd\&.jstatd \-p 2002\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jrunscript.1 b/jdk/src/solaris/doc/sun/man/man1/jrunscript.1 index 7c6548fa794..981be31bf1a 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jrunscript.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jrunscript.1 @@ -1,187 +1,196 @@ -." Copyright (c) 2006, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jrunscript 1 "10 May 2011" +'\" t +.\" Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Scripting Tools +.\" Title: jrunscript.1 +.\" +.if n .pl 99999 +.TH jrunscript 1 "21 November 2013" "JDK 8" "Scripting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jrunscript \- command line script shell -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jrunscript\fP [ \f2options\fP ] [ arguments... ] -.fl -.fi +.SH NAME +jrunscript \- Runs a command-line script shell that supports interactive and batch modes\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Options, if used, should follow immediately after the command name. -.TP 3 -arguments -Arguments, if used, should follow immediately after options or command name. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jrunscript\fP is a command line script shell. jrunscript supports both an interactive (read\-eval\-print) mode and a batch (\-f option) mode of script execution. This is a scripting language independent shell. By default, JavaScript is the language used, but the \-l option can be used to specify a different language. Through Java to scripting language communication, jrunscript supports "exploratory programming" style. -.LP -.LP -\f3NOTE:\fP This tool is \f3experimental\fP and may \f3not\fP be available in future versions of the JDK. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-classpath path -Specify where to find the user's .class files that are accessed by the script. -.TP 3 -\-cp path -This is a synonym for \-classpath \f2path\fP -.TP 3 -\-Dname=value -Set a Java system property. -.TP 3 -\-J<flag> -Pass <flag> directly to the Java virtual machine on which jrunscript is run. -.TP 3 -\-l language -Use the specified scripting language. By default, JavaScript is used. Note that to use other scripting languages, you also need to specify the corresponding script engine's jar file using \-cp or \-classpath option. -.TP 3 -\-e script -Evaluate the given script. This option can be used to run "one liner" scripts specified completely on the command line. -.TP 3 -\-encoding encoding -Specify the character encoding used while reading script files. -.TP 3 -\-f script\-file -Evaluate the given script file (batch mode). -.TP 3 -\-f \- -Read and evaluate a script from standard input (interactive mode). -.TP 3 -\-help\ -Output help message and exit. -.TP 3 -\-?\ -Output help message and exit. -.TP 3 -\-q\ -List all script engines available and exit. -.RE - -.LP -.SH "ARGUMENTS" -.LP -.LP -If [arguments...] are present and if no \f3\-e\fP or \f3\-f\fP option is used, then the first argument is the script file and the rest of the arguments, if any, are passed as script arguments. If [arguments..] and \f3\-e\fP or \f3\-f\fP option are used, then all [arguments..] are passed as script arguments. If [arguments..], \f3\-e\fP and \f3\-f\fP are missing, interactive mode is used. Script arguments are available to a script in an engine variable named "arguments" of type String array. -.LP -.SH "EXAMPLES" -.LP -.SS -Executing inline scripts -.LP -.nf -\f3 -.fl -jrunscript \-e "print('hello world')" -.fl -jrunscript \-e "cat('http://java.sun.com')" -.fl -\fP -.fi - -.LP -.SS -Use specified language and evaluate given script file -.LP -.nf -\f3 -.fl -jrunscript \-l js \-f test.js -.fl -\fP -.fi - -.LP -.SS -Interactive mode -.LP -.nf -\f3 -.fl -jrunscript -.fl -js> print('Hello World\\n'); -.fl -Hello World -.fl -js> 34 + 55 -.fl -89.0 -.fl -js> t = new java.lang.Thread(function() { print('Hello World\\n'); }) -.fl -Thread[Thread\-0,5,main] -.fl -js> t.start() -.fl -js> Hello World -.fl - -.fl -js> -.fl -\fP -.fi - -.LP -.SS -Run script file with script arguments -.LP -.nf -\f3 -.fl -jrunscript test.js arg1 arg2 arg3 -.fl -\fP -.fi - -.LP -test.js is script file to execute and arg1, arg2 and arg3 are passed to script as script arguments. Script can access these using "arguments" array. -.SH "SEE ALSO" -.LP -.LP -If JavaScript is used, then before evaluating any user defined script, jrunscript initializes certain built\-in functions and objects. These JavaScript built\-ins are documented in -.na -\f2jsdocs\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/share/jsdocs/allclasses\-noframe.html. -.LP - +\fBjrunscript\fR [\fIoptions\fR] [\fIarguments\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIarguments\fR +Arguments, when used, follow immediately after options or the command name\&. See Arguments\&. +.SH DESCRIPTION +The \f3jrunscript\fR command is a language-independent command-line script shell\&. The \f3jrunscript\fR command supports both an interactive (read-eval-print) mode and a batch (\f3-f\fR option) mode of script execution\&. By default, JavaScript is the language used, but the \f3-l\fR option can be used to specify a different language\&. By using Java to scripting language communication, the \f3jrunscript\fR command supports an exploratory programming style\&. +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +Indicate where any class files are that the script needs to access\&. +.TP +-cp \fIpath\fR +.br +Same as \f3-classpath\fR\f3path\fR\&. +.TP +-D\fIname\fR=\fIvalue\fR +.br +Sets a Java system property\&. +.TP +-J\fIflag\fR +.br +Passes \f3flag\fR directly to the Java Virtual Machine where the \f3jrunscript\fR command is running\&. +.TP +-I \fIlanguage\fR +.br +Uses the specified scripting language\&. By default, JavaScript is used\&. To use other scripting languages, you must specify the corresponding script engine\&'s JAR file with the \f3-cp\fR or \f3-classpath\fR option\&. +.TP +-e \fIscript\fR +.br +Evaluates the specified script\&. This option can be used to run one-line scripts that are specified completely on the command line\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the character encoding used to read script files\&. +.TP +-f \fIscript-file\fR +.br +Evaluates the specified script file (batch mode)\&. +.TP +-f - +.br +Reads and evaluates a script from standard input (interactive mode)\&. +.TP +-help +.br +Displays a help message and exits\&. +.TP +-? +.br +Displays a help message and exits\&. +.TP +-q +.br +Lists all script engines available and exits\&. +.SH ARGUMENTS +If arguments are present and if no \f3-e\fR or \f3-f\fR option is used, then the first argument is the script file and the rest of the arguments, if any, are passed to the script\&. If arguments and \f3-e\fR or the \f3-f\fR option are used, then all arguments are passed to the script\&. If arguments, \f3-e\fR and \f3-f\fR are missing, then interactive mode is used\&. Script arguments are available to a script in an engine variable named \f3arguments\fR of type \f3String\fR array\&. +.SH EXAMPLES +.SS EXECUTE\ INLINE\ SCRIPTS +.sp +.nf +\f3jrunscript \-e "print(\&'hello world\&')"\fP +.fi +.nf +\f3jrunscript \-e "cat(\&'http://www\&.example\&.com\&')"\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS USE\ SPECIFIED\ LANGUAGE\ AND\ EVALUATE\ THE\ SCRIPT\ FILE +.sp +.nf +\f3jrunscript \-l js \-f test\&.js\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INTERACTIVE\ MODE +.sp +.nf +\f3jrunscript\fP +.fi +.nf +\f3js> print(\&'Hello World\en\&');\fP +.fi +.nf +\f3Hello World\fP +.fi +.nf +\f3js> 34 + 55\fP +.fi +.nf +\f389\&.0\fP +.fi +.nf +\f3js> t = new java\&.lang\&.Thread(function() { print(\&'Hello World\en\&'); })\fP +.fi +.nf +\f3Thread[Thread\-0,5,main]\fP +.fi +.nf +\f3js> t\&.start()\fP +.fi +.nf +\f3js> Hello World\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3js>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS RUN\ SCRIPT\ FILE\ WITH\ SCRIPT\ ARGUMENTS +The test\&.js file is the script file\&. The \f3arg1\fR, \f3arg2\fR and \f3arg3\fR arguments are passed to the script\&. The script can access these arguments with an arguments array\&. +.sp +.nf +\f3jrunscript test\&.js arg1 arg2 arg3\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +If JavaScript is used, then before it evaluates a user defined script, the \f3jrunscript\fR command initializes certain built-in functions and objects\&. These JavaScript built-ins are documented in JsDoc-Toolkit at http://code\&.google\&.com/p/jsdoc-toolkit/ +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jsadebugd.1 b/jdk/src/solaris/doc/sun/man/man1/jsadebugd.1 index 3d77b1d4113..a559377caff 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jsadebugd.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jsadebugd.1 @@ -1,109 +1,109 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jsadebugd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jsadebugd.1 +.\" +.if n .pl 99999 +.TH jsadebugd 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jsadebugd \- Serviceability Agent Debug Daemon -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jsadebugd\fP pid [ server\-id ] -.fl -\f3jsadebugd\fP executable core [ server\-id ] -.fl -.fi +.SH NAME +jsadebugd \- Attaches to a Java process or core file and acts as a debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -pid -process id of the process to which the debug server should attach. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. At most one instance of the debug server may be attached to a single process. -.TP 3 -executable -Java executable from which the core dump was produced -.TP 3 -core -Core file to which the debug server should attach. -.TP 3 -server\-id -Optional unique id, needed if multiple debug servers are started on the same machine. This ID must be used by remote clients to identify the particular debug server to attach. Within a single machine, this ID must be unique. -.RE +\fBjsadebugd\fR \fIpid\fR [ \fIserver\-id\fR ] +.fi +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jsadebugd\fP attaches to a Java process or core file and acts as a debug server. Remote clients such as jstack(1), jmap(1), and jinfo(1) can attach to the server using Java Remote Method Invocation (RMI). Before starting \f2jsadebugd\fP, -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi must be started with: -.LP -.nf -\f3 -.fl -\fP\f4rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi.jar\fP\f3 -.fl -\fP -.fi - -.LP -.LP -where \f2$JAVA_HOME\fP is the JDK installation directory. If rmiregistry was not started, jsadebugd will start an rmiregistry in a standard (1099) port internally. Debug server may be stopped by sending SIGINT (pressing Ctrl\-C) to it. -.LP -.LP -\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced. -.LP -.LP -For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jinfo(1) -.TP 2 -o -jmap(1) -.TP 2 -o -jps(1) -.TP 2 -o -jstack(1) -.TP 2 -o -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi -.RE - -.LP - +\fBjsadebugd\fR \fIexecutable\fR \fIcore\fR [ \fIserver\-id\fR ] +.fi +.sp +.TP +\fIpid\fR +The process ID of the process to which the debug server attaches\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. At most one instance of the debug server can be attached to a single process\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file to which the debug server should attach\&. +.TP +\fIserver-id\fR +An optional unique ID that is needed when multiple debug servers are started on the same machine\&. This ID must be used by remote clients to identify the particular debug server to which to attach\&. Within a single machine, this ID must be unique\&. +.SH DESCRIPTION +The \f3jsadebugd\fR command attaches to a Java process or core file and acts as a debug server\&. Remote clients such as \f3jstack\fR, \f3jmap\fR, and \f3jinfo\fR can attach to the server through Java Remote Method Invocation (RMI)\&. Before you start the \f3jsadebugd\fR command, start the RMI registry with the \f3rmiregistry\fR command as follows where \fI$JAVA_HOME\fR is the JDK installation directory: +.sp +.nf +\f3rmiregistry \-J\-Xbootclasspath/p:$JAVA_HOME/lib/sajdi\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +If the RMI registry was not started, then the \f3jsadebugd\fR command starts an RMI registry in a standard (1099) port internally\&. The debug server can be stopped by sending a \f3SIGINT\fR to it\&. To send a SIGINT press \fICtrl+C\fR\&. +.PP +\fINote:\fR This utility is unsupported and may or may not be available in future releases of the JDK\&. In Windows Systems where \f3dbgeng\&.dll\fR is not present, Debugging Tools For Windows must be installed to have these tools working\&. The \f3PATH\fR environment variable should contain the location of jvm\&.dll used by the target process or the location from which the crash dump file was produced\&. For example, \f3s\fR\f3et PATH=%JDK_HOME%\ejre\ebin\eclient;%PATH%\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jinfo(1) +.TP 0.2i +\(bu +jmap(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstack(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jstack.1 b/jdk/src/solaris/doc/sun/man/man1/jstack.1 index e70b10ed5e7..e91f2ef0bbe 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jstack.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jstack.1 @@ -1,148 +1,138 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstack 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Troubleshooting Tools +.\" Title: jstack.1 +.\" +.if n .pl 99999 +.TH jstack 1 "21 November 2013" "JDK 8" "Troubleshooting Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstack \- Stack Trace +.SH NAME +jstack \- Prints Java thread stack traces for a Java process, core file, or remote debug server\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIpid\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] \fIexecutable\fR \fIcore\fR +.fi +.nf + +\fBjstack\fR [ \fIoptions\fR ] [ \fIserver\-id\fR@ ] \fIremote\-hostname\-or\-IP\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIpid\fR +The process ID for which the stack trace is printed\&. The process must be a Java process\&. To get a list of Java processes running on a machine, use the jps(1) command\&. +.TP +\fIexecutable\fR +The Java executable from which the core dump was produced\&. +.TP +\fIcore\fR +The core file for which the stack trace is to be printed\&. +.TP +\fIremote-hostname-or-IP\fR +The remote debug server \f3hostname\fR or \f3IP\fR address\&. See jsadebugd(1)\&. +.TP +\fIserver-id\fR +An optional unique ID to use when multiple debug servers are running on the same remote host\&. +.SH DESCRIPTION +The \f3jstack\fR command prints Java stack traces of Java threads for a specified Java process, core file, or remote debug server\&. For each Java frame, the full class name, method name, byte code index (BCI), and line number, when available, are printed\&. With the \f3-m\fR option, the \f3jstack\fR command prints both Java and native frames of all threads with the program counter (PC)\&. For each native frame, the closest native symbol to PC, when available, is printed\&. C++ mangled names are not demangled\&. To demangle C++ names, the output of this command can be piped to \f3c++filt\fR\&. When the specified process is running on a 64-bit Java Virtual Machine, you might need to specify the \f3-J-d64\fR option, for example: \f3jstack -J-d64 -m pid\fR\&. +.PP +\fINote:\fR This utility is unsupported and might not be available in future release of the JDK\&. In Windows Systems where the dbgeng\&.dll file is not present, Debugging Tools For Windows must be installed so these tools work\&. The \f3PATH\fR environment variable needs to contain the location of the jvm\&.dll that is used by the target process, or the location from which the crash dump file was produced\&. For example: +.sp +.nf +\f3set PATH=<jdk>\ejre\ebin\eclient;%PATH%\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-F .br - -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jstack\fP [ option ] pid -.fl -\f3jstack\fP [ option ] executable core -.fl -\f3jstack\fP [ option ] [server\-id@]remote\-hostname\-or\-IP -.fl -.fi - -.LP -.SH "PARAMETERS" -.LP -.LP -Options are mutually exclusive. Option, if used, should follow immediately after the command name. See OPTIONS. -.LP -.RS 3 -.TP 3 -pid -process id for which the stack trace is to be printed. The process must be a Java process. To get a list of Java processes running on a machine, jps(1) may be used. -.RE - -.LP -.RS 3 -.TP 3 -executable -Java executable from which the core dump was produced. +Force a stack dump when \f3jstack\fR [\f3-l\fR] \f3pid\fR does not respond\&. +.TP +-l .br -.TP 3 -core -core file for which the stack trace is to be printed. +Long listing\&. Prints additional information about locks such as a list of owned \f3java\&.util\&.concurrent\fR ownable synchronizers\&. See the \f3AbstractOwnableSynchronizer\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer\&.html +.TP +-m .br -.TP 3 -remote\-hostname\-or\-IP -remote debug server's (see jsadebugd(1)) hostname or IP address. +Prints a mixed mode stack trace that has both Java and native C/C++ frames\&. +.TP +-h .br -.TP 3 -server\-id -optional unique id, if multiple debug servers are running on the same remote host. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3jstack\fP prints Java stack traces of Java threads for a given Java process or core file or a remote debug server. For each Java frame, the full class name, method name, 'bci' (byte code index) and line number, if available, are printed. With the \-m option, jstack prints both Java and native frames of all threads along with the 'pc' (program counter). For each native frame, the closest native symbol to 'pc', if available, is printed. C++ mangled names are not demangled. To demangle C++ names, the output of this command may be piped to \f3c++filt\fP. If the given process is running on a 64\-bit VM, you may need to specify the \f2\-J\-d64\fP option, e.g.: +Prints a help message\&. +.TP +-help .br - -.LP -.nf -\f3 -.fl -jstack \-J\-d64 \-m pid -.fl -\fP -.fi - -.LP -.LP -\f3NOTE\fP \- This utility is unsupported and may or may not be available in future versions of the JDK. In Windows Systems where dbgeng.dll is not present, 'Debugging Tools For Windows' needs to be installed to have these tools working. Also, \f2PATH\fP environment variable should contain the location of \f2jvm.dll\fP used by the target process or the location from which the Crash Dump file was produced. -.LP -.LP -For example, \f2set PATH=<jdk>\\jre\\bin\\client;%PATH%\fP -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-F -Force a stack dump when 'jstack [\-l] pid' does not respond. -.TP 3 -\-l -Long listing. Prints additional information about locks such as list of owned java.util.concurrent -.na -\f2ownable synchronizers\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/util/concurrent/locks/AbstractOwnableSynchronizer.html. -.TP 3 -\-m -prints mixed mode (both Java and native C/C++ frames) stack trace. -.TP 3 -\-h -prints a help message. -.br -.br -.TP 3 -\-help -prints a help message -.br -.RE - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -pstack(1) -.TP 2 -o -c++filt(1) -.TP 2 -o -jps(1) -.TP 2 -o -jsadebugd(1) -.RE - -.LP -.SH "KNOWN BUGS" -.LP -.LP -Mixed mode stack trace, the \-m option, does not work with the remote debug server. -.LP - +Prints a help message\&. +.SH KNOWN\ BUGS +In mixed mode stack trace, the \f3-m\fR option does not work with the remote debug server\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pstack(1) +.TP 0.2i +\(bu +C++filt(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jsadebugd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jstat.1 b/jdk/src/solaris/doc/sun/man/man1/jstat.1 index d874d440d13..405df264980 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jstat.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jstat.1 @@ -1,5355 +1,568 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstat 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 10 May 2011 +.\" SectDesc: Monitoring Tools +.\" Title: jstat.1 +.\" +.if n .pl 99999 +.TH jstat 1 "10 May 2011" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstat \- Java Virtual Machine Statistics Monitoring Tool -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3jstat\fP [ \f2generalOption\fP | \f2outputOptions\fP \f2vmid\fP [\f2interval\fP[s|ms] [\f2count\fP]] ] -.fl -.fi +.SH NAME +jstat \- Monitors Java Virtual Machine (JVM) statistics\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -generalOption -A single general command\-line option (\-help, \-options, or \-version) -.TP 3 -outputOptions -One or more output options, consisting of a single \f2statOption\fP, plus any of the \-t, \-h, and \-J options. -.TP 3 -vmid -Virtual machine identifier, a string indicating the target Java virtual machine (JVM). The general syntax is -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][//]\fP\f4lvmid\fP[@\f2hostname\fP[:\f2port\fP]/\f2servername\fP] -.fl -.fi -The syntax of the vmid string largely corresponds to the syntax of a URI. The \f2vmid\fP can vary from a simple integer representing a local JVM to a more complex construction specifying a communications protocol, port number, and other implementation\-specific values. See Virtual Machine Identifier for details. -.TP 3 -interval[s|ms] -Sampling interval in the specified units, seconds (s) or milliseconds (ms). Default units are milliseconds. Must be a positive integer. If specified, \f3jstat\fP will produce its output at each interval. -.TP 3 -count -Number of samples to display. Default value is infinity; that is, \f3jstat\fP displays statistics until the target JVM terminates or the \f3jstat\fP command is terminated. Must be a positive integer. -.RE +\fBjstat\fR [ \fIgeneralOption\fR | \fIoutputOptions vmid\fR [ \fIinterval\fR[s|ms] [ \fIcount \fR] ] +.fi +.sp +.TP +\fIgeneralOption\fR +A single general command-line option \f3-help\fR or \f3-options\fR\&. See General Options\&. +.TP +\fIoutputOptions\fR +One or more output options that consist of a single \f3statOption\fR, plus any of the \f3-t\fR, \f3-h\fR, and \f3-J\fR options\&. See Output Options\&. +.TP +\fIvmid\fR +Virtual machine identifier, which is a string that indicates the target JVM\&. The general syntax is the following: +.sp +.nf +\f3[protocol:][//]lvmid[@hostname[:port]/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jstat\fP tool displays performance statistics for an instrumented HotSpot Java virtual machine (JVM). The target JVM is identified by its virtual machine identifier, or \f2vmid\fP option described below. -.LP -.LP -\f3NOTE\fP: This utility is unsupported and may not be available in future versions of the JDK. It is not currently available on Windows 98 and Windows ME. platforms. -.br -.LP -.SS -VIRTUAL MACHINE IDENTIFIER -.LP -.LP -The syntax of the \f2vmid\fP string largely corresponds to the syntax of a URI: -.LP -.nf -\f3 -.fl -[\fP\f4protocol\fP\f3:][//]\fP\f4lvmid\fP[@\f2hostname\fP][:\f2port\fP][/\f2servername\fP] -.fl -.fi +The syntax of the \f3vmid\fR string corresponds to the syntax of a URI\&. The \f3vmid\fR string can vary from a simple integer that represents a local JVM to a more complex construction that specifies a communications protocol, port number, and other implementation-specific values\&. See Virtual Machine Identifier\&. +.TP +\fIinterval\fR [s|ms] +Sampling interval in the specified units, seconds (s) or milliseconds (ms)\&. Default units are milliseconds\&. Must be a positive integer\&. When specified, the \f3jstat\fR command produces its output at each interval\&. +.TP +\fIcount\fR +Number of samples to display\&. The default value is infinity which causes the \f3jstat\fR command to display statistics until the target JVM terminates or the \f3jstat\fR command is terminated\&. This value must be a positive integer\&. +.SH DESCRIPTION +The \f3jstat\fR command displays performance statistics for an instrumented Java HotSpot VM\&. The target JVM is identified by its virtual machine identifier, or \f3vmid\fR option\&. +.SH VIRTUAL\ MACHINE\ IDENTIFIER +The syntax of the \f3vmid\fR string corresponds to the syntax of a URI: +.sp +.nf +\f3[protocol:][//]lvmid[@hostname[:port]/servername]\fP +.fi +.nf +\f3\fP +.fi +.sp +.TP +\fIprotocol\fR +The communications protocol\&. If the \fIprotocol\fR value is omitted and a host name is not specified, then the default protocol is a platform-specific optimized local protocol\&. If the \fIprotocol\fR value is omitted and a host name is specified, then the default protocol is \f3rmi\fR\&. +.TP +\fIlvmid\fR +The local virtual machine identifier for the target JVM\&. The \f3lvmid\fR is a platform-specific value that uniquely identifies a JVM on a system\&. The \f3lvmid\fR is the only required component of a virtual machine identifier\&. The \f3lvmid\fR is typically, but not necessarily, the operating system\&'s process identifier for the target JVM process\&. You can use the \f3jps\fR command to determine the \f3lvmid\fR\&. Also, you can determine the \f3lvmid\fR on UNIX platforms with the \f3ps\fR command, and on Windows with the Windows Task Manager\&. +.TP +\fIhostname\fR +A hostname or IP address that indicates the target host\&. If the \fIhostname\fR value is omitted, then the target host is the local host\&. +.TP +\fIport\fR +The default port for communicating with the remote server\&. If the \fIhostname\fR value is omitted or the \fIprotocol\fR value specifies an optimized, local protocol, then the \fIport\fR value is ignored\&. Otherwise, treatment of the \f3port\fR parameter is implementation-specific\&. For the default \f3rmi\fR protocol, the port value indicates the port number for the rmiregistry on the remote host\&. If the \fIport\fR value is omitted and the \fIprotocol\fR value indicates \f3rmi\fR, then the default rmiregistry port (1099) is used\&. +.TP +\fIservername\fR +The treatment of the \f3servername\fR parameter depends on implementation\&. For the optimized local protocol, this field is ignored\&. For the \f3rmi\fR protocol, it represents the name of the RMI remote object on the remote host\&. +.SH OPTIONS +The \f3jstat\fR command supports two types of options, general options and output options\&. General options cause the \f3jstat\fR command to display simple usage and version information\&. Output options determine the content and format of the statistical output\&. +.PP +All options and their functionality are subject to change or removal in future releases\&. +.SS GENERAL\ OPTIONS +If you specify one of the general options, then you cannot specify any other option or parameter\&. +.TP +-help +.br +Displays a help message\&. +.TP +-options +.br +Displays a list of static options\&. See Output Options\&. +.SS OUTPUT\ OPTIONS +If you do not specify a general option, then you can specify output options\&. Output options determine the content and format of the \f3jstat\fR command\&'s output, and consist of a single \f3statOption\fR, plus any of the other output options (\f3-h\fR, \f3-t\fR, and \f3-J\fR)\&. The \f3statOption\fR must come first\&. +.PP +Output is formatted as a table, with columns that are separated by spaces\&. A header row with titles describes the columns\&. Use the \f3-h\fR option to set the frequency at which the header is displayed\&. Column header names are consistent among the different options\&. In general, if two options provide a column with the same name, then the data source for the two columns is the same\&. +.PP +Use the \f3-t\fR option to display a time stamp column, labeled Timestamp as the first column of output\&. The Timestamp column contains the elapsed time, in seconds, since the target JVM started\&. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems\&. +.PP +Use the interval and count parameters to determine how frequently and how many times, respectively, the \f3jstat\fR command displays its output\&. +.PP +\fINote:\fR Do not to write scripts to parse the \f3jstat\fR command\&'s output because the format might change in future releases\&. If you write scripts that parse \f3jstat\fR command output, then expect to modify them for future releases of this tool\&. +.TP +-\fIstatOption\fR +.br +Determines the statistics information the \f3jstat\fR command displays\&. The following lists the available options\&. Use the \f3-options\fR general option to display the list of options for a particular platform installation\&. See Stat Options and Output\&. -.LP -.RS 3 -.TP 3 -protocol -The communications protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is not specified, the default protocol is a platform specific optimized local protocol. If the \f2protocol\fP is omitted and a \f2hostname\fP is specified, then the default protocol is \f3rmi\fP. -.TP 3 -lvmid -The local virtual machine identifier for the target JVM. The \f2lvmid\fP is a platform\-specific value that uniquely identifies a JVM on a system. The \f2lvmid\fP is the only required component of a virtual machine identifier. The \f2lvmid\fP is typically, but not necessarily, the operating system's process identifier for the target JVM process. You can use the jps(1) command to determine the \f2lvmid\fP. Also, you can determine \f2lvmid\fP on Unix platforms with the \f3ps\fP command, and on Windows with the Windows Task Manager. -.TP 3 -hostname -A hostname or IP address indicating the target host. If \f2hostname\fP is omitted, then the target host is the local host. -.TP 3 -port -The default port for communicating with the remote server. If the \f2hostname\fP is omitted or the \f2protocol\fP specifies an optimized, local protocol, then \f2port\fP is ignored. Otherwise, treatment of the \f2port\fP parameter is implementation specific. For the default \f3rmi\fP protocol, the \f2port\fP indicates the port number for the rmiregistry on the remote host. If \f2port\fP is omitted, and \f2protocol\fP indicates \f3rmi\fP, then the default rmiregistry port (1099) is used. -.TP 3 -servername -The treatment of this parameter depends on implementation. For the optimized local protocol, this field is ignored. For the \f3rmi\fP protocol, it represents the name of the RMI remote object on the remote host. -.RE +\f3class\fR: Displays statistics about the behavior of the class loader\&. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jstat\fP command supports two types of options, general options and output options. General options cause \f3jstat\fP to display simple usage and version information. Output options determine the content and format of the statistical output. -.br +\f3compiler\fR: Displays statistics about the behavior of the Java HotSpot VM Just-in-Time compiler\&. -.LP -.LP -\f3NOTE\fP: All options, and their functionality are subject to change or removal in future releases. -.LP -.SS -GENERAL OPTIONS -.LP -.LP -If you specify one of the general options, you cannot specify any other option or parameter. -.LP -.RS 3 -.TP 3 -\-help -Display help message. -.TP 3 -\-version -Display version information. -.TP 3 -\-options -Display list of statistics options. See the Output Options section below. -.RE +\f3gc\fR: Displays statistics about the behavior of the garbage collected heap\&. -.LP -.SS -OUTPUT OPTIONS -.LP -.LP -If you do not specify a general option, then you can specify output options. Output options determine the content and format of \f3jstat\fP's output, and consist of a single \f2statOption\fP, plus any of the other output options (\-h, \-t, and \-J). The \f2statOption\fP must come first. -.LP -.LP -Output is formatted as a table, with columns are separated by spaces. A header row with titles describes the columns. Use the \f3\-h\fP option to set the frequency at which the header is displayed. Column header names are generally consistent between the different options. In general, if two options provide a column with the same name, then the data source for the two columns are the same. -.LP -.LP -Use the \f3\-t\fP option to display a time stamp column, labeled \f2Timestamp\fP as the first column of output. The \f2Timestamp\fP column contains the elapsed time, in seconds, since startup of the target JVM. The resolution of the time stamp is dependent on various factors and is subject to variation due to delayed thread scheduling on heavily loaded systems. -.LP -.LP -Use the \f2interval\fP and \f2count\fP parameters to determine how frequently and how many times, respectively, \f3jstat\fP displays its output. -.LP -.LP -\f3NOTE\fP: You are advised not to write scripts to parse \f3jstat's\fP output since the format may change in future releases. If you choose to write scripts that parse \f3jstat\fP output, expect to modify them for future releases of this tool. -.LP -.RS 3 -.TP 3 -\-statOption -Determines the statistics information that \f3jstat\fP displays. The following table lists the available options. Use the \f3\-options\fP general option to display the list of options for a particular platform installation. -.br -.br -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics on the behavior of the class loader. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the HotSpot Just\-in\-Time compiler. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the garbage collected heap. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the capacities of the generations and their corresponding spaces. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Summary of garbage collection statistics (same as \f3\-gcutil\fP), with the cause of the last and current (if applicable) garbage collection events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the new generation. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the new generations and its corresponding spaces. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the behavior of the old and permanent generations. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the old generation. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Statistics of the sizes of the permanent generation. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Summary of garbage collection statistics. -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -HotSpot compilation method statistics. -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wclass -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wcompiler -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgc -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgccapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgccause -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcnew -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcnewcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcold -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcoldcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcpermcapacity -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wgcutil -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wprintcompilation -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Displays...\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 215 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Displays...\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'class\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'compiler\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gc\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gccapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gccause\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcnew\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcnewcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcold\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcoldcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcpermcapacity\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'gcutil\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'printcompilation\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-52 -.TP 3 -\-h n -Display a column header every \f2n\fP samples (output rows), where \f2n\fP is a positive integer. Default value is 0, which displays the column header above the first row of data. -.TP 3 -\-t n -Display a timestamp column as the first column of output. The timestamp is the time since the start time of the target JVM. -.TP 3 -\-JjavaOption -Pass \f2javaOption\fP to the \f3java\fP application launcher. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. For a complete list of options, see java(1) -.RE +\f3gccapacity\fR: Displays statistics about the capacities of the generations and their corresponding spaces\&. -.LP -.SS -STATOPTIONS AND OUTPUT -.LP -.LP -The following tables summarize the columns that \f3jstat\fP outputs for each \f2statOption\fP. -.br +\f3gccause\fR: Displays a summary about garbage collection statistics (same as \f3-gcutil\fR), with the cause of the last and current (when applicable) garbage collection events\&. -.LP -.SS -\-class Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of classes unloaded. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of Kbytes unloaded. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Time spent performing class load and unload operations. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wClass Loader Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wLoaded -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBytes -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wUnloaded -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBytes -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTime -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of classes loaded. -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Kbytes loaded. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 261 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Class Loader Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Loaded\h'|\n(41u'Number of classes loaded. -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Bytes\h'|\n(41u'Number of Kbytes loaded. -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Unloaded\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Bytes\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Time\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-21 +\f3gcnew\fR: Displays statistics of the behavior of the new generation\&. -.LP -.SS -\-compiler Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks performed. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks that failed. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks that were invalidated. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Time spent performing compilation tasks. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Compile type of the last failed compilation. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Class name and method for the last failed compilation. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wHotSpot Just\-In\-Time Compiler Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wCompiled -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailed -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wInvalid -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTime -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailedType -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFailedMethod -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 297 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'HotSpot Just\-In\-Time Compiler Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Compiled\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Failed\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Invalid\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Time\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FailedType\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FailedMethod\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-29 +\f3gcnewcapacity\fR: Displays statistics about the sizes of the new generations and its corresponding spaces\&. -.LP -.SS -\-gc Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Old space utilization (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization (KB). -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC Events. -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wGarbage\-collected heap statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 367 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Garbage\-collected heap statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(m|u+\n(.Vu -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-63 +\f3gcold\fR: Displays statistics about the behavior of the old generation and Metaspace Statistics\&. -.LP -.SS -\-gccapacity Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum new generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum new generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current new generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum old generation capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum old generation capacity (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old generation capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum permanent generation capacity (KB). -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum Permanent generation capacity (KB). -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current Permanent generation capacity (KB). -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current Permanent space capacity (KB). -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di o+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of Young generation GC Events. -.br -.di -.nr o| \n(dn -.nr o- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wMemory Pool Generation and Space Capacities -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Full GC Events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(l- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(o- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 441 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Memory Pool Generation and Space Capacities\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(m|u+\n(.Vu -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(o|u+\n(.Vu -.if (\n(o|+\n(#^-1v)>\n(#- .nr #- +(\n(o|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.o+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of Full GC Events. -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.rm o+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-67 +\f3gcoldcapacity\fR: Displays statistics about the sizes of the old generation\&. -.LP -.SS -\-gccause Option -.LP -.LP -This option displays the same summary of garbage collection statistics as the \f3\-gcutil\fP option, but includes the causes of the last garbage collection event and (if applicable) the current garbage collection event. In addition to the columns listed for \f3\-gcutil\fP, this option adds the following columns: -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Cause of last Garbage Collection. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Cause of current Garbage Collection. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wGarbage Collection Statistics, Including GC Events -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wLGCC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 464 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Garbage Collection Statistics, Including GC Events\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'LGCC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-13 +\f3gcmetacapacity\fR: Displays statistics about the sizes of the metaspace\&. -.LP -.SS -\-gcnew Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum tenuring threshold. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Desired survivor size (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wNew Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1U -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wTT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wMTT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wDSS -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wTenuring threshold. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 518 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'New Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1U\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'TT\h'|\n(41u'Tenuring threshold. -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'MTT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'DSS\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-47 +\f3gcutil\fR: Displays a summary about garbage collection statistics\&. -.LP -.SS -\-gcnewcapacity Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\f3printcompilation\fR: Displays Java HotSpot VM compilation method statistics\&. +.TP +-h \fIn\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum new generation capacity (KB). +Displays a column header every \fIn\fR samples (output rows), where \fIn\fR is a positive integer\&. Default value is 0, which displays the column header the first row of data\&. +.TP +-t .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Display sa timestamp column as the first column of output\&. The time stamp is the time since the start time of the target JVM\&. +.TP +-J\fIjavaOption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum new generation capacity (KB). +Passes \f3javaOption\fR to the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. For a complete list of options, see java(1)\&. +.SS STAT\ OPTIONS\ AND\ OUTPUT +The following information summarizes the columns that the \f3jstat\fR command outputs for each \fIstatOption\fR\&. +.TP +-class \fIoption\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current new generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum survivor space 0 capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 0 capacity (KB). -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum survivor space 1 capacity (KB). -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current survivor space 1 capacity (KB). -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum eden space capacity (KB). -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current eden space capacity (KB). -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wNew Generation Space Size Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wNGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0CMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1CMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1C -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wECMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of Full GC Events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 572 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'New Generation Space Size Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'NGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0CMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1CMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1C\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'ECMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of Full GC Events. -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-47 +Class loader statistics\&. -.LP -.SS -\-gcold Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -old space utilization (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wOld and Permanent Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOU -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 614 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Old and Permanent Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OU\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Loaded\fR: Number of classes loaded\&. -.LP -.SS -\-gcoldcapacity Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum old generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum old generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current old space capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wOld Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wOC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 656 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Old Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'OC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Bytes\fR: Number of KBs loaded\&. -.LP -.SS -\-gcpermcapacity Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Minimum permanent generation capacity (KB). -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Maximum permanent generation capacity (KB). -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent generation capacity (KB). -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Current permanent space capacity (KB). -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wPermanent Generation Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMN -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGCMX -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wPC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 698 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Permanent Generation Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMN\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGCMX\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'PC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-35 +\f3Unloaded\fR: Number of classes unloaded\&. -.LP -.SS -\-gcutil Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 0 utilization as a percentage of the space's current capacity. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Survivor space 1 utilization as a percentage of the space's current capacity. -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Eden space utilization as a percentage of the space's current capacity. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Old space utilization as a percentage of the space's current capacity. -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Permanent space utilization as a percentage of the space's current capacity. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of young generation GC events. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Young generation garbage collection time. -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Full garbage collection time. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Total garbage collection time. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wSummary of Garbage Collection Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS0 -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wS1 -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wE -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wO -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wYGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGC -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wFGCT -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wGCT -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wNumber of full GC events. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 748 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Summary of Garbage Collection Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S0\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'S1\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'E\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'O\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'P\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGC\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'YGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGC\h'|\n(41u'Number of full GC events. -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'FGCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'GCT\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-43 +\f3Bytes\fR: Number of Kbytes unloaded\&. -.LP -.SS -\-printcompilation Option -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\f3Time\fR: Time spent performing class loading and unloading operations\&. +.TP +-compiler \fIoption\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of compilation tasks performed. +Java HotSpot VM Just-in-Time compiler statistics\&. + +\f3Compiled\fR: Number of compilation tasks performed\&. + +\f3Failed\fR: Number of compilations tasks failed\&. + +\f3Invalid\fR: Number of compilation tasks that were invalidated\&. + +\f3Time\fR: Time spent performing compilation tasks\&. + +\f3FailedType\fR: Compile type of the last failed compilation\&. + +\f3FailedMethod\fR: Class name and method of the last failed compilation\&. +.TP +-gc \fIoption\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Garbage-collected heap statistics\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3S0U\fR: Survivor space 0 utilization (KB)\&. + +\f3S1U\fR: Survivor space 1 utilization (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3EU\fR: Eden space utilization (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3OU\fR: Old space utilization (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3MU\fR: Metacspace utilization (KB)\&. + +\f3YGC\fR: Number of young generation garbage collection events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gccapacity \fIoption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Number of bytes of bytecode for the method. +Memory pool generation and space capacities\&. + +\f3NGCMN\fR: Minimum new generation capacity (KB)\&. + +\f3NGCMX\fR: Maximum new generation capacity (KB)\&. + +\f3NGC\fR: Current new generation capacity (KB)\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3OGCMN\fR: Minimum old generation capacity (KB)\&. + +\f3OGCMX\fR: Maximum old generation capacity (KB)\&. + +\f3OGC\fR: Current old generation capacity (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3MCMN\fR: Minimum metaspace capacity (KB)\&. + +\f3MCMX\fR: Maximum metaspace capacity (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3YGC\fR: Number of Young generation GC Events\&. + +\f3FGC\fR: Number of Full GC Events\&. +.TP +-gccause \fIoption\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +This option displays the same summary of garbage collection statistics as the \f3-gcutil\fR option, but includes the causes of the last garbage collection event and (when applicable) the current garbage collection event\&. In addition to the columns listed for \f3-gcutil\fR, this option adds the following columns\&. + +Garbage collection statistics, including garbage collection Events\&. + +\f3LGCC\fR: Cause of last garbage collection\&. + +\f3GCC\fR: Cause of current garbage collection\&. +.TP +-gcnew \fIoption\fR .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Class name and method name identifying the compiled method. Class name uses "/" instead of "." as namespace separator. Method name is the method within the given class. The format for these two fields is consistent with the HotSpot \- \f3XX:+PrintComplation\fP option. +New generation statistics\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3S0U\fR: Survivor space 0 utilization (KB)\&. + +\f3S1U\fR: Survivor space 1 utilization (KB)\&. + +\f3TT\fR: Tenuring threshold\&. + +\f3MTT\fR: Maximum tenuring threshold\&. + +\f3DSS\fR: Desired survivor size (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3EU\fR: Eden space utilization (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. +.TP +-gcnewcapacity \fIoption\fR .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \wHotSpot Compiler Method Statistics -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3Column\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wCompiled -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSize -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wType -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wMethod -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wCompilation type. -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 774 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'HotSpot Compiler Method Statistics\h'|\n(41u' -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Column\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Compiled\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Size\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Type\h'|\n(41u'Compilation type. -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'Method\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-19 +New generation space size statistics\&. -.LP -.SH "EXAMPLES" -.LP -.LP -This section presents some examples of monitoring a local JVM with a \f2lvmid\fP of 21891. -.LP -.SS -Using the gcutil option -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes 7 samples at 250 millisecond intervals and displays the output as specified by the \f3\-gcutil\fP option. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcutil 21891 250 7\fP +NGCMN: Minimum new generation capacity (KB)\&. + +\f3NGCMX\fR: Maximum new generation capacity (KB)\&. + +\f3NGC\fR: Current new generation capacity (KB)\&. + +\f3S0CMX\fR: Maximum survivor space 0 capacity (KB)\&. + +\f3S0C\fR: Current survivor space 0 capacity (KB)\&. + +\f3S1CMX\fR: Maximum survivor space 1 capacity (KB)\&. + +\f3S1C\fR: Current survivor space 1 capacity (KB)\&. + +\f3ECMX\fR: Maximum eden space capacity (KB)\&. + +\f3EC\fR: Current eden space capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of Full GC Events\&. +.TP +-gcold \fIoption\fR .br +old and permanent generation statistics\&. -.fl - S0 S1 E O P YGC YGCT FGC FGCT GCT +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3MU\fR: Metaspace utilization (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3OU\fR: old space utilization (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcoldcapacity \fIoption\fR .br +Old generation statistics\&. -.fl - 12.44 0.00 27.20 9.49 96.70 78 0.176 5 0.495 0.672 +\f3OGCMN\fR: Minimum old generation capacity (KB)\&. + +\f3OGCMX\fR: Maximum old generation capacity (KB)\&. + +\f3OGC\fR: Current old generation capacity (KB)\&. + +\f3OC\fR: Current old space capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcmetacapacity \fIoption\fR .br +Permanent generation statistics\&. -.fl - 12.44 0.00 62.16 9.49 96.70 78 0.176 5 0.495 0.672 +\f3MCMN\fR: Minimum metaspace capacity (KB)\&. + +\f3MCMX\fR: Maximum metaspace capacity (KB)\&. + +\f3MC\fR: Metaspace capacity (KB)\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-gcutil \fIoption\fR .br +Summary of garbage collection statistics\&. -.fl - 12.44 0.00 83.97 9.49 96.70 78 0.176 5 0.495 0.672 +\f3S0\fR: Survivor space 0 utilization as a percentage of the space\&'s current capacity\&. + +\f3S1\fR: Survivor space 1 utilization as a percentage of the space\&'s current capacity\&. + +\f3E\fR: Eden space utilization as a percentage of the space\&'s current capacity\&. + +\f3O\fR: Old space utilization as a percentage of the space\&'s current capacity\&. + +\f3M\fR: Metaspace utilization as a percentage of the space\&'s current capacity\&. + +\f3YGC\fR: Number of young generation GC events\&. + +\f3YGCT\fR: Young generation garbage collection time\&. + +\f3FGC\fR: Number of full GC events\&. + +\f3FGCT\fR: Full garbage collection time\&. + +\f3GCT\fR: Total garbage collection time\&. +.TP +-printcompilation \fIoption\fR .br +Java HotSpot VM compiler method statistics\&. -.fl - 0.00 7.74 0.00 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Compiled\fR: Number of compilation tasks performed by the most recently compiled method\&. -.fl - 0.00 7.74 23.37 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Size\fR: Number of bytes of byte code of the most recently compiled method\&. -.fl - 0.00 7.74 43.82 9.51 96.70 79 0.177 5 0.495 0.673 -.br +\f3Type\fR: Compilation type of the most recently compiled method\&. -.fl - 0.00 7.74 58.11 9.51 96.71 79 0.177 5 0.495 0.673 -.br - -.fl -.fi - -.LP -.LP -The output of this example shows that a young generation collection occurred between the 3rd and 4th sample. The collection took 0.001 seconds and promoted objects from the eden space (E) to the old space (O), resulting in an increase of old space utilization from 9.49% to 9.51%. Before the collection, the survivor space was 12.44% utilized, but after this collection it is only 7.74% utilized. -.LP -.SS -Repeating the column header string -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes samples at 250 millisecond intervals and displays the output as specified by \f3\-gcutil\fP option. In addition, it uses the \f3\-h3\fP option to output the column header after every 3 lines of data. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcnew \-h3 21891 250\fP -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 0.0 31.7 31 31 32.0 512.0 178.6 249 0.203 -.br - -.fl - 64.0 64.0 0.0 31.7 31 31 32.0 512.0 355.5 249 0.203 -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 21.9 250 0.204 -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 245.9 250 0.204 -.br - -.fl - 64.0 64.0 35.4 0.0 2 31 32.0 512.0 421.1 250 0.204 -.br - -.fl - 64.0 64.0 0.0 19.0 31 31 32.0 512.0 84.4 251 0.204 -.br - -.fl - S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT -.br - -.fl - 64.0 64.0 0.0 19.0 31 31 32.0 512.0 306.7 251 0.204 -.br - -.fl -.fi - -.LP -.LP -In addition to showing the repeating header string, this example shows that between the 2nd and 3rd samples, a young GC occurred. Its duration was 0.001 seconds. The collection found enough live data that the survivor space 0 utilization (S0U) would would have exceeded the desired survivor Size (DSS). As a result, objects were promoted to the old generation (not visible in this output), and the tenuring threshold (TT) was lowered from 31 to 2. -.LP -.LP -Another collection occurs between the 5th and 6th samples. This collection found very few survivors and returned the tenuring threshold to 31. -.LP -.SS -Including a time stamp for each sample -.LP -.LP -This example attaches to \f2lvmid\fP 21891 and takes 3 samples at 250 millisecond intervals. The \f3\-t\fP option is used to generate a time stamp for each sample in the first column. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcoldcapacity \-t 21891 250 3\fP -.br - -.fl -Timestamp OGCMN OGCMX OGC OC YGC FGC FGCT GCT -.br - -.fl - 150.1 1408.0 60544.0 11696.0 11696.0 194 80 2.874 3.799 -.br - -.fl - 150.4 1408.0 60544.0 13820.0 13820.0 194 81 2.938 3.863 -.br - -.fl - 150.7 1408.0 60544.0 13820.0 13820.0 194 81 2.938 3.863 -.br - -.fl -.fi - -.LP -.LP -The \f2Timestamp\fP column reports the elapsed time in seconds since the start of the target JVM. In addition, the \f3\-gcoldcapacity\fP output shows the old generation capacity (OGC) and the old space capacity (OC) increasing as the heap expands to meet allocation and/or promotion demands. The old generation capacity (OGC) has grown to from 11696 KB to 13820 KB after the 81st Full GC (FGC). The maximum capacity of the generation (and space) is 60544 KB (OGCMX), so it still has room to expand. -.LP -.SS -Monitor instrumentation for a remote JVM -.LP -.LP -This example attaches to \f2lvmid\fP 40496 on the system named \f2remote.domain\fP using the \f3\-gcutil\fP option, with samples taken every second indefinitely. -.LP -.nf -\f3 -.fl -\fP\f3jstat \-gcutil 40496@remote.domain 1000\fP -.br - -.fl -... \f2output omitted\fP -.br - -.fl -.fi - -.LP -.LP -The \f2lvmid\fP is combined with the name of the remote host to construct a \f2vmid\fP of \f240496@remote.domain\fP. This \f2vmid\fP results in the use of the \f3rmi\fP protocol to communicate to the default \f3jstatd\fP server on the remote host. The \f3jstatd\fP server is located using the \f3rmiregistry\fP on \f2remote.domain\fP that is bound to the default \f3rmiregistry\fP port (port 1099). -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jps(1) \- the Java Process Status Application -.TP 2 -o -jstatd(1) \- the jvmstat daemon -.TP 2 -o -rmiregistry(1) \- the Java Remote Object Registry -.RE - -.LP - +\f3Method\fR: Class name and method name identifying the most recently compiled method\&. Class name uses slash (/) instead of dot (\&.) as a name space separator\&. Method name is the method within the specified class\&. The format for these two fields is consistent with the HotSpot \f3-XX:+PrintComplation\fR option\&. +.SH EXAMPLES +This section presents some examples of monitoring a local JVM with an \fIlvmid\fR of 21891\&. +.SS THE\ GCUTIL\ OPTION +This example attaches to lvmid 21891 and takes 7 samples at 250 millisecond intervals and displays the output as specified by the -\f3gcutil\fR option\&. +.PP +The output of this example shows that a young generation collection occurred between the third and fourth sample\&. The collection took 0\&.001 seconds and promoted objects from the eden space (E) to the old space (O), resulting in an increase of old space utilization from 9\&.49% to 9\&.51%\&. Before the collection, the survivor space was 12\&.44% utilized, but after this collection it is only 7\&.74% utilized\&. +.sp +.nf +\f3jstat \-gcutil 21891 250 7\fP +.fi +.nf +\f3 S0 S1 E O M YGC YGCT FGC FGCT GCT\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.49 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f30\&.00 99\&.74 13\&.80 7\&.86 95\&.82 3 0\&.124 0 0\&.000 0\&.124\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS REPEAT\ THE\ COLUMN\ HEADER\ STRING +This example attaches to lvmid 21891 and takes samples at 250 millisecond intervals and displays the output as specified by \f3-gcutil\fR option\&. In addition, it uses the \f3-h3\fR option to output the column header after every 3 lines of data\&. +.PP +In addition to showing the repeating header string, this example shows that between the second and third samples, a young GC occurred\&. Its duration was 0\&.001 seconds\&. The collection found enough active data that the survivor space 0 utilization (S0U) would have exceeded the desired survivor Size (DSS)\&. As a result, objects were promoted to the old generation (not visible in this output), and the tenuring threshold (TT) was lowered from 31 to 2\&. +.PP +Another collection occurs between the fifth and sixth samples\&. This collection found very few survivors and returned the tenuring threshold to 31\&. +.sp +.nf +\f3jstat \-gcnew \-h3 21891 250\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 31\&.7 31 31 32\&.0 512\&.0 178\&.6 249 0\&.203\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 31\&.7 31 31 32\&.0 512\&.0 355\&.5 249 0\&.203\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 21\&.9 250 0\&.204\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 245\&.9 250 0\&.204\fP +.fi +.nf +\f3 64\&.0 64\&.0 35\&.4 0\&.0 2 31 32\&.0 512\&.0 421\&.1 250 0\&.204\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 19\&.0 31 31 32\&.0 512\&.0 84\&.4 251 0\&.204\fP +.fi +.nf +\f3 S0C S1C S0U S1U TT MTT DSS EC EU YGC YGCT\fP +.fi +.nf +\f3 64\&.0 64\&.0 0\&.0 19\&.0 31 31 32\&.0 512\&.0 306\&.7 251 0\&.204\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS INCLUDE\ A\ TIME\ STAMP\ FOR\ EACH\ SAMPLE +This example attaches to lvmid 21891 and takes 3 samples at 250 millisecond intervals\&. The \f3-t\fR option is used to generate a time stamp for each sample in the first column\&. +.PP +The Timestamp column reports the elapsed time in seconds since the start of the target JVM\&. In addition, the \f3-gcoldcapacity\fR output shows the old generation capacity (OGC) and the old space capacity (OC) increasing as the heap expands to meet allocation or promotion demands\&. The old generation capacity (OGC) has grown to from 11,696 KB to 13820 KB after the eighty-first full garbage collection (FGC)\&. The maximum capacity of the generation (and space) is 60,544 KB (OGCMX), so it still has room to expand\&. +.sp +.nf +\f3Timestamp OGCMN OGCMX OGC OC YGC FGC FGCT GCT\fP +.fi +.nf +\f3 150\&.1 1408\&.0 60544\&.0 11696\&.0 11696\&.0 194 80 2\&.874 3\&.799\fP +.fi +.nf +\f3 150\&.4 1408\&.0 60544\&.0 13820\&.0 13820\&.0 194 81 2\&.938 3\&.863\fP +.fi +.nf +\f3 150\&.7 1408\&.0 60544\&.0 13820\&.0 13820\&.0 194 81 2\&.938 3\&.863\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS MONITOR\ INSTRUMENTATION\ FOR\ A\ REMOTE\ JVM +This example attaches to lvmid 40496 on the system named remote\&.domain using the \f3-gcutil\fR option, with samples taken every second indefinitely\&. +.PP +The lvmid is combined with the name of the remote host to construct a \fIvmid\fR of \f340496@remote\&.domain\fR\&. This vmid results in the use of the \f3rmi\fR protocol to communicate to the default \f3jstatd\fR server on the remote host\&. The \f3jstatd\fR server is located using the rmiregistry on \f3remote\&.domain\fR that is bound to the default rmiregistry port (port 1099)\&. +.sp +.nf +\f3jstat \-gcutil 40496@remote\&.domain 1000\fP +.fi +.nf +\f3\fI\&.\&.\&. output omitted\fR\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstatd(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/jstatd.1 b/jdk/src/solaris/doc/sun/man/man1/jstatd.1 index fd9b0f7b1e2..8db6e9678a2 100644 --- a/jdk/src/solaris/doc/sun/man/man1/jstatd.1 +++ b/jdk/src/solaris/doc/sun/man/man1/jstatd.1 @@ -1,257 +1,210 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH jstatd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Monitoring Tools +.\" Title: jstatd.1 +.\" +.if n .pl 99999 +.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -jstatd \- Virtual Machine jstat Daemon -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -jstatd [ \fP\f4options\fP\f3 ]\fP +.SH NAME +jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&. +.SH SYNOPSIS +.sp +.nf + +\fBjstatd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&. +.PP +The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&. +.SH OPTIONS +.TP +-nr .br -\f3 -.fl -\fP -.fi - -.LP -.SH "PARAMETERS" -.LP -.RS 3 -.TP 3 -options -Command\-line options. The options may be in any order. If there are redundant or contradictory options, the last option specified will take precedence. -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3jstatd\fP tool is an RMI server application that monitors for the creation and termination of instrumented HotSpot Java virtual machines (JVMs) and provides a interface to allow remote monitoring tools to attach to JVMs running on the local host. -.LP -.LP -The \f3jstatd\fP server requires the presence of an RMI registry on the local host. The \f3jstatd\fP server will attempt to attach to the RMI registry on the default port, or on the port indicated by the \f2\-p port\fP option. If an RMI registry is not found, one will be created within the \f3jstatd\fP application bound to the port indicated by the \f2\-p port\fP option or to the default RMI registry port if \f2\-p port\fP is omitted. Creation of an internal RMI registry can be inhibited by specifying the \f2\-nr\fP option. -.LP -.LP -\f3NOTE:\fP This utility is unsupported and may or may not be available in future versions of the JDK. It is not currently available on the Windows 98 and Windows ME platforms. -.LP -.SH "OPTIONS" -.LP -.LP -The \f3jstatd\fP command supports the following options: -.LP -.RS 3 -.TP 3 -\-nr -Do not attempt to create an internal RMI registry within the \f2jstatd\fP process when an existing RMI registry is not found. -.TP 3 -\-p\ port -Port number where the RMI registry is expected to be found, or, if not found, created if \f2\-nr\fP is not specified. -.TP 3 -\-n\ rminame -Name to which the remote RMI object is bound in the RMI registry. The default name is \f2JStatRemoteHost\fP. If multiple \f3jstatd\fP servers are started on the same host, the name of the exported RMI object for each server can be made unique by specifying this option. However, doing so will require that the unique server name be included in the monitoring client's \f2hostid\fP and \f2vmid\fP strings. -.TP 3 -\-Joption -Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java. -.RE - -.LP -.SH "SECURITY" -.LP -.LP -The \f3jstatd\fP server can only monitor JVMs for which it has the appropriate native access permissions. Therefor the \f3jstatd\fP process must be running with the same user credentials as the target JVMs. Some user credentials, such as the \f2root\fP user in UNIX(TM) based systems, have permission to access the instrumentation exported by any JVM on the system. A \f3jstatd\fP process running with such credentials can monitor any JVM on the system, but introduces additional security concerns. -.LP -.LP -The \f3jstatd\fP server does not provide any authentication of remote clients. Therefore, running a \f3jstatd\fP server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fP process has access permissions to any user on the network. This exposure may be undesireable in your environment and local security policies should be considered before starting the \f3jstatd\fP process, particularly in production environments or on unsecure networks. -.LP -.LP -The \f3jstatd\fP server installs an instance of RMISecurityPolicy if no other security manager has been installed and therefore requires a security policy file to be specified. The policy file must conform to the default policy implementation's -.na -\f2Policy File Syntax\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html. -.LP -.LP -The following policy file will allow the \f3jstatd\fP server to run without any security exceptions. This policy is less liberal then granting all permissions to all codebases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fP server. -.LP -.nf -\f3 -.fl -grant codebase "file:${java.home}/../lib/tools.jar" {\fP +Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&. +.TP +-p \fIport\fR .br -\f3 -.fl - permission java.security.AllPermission;\fP +The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&. +.TP +-n \fIrminame\fR .br -\f3 -.fl -};\fP +Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&. +.TP +-J\fIoption\fR .br -\f3 -.fl -\fP -.fi - -.LP -.LP -To use this policy, copy the text into a file called \f2jstatd.all.policy\fP and run the \f3jstatd\fP server as follows: -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=jstatd.all.policy\fP -.br -\f3 -.fl -\fP -.fi - -.LP -.LP -For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP addreess spoofing attacks. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fP server and use the \f3jstat\fP and \f3jps\fP tools locally. -.LP -.SH "REMOTE INTERFACE" -.LP -.LP -The interface exported by the \f3jstatd\fP process is proprietary and is guaranteed to change. Users and developers are discouraged from writing to this interface. -.LP -.SH "EXAMPLES" -.LP -.LP -Here are some examples of starting \f3jstatd\fP. Note that the \f3jstatd\fP scripts automatically start the server in the background. -.LP -.SS -Using Internal RMI Registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an internal RMI registry. This example assumes that no other server is bound to the default RMI Registry port (port 1099). -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy -.fl -\fP -.fi - -.LP -.SS -Using External RMI Registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP with a external RMI registry. -.LP -.nf -\f3 -.fl -rmiregistry& -.fl -jstatd \-J\-Djava.security.policy=all.policy -.fl -\fP -.fi - -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an external RMI registry server on port 2020. -.LP -.nf -\f3 -.fl -rmiregistry 2020& -.fl -jstatd \-J\-Djava.security.policy=all.policy \-p 2020 -.fl -\fP -.fi - -.LP -.LP -This example demonstrates starting \f3jstatd\fP with an external RMI registry on port 2020, bound to name AlternateJstatdServerName. -.LP -.nf -\f3 -.fl -rmiregistry 2020& -.fl -jstatd \-J\-Djava.security.policy=all.policy \-p 2020 \-n AlternateJstatdServerName -.fl -\fP -.fi - -.LP -.SS -Inhibiting creation of an in\-process RMI registry -.LP -.LP -This example demonstrates starting \f3jstatd\fP such that it will not create a RMI registry if one is not found. This example assumes an RMI registry is already running. If it is not, an appropriate error message is emitted. -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy \-nr -.fl -\fP -.fi - -.LP -.SS -Enabling RMI logging capabilities. -.LP -.LP -This example demonstrates starting \f3jstatd\fP with RMI logging capabilities enabled. This technique is useful as a troubleshooting aid or for monitoring server activities. -.LP -.nf -\f3 -.fl -jstatd \-J\-Djava.security.policy=all.policy \-J\-Djava.rmi.server.logCalls=true -.fl -\fP -.fi - -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -java(1) \- the Java Application Launcher -.TP 2 -o -jps(1) \- the Java Process Status Application -.TP 2 -o -jstat(1) \- the Java Virtual Machine Statistics Monitoring Tool -.TP 2 -o -.na -\f2rmiregistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry -.RE - -.LP - +Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH SECURITY +The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&. +.PP +The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&. +.PP +The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.PP +The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&. +.sp +.nf +\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP +.fi +.nf +\f3 permission java\&.security\&.AllPermission;\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp +To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows: +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&. +.SH REMOTE\ INTERFACE +The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&. +.SH EXAMPLES +The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background +.SS INTERNAL\ RMI\ REGISTRY +This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXTERNAL\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session with a external RMI registry\&. +.sp +.nf +\f3rmiregistry&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&. +.sp +.nf +\f3jrmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3\fP +.fi +.sp +This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&. +.sp +.nf +\f3rmiregistry 2020&\fP +.fi +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP +.fi +.nf +\f3 \-n AlternateJstatdServerName\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY +This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS ENABLE\ RMI\ LOGGING +This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&. +.sp +.nf +\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP +.fi +.nf +\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +jps(1) +.TP 0.2i +\(bu +jstat(1) +.TP 0.2i +\(bu +rmiregistry(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/keytool.1 b/jdk/src/solaris/doc/sun/man/man1/keytool.1 index 0bf9c79432d..72758893e3a 100644 --- a/jdk/src/solaris/doc/sun/man/man1/keytool.1 +++ b/jdk/src/solaris/doc/sun/man/man1/keytool.1 @@ -1,1767 +1,1300 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH keytool 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 6 August 2013 +.\" SectDesc: Security Tools +.\" Title: keytool.1 +.\" +.if n .pl 99999 +.TH keytool 1 "6 August 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -keytool \- Key and Certificate Management Tool -.LP -.LP -Manages a keystore (database) of cryptographic keys, X.509 certificate chains, and trusted certificates. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3keytool\fP [ commands ] -.fl -.fi +.SH NAME +keytool \- Manages a keystore (database) of cryptographic keys, X\&.509 certificate chains, and trusted certificates\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -The keytool command interface has changed in Java SE 6. See the Changes Section for a detailed description. Note that previously defined commands are still supported. -.LP -.SH "DESCRIPTION" -.LP -\f3keytool\fP is a key and certificate management utility. It allows users to administer their own public/private key pairs and associated certificates for use in self\-authentication (where the user authenticates himself/herself to other users/services) or data integrity and authentication services, using digital signatures. It also allows users to cache the public keys (in the form of certificates) of their communicating peers. -.LP -A \f2certificate\fP is a digitally signed statement from one entity (person, company, etc.), saying that the public key (and some other information) of some other entity has a particular value. (See Certificates.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity. \f2Integrity\fP means that the data has not been modified or tampered with, and \f2authenticity\fP means the data indeed comes from whoever claims to have created and signed it. -.LP -.LP -\f3keytool\fP also enables users to administer secret keys used in symmetric encryption/decryption (e.g. DES). -.LP -.LP -\f3keytool\fP stores the keys and certificates in a \f2keystore\fP. -.LP -.SH "COMMAND AND OPTION NOTES" -.LP -.LP -The various commands and their options are listed and described below. Note: -.LP -.RS 3 -.TP 2 -o -All command and option names are preceded by a minus sign (\-). -.TP 2 -o -The options for each command may be provided in any order. -.TP 2 -o -All items not italicized or in braces or square brackets are required to appear as is. -.TP 2 -o -Braces surrounding an option generally signify that a default value will be used if the option is not specified on the command line. Braces are also used around the \f2\-v\fP, \f2\-rfc\fP, and \f2\-J\fP options, which only have meaning if they appear on the command line (that is, they don't have any "default" values other than not existing). -.TP 2 -o -Brackets surrounding an option signify that the user is prompted for the value(s) if the option is not specified on the command line. (For a \f2\-keypass\fP option, if you do not specify the option on the command line, \f3keytool\fP will first attempt to use the keystore password to recover the private/secret key, and if this fails, will then prompt you for the private/secret key password.) -.TP 2 -o -Items in italics (option values) represent the actual values that must be supplied. For example, here is the format of the \f2\-printcert\fP command: -.nf -\f3 -.fl - keytool \-printcert {\-file \fP\f4cert_file\fP\f3} {\-v} -.fl -\fP -.fi -.LP -When specifying a \f2\-printcert\fP command, replace \f2cert_file\fP with the actual file name, as in: -.nf -\f3 -.fl - keytool \-printcert \-file VScert.cer -.fl -\fP -.fi -.TP 2 -o -Option values must be quoted if they contain a blank (space). -.TP 2 -o -The \f2\-help\fP command is the default. Thus, the command line -.nf -\f3 -.fl - keytool -.fl -\fP -.fi -.LP -is equivalent to -.nf -\f3 -.fl - keytool \-help -.fl -\fP -.fi -.RE +\fBkeytool\fR [\fIcommands\fR] +.fi +.sp +.TP +\fIcommands\fR +See Commands\&. These commands are categorized by task as follows: +.RS +.TP 0.2i +\(bu +Create or Add Data to the Keystore +.RS +.TP 0.2i +\(bu +-gencert +.TP 0.2i +\(bu +-genkeypair +.TP 0.2i +\(bu +-genseckey +.TP 0.2i +\(bu +-importcert +.TP 0.2i +\(bu +-importpassword +.RE -.LP -.SS -Option Defaults -.LP -.LP -Below are the defaults for various option values. -.LP -.nf -\f3 -.fl -\-alias "mykey" -.fl +.TP 0.2i +\(bu +Import Contents From Another Keystore +.RS +.TP 0.2i +\(bu +-importkeystore +.RE -.fl -\-keyalg -.fl - "DSA" (when using \fP\f3\-genkeypair\fP\f3) -.fl - "DES" (when using \fP\f3\-genseckey\fP\f3) -.fl +.TP 0.2i +\(bu +Generate Certificate Request +.RS +.TP 0.2i +\(bu +-certreq +.RE -.fl -\-keysize -.fl - 2048 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "RSA") -.fl - 1024 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "DSA") -.fl - 256 (when using \fP\f3\-genkeypair\fP\f3 and \-keyalg is "EC") -.fl - 56 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DES") -.fl - 168 (when using \fP\f3\-genseckey\fP\f3 and \-keyalg is "DESede") -.fl +.TP 0.2i +\(bu +Export Data +.RS +.TP 0.2i +\(bu +-exportcert +.RE -.fl +.TP 0.2i +\(bu +Display Data +.RS +.TP 0.2i +\(bu +-list +.TP 0.2i +\(bu +-printcert +.TP 0.2i +\(bu +-printcertreq +.TP 0.2i +\(bu +-printcrl +.RE -.fl -\-validity 90 -.fl +.TP 0.2i +\(bu +Manage the Keystore +.RS +.TP 0.2i +\(bu +-storepasswd +.TP 0.2i +\(bu +-keypasswd +.TP 0.2i +\(bu +-delete +.TP 0.2i +\(bu +-changealias +.RE -.fl -\-keystore the file named \fP\f4.keystore\fP\f3 in the user's home directory -.fl +.TP 0.2i +\(bu +Get Help +.RS +.TP 0.2i +\(bu +-help +.RE -.fl -\-storetype the value of the "keystore.type" property in the security properties file, -.fl - which is returned by the static \fP\f4getDefaultType\fP\f3 method in -.fl - \fP\f4java.security.KeyStore\fP\f3 -.fl +.RE -.fl -\-file stdin if reading, stdout if writing -.fl +.SH DESCRIPTION +The \f3keytool\fR command is a key and certificate management utility\&. It enables users to administer their own public/private key pairs and associated certificates for use in self-authentication (where the user authenticates himself or herself to other users and services) or data integrity and authentication services, using digital signatures\&. The \f3keytool\fR command also enables users to cache the public keys (in the form of certificates) of their communicating peers\&. +.PP +A certificate is a digitally signed statement from one entity (person, company, and so on\&.), that says that the public key (and some other information) of some other entity has a particular value\&. (See Certificate\&.) When data is digitally signed, the signature can be verified to check the data integrity and authenticity\&. Integrity means that the data has not been modified or tampered with, and authenticity means the data comes from whoever claims to have created and signed it\&. +.PP +The \f3keytool\fR command also enables users to administer secret keys and passphrases used in symmetric encryption and decryption (DES)\&. +.PP +The \f3keytool\fR command stores the keys and certificates in a keystore\&. See KeyStore aliases\&. +.SH COMMAND\ AND\ OPTION\ NOTES +See Commands for a listing and description of the various commands\&. +.TP 0.2i +\(bu +All command and option names are preceded by a minus sign (-)\&. +.TP 0.2i +\(bu +The options for each command can be provided in any order\&. +.TP 0.2i +\(bu +All items not italicized or in braces or brackets are required to appear as is\&. +.TP 0.2i +\(bu +Braces surrounding an option signify that a default value will be used when the option is not specified on the command line\&. See Option Defaults\&. Braces are also used around the \f3-v\fR, \f3-rfc\fR, and \f3-J\fR options, which only have meaning when they appear on the command line\&. They do not have any default values other than not existing\&. +.TP 0.2i +\(bu +Brackets surrounding an option signify that the user is prompted for the values when the option is not specified on the command line\&. For the \f3-keypass\fR option, if you do not specify the option on the command line, then the \f3keytool\fR command first attempts to use the keystore password to recover the private/secret key\&. If this attempt fails, then the \f3keytool\fR command prompts you for the private/secret key password\&. +.TP 0.2i +\(bu +Items in italics (option values) represent the actual values that must be supplied\&. For example, here is the format of the \f3-printcert\fR command: -.fl -\-protected false -.fl -\fP -.fi +\f3keytool -printcert {-file cert_file} {-v}\fR -.LP -.LP -In generating a public/private key pair, the signature algorithm (\f2\-sigalg\fP option) is derived from the algorithm of the underlying private key: -.LP -.RS 3 -.TP 2 -o -If the underlying private key is of type "DSA", the \f2\-sigalg\fP option defaults to "SHA1withDSA" -.TP 2 -o -If the underlying private key is of type "RSA", the \f2\-sigalg\fP option defaults to "SHA256withRSA". -.TP 2 -o -If the underlying private key is of type "EC", the \f2\-sigalg\fP option defaults to "SHA256withECDSA". -.RE - -.LP -.LP -Please consult the -.na -\f2Java Cryptography Architecture API Specification & Reference\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA for a full list of \f2\-keyalg\fP and \f2\-sigalg\fP you can choose from. -.LP -.SS -Common Options -.LP -.LP -The \f2\-v\fP option can appear for all commands except \f2\-help\fP. If it appears, it signifies "verbose" mode; more information will be provided in the output. -.LP -.LP -There is also a \f2\-J\fP\f2javaoption\fP option that may appear for any command. If it appears, the specified \f2javaoption\fP string is passed through directly to the Java interpreter. This option should not contain any spaces. It is useful for adjusting the execution environment or memory usage. For a list of possible interpreter options, type \f2java \-h\fP or \f2java \-X\fP at the command line. -.LP -.LP -These options may appear for all commands operating on a keystore: -.LP -.RS 3 -.TP 3 -\-storetype storetype -.LP -This qualifier specifies the type of keystore to be instantiated. -.TP 3 -\-keystore keystore -.LP -The keystore location. -.LP -If the JKS storetype is used and a keystore file does not yet exist, then certain \f3keytool\fP commands may result in a new keystore file being created. For example, if \f2keytool \-genkeypair\fP is invoked and the \f2\-keystore\fP option is not specified, the default keystore file named \f2.keystore\fP in the user's home directory will be created if it does not already exist. Similarly, if the \f2\-keystore \fP\f2ks_file\fP option is specified but \f2ks_file\fP does not exist, then it will be created -.LP -Note that the input stream from the \f2\-keystore\fP option is passed to the \f2KeyStore.load\fP method. If \f2NONE\fP is specified as the URL, then a null stream is passed to the \f2KeyStore.load\fP method. \f2NONE\fP should be specified if the \f2KeyStore\fP is not file\-based (for example, if it resides on a hardware token device). -.TP 3 -\-storepass[:env|:file] argument -.LP -The password which is used to protect the integrity of the keystore. -.LP -If the modifier \f2env\fP or \f2file\fP is not specified, then the password has the value \f2argument\fP, which must be at least 6 characters long. Otherwise, the password is retrieved as follows: -.RS 3 -.TP 2 -o -\f2env\fP: Retrieve the password from the environment variable named \f2argument\fP -.TP 2 -o -\f2file\fP: Retrieve the password from the file named \f2argument\fP -.RE -.LP -\f3Note\fP: All other options that require passwords, such as \f2\-keypass\fP, \f2\-srckeypass\fP, \f2\-destkeypass\fP \f2\-srcstorepass\fP, and \f2\-deststorepass\fP, accept the \f2env\fP and \f2file\fP modifiers. (Remember to separate the password option and the modifier with a colon, (\f2:\fP).) -.LP -The password must be provided to all commands that access the keystore contents. For such commands, if a \f2\-storepass\fP option is not provided at the command line, the user is prompted for it. -.LP -When retrieving information from the keystore, the password is optional; if no password is given, the integrity of the retrieved information cannot be checked and a warning is displayed. -.TP 3 -\-providerName provider_name -.LP -Used to identify a cryptographic service provider's name when listed in the security properties file. -.TP 3 -\-providerClass provider_class_name -.LP -Used to specify the name of cryptographic service provider's master class file when the service provider is not listed in the security properties file. -.TP 3 -\-providerArg provider_arg -.LP -Used in conjunction with \f2\-providerClass\fP. Represents an optional string input argument for the constructor of \f2provider_class_name\fP. -.TP 3 -\-protected -.LP -Either \f2true\fP or \f2false\fP. This value should be specified as \f2true\fP if a password must be given via a protected authentication path such as a dedicated PIN reader. -.LP -Note: Since there are two keystores involved in \f2\-importkeystore\fP command, two options, namely, \f2\-srcprotected\fP and \f2\-destprotected\fP are provided for the source keystore and the destination keystore respectively. -.TP 3 -\-ext {name{:critical}{=value}} -.LP -Denotes an X.509 certificate extension. The option can be used in \-genkeypair and \-gencert to embed extensions into the certificate generated, or in \f2\-certreq\fP to show what extensions are requested in the certificate request. The option can appear multiple times. name can be a supported extension name (see below) or an arbitrary OID number. value, if provided, denotes the parameter for the extension; if omitted, denotes the default value (if defined) of the extension or the extension requires no parameter. The \f2:critical\fP modifier, if provided, means the extension's isCritical attribute is true; otherwise, false. You may use \f2:c\fP in place of \f2:critical\fP. -.RE - -.LP -.LP -Currently keytool supports these named extensions (case\-insensitive): -.LP -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +When you specify a \f3-printcert\fR command, replace \f3cert_file\fR with the actual file name, as follows: \f3keytool -printcert -file VScert\&.cer\fR +.TP 0.2i +\(bu +Option values must be put in quotation marks when they contain a blank (space)\&. +.TP 0.2i +\(bu +The \f3-help\fR option is the default\&. The \f3keytool\fR command is the same as \f3keytool -help\fR\&. +.SH OPTION\ DEFAULTS +The following examples show the defaults for various option values\&. +.sp +.nf +\f3\-alias "mykey"\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keyalg\fP +.fi +.nf +\f3 "DSA" (when using \-genkeypair)\fP +.fi +.nf +\f3 "DES" (when using \-genseckey)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keysize\fP +.fi +.nf +\f3 2048 (when using \-genkeypair and \-keyalg is "RSA")\fP +.fi +.nf +\f3 1024 (when using \-genkeypair and \-keyalg is "DSA")\fP +.fi +.nf +\f3 256 (when using \-genkeypair and \-keyalg is "EC")\fP +.fi +.nf +\f3 56 (when using \-genseckey and \-keyalg is "DES")\fP +.fi +.nf +\f3 168 (when using \-genseckey and \-keyalg is "DESede")\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-validity 90\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-keystore <the file named \&.keystore in the user\&'s home directory>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-storetype <the value of the "keystore\&.type" property in the\fP +.fi +.nf +\f3 security properties file, which is returned by the static\fP +.fi +.nf +\f3 getDefaultType method in java\&.security\&.KeyStore>\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-file\fP +.fi +.nf +\f3 stdin (if reading)\fP +.fi +.nf +\f3 stdout (if writing)\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-protected false\fP +.fi +.nf +\f3\fP +.fi +.sp +In generating a public/private key pair, the signature algorithm (\f3-sigalg\fR option) is derived from the algorithm of the underlying private key: +.TP 0.2i +\(bu +If the underlying private key is of type DSA, then the \f3-sigalg\fR option defaults to SHA1withDSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type RSA, then the \f3-sigalg\fR option defaults to SHA256withRSA\&. +.TP 0.2i +\(bu +If the underlying private key is of type EC, then the \f3-sigalg\fR option defaults to SHA256withECDSA\&. +.PP +For a full list of \f3-keyalg\fR and \f3-sigalg\fR arguments, see Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html#AppA +.SH COMMON\ OPTIONS +The \f3-v\fR option can appear for all commands except \f3-help\fR\&. When the \f3-v\fR option appears, it signifies verbose mode, which means that more information is provided in the output\&. +.PP +There is also a \f3-Jjavaoption\fR argument that can appear for any command\&. When the \f3-Jjavaoption\fR appears, the specified \f3javaoption\fR string is passed directly to the Java interpreter\&. This option does not contain any spaces\&. It is useful for adjusting the execution environment or memory usage\&. For a list of possible interpreter options, type \f3java -h\fR or \f3java -X\fR at the command line\&. +.PP +These options can appear for all commands operating on a keystore: +.TP +-storetype \fIstoretype\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -The full form: "ca:{true|false}[,pathlen:<len>]"; or, <len>, a shorthand for "ca:true,pathlen:<len>"; or omitted, means "ca:true" +This qualifier specifies the type of keystore to be instantiated\&. +.TP +-keystore \fIkeystore\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +The keystore location\&. + +If the JKS \f3storetype\fR is used and a keystore file does not yet exist, then certain \f3keytool\fR commands can result in a new keystore file being created\&. For example, if \f3keytool -genkeypair\fR is called and the \f3-keystore\fR option is not specified, the default keystore file named \f3\&.keystore\fR in the user\&'s home directory is created when it does not already exist\&. Similarly, if the \f3-keystore ks_file\fR option is specified but ks_file does not exist, then it is created\&. For more information on the JKS \f3storetype\fR, see the \fIKeyStore Implementation\fR section in KeyStore aliases\&. + +Note that the input stream from the \f3-keystore\fR option is passed to the \f3KeyStore\&.load\fR method\&. If \f3NONE\fR is specified as the URL, then a null stream is passed to the \f3KeyStore\&.load\fR method\&. \f3NONE\fR should be specified if the keystore is not file-based\&. For example, when it resides on a hardware token device\&. +.TP +-storepass[:\fIenv\fR| :\fIfile\fR] argument .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -usage(,usage)*, usage can be one of digitalSignature, nonRepudiation (contentCommitment), keyEncipherment, dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly, decipherOnly. Usage can be abbreviated with the first few letters (say, dig for digitalSignature) or in camel\-case style (say, dS for digitalSignature, cRLS for cRLSign), as long as no ambiguity is found. Usage is case\-insensitive. +The password that is used to protect the integrity of the keystore\&. + +If the modifier \f3env\fR or \f3file\fR is not specified, then the password has the \f3value\fR argument, which must be at least 6 characters long\&. Otherwise, the password is retrieved as follows: +.RS +.TP 0.2i +\(bu +\f3env\fR: Retrieve the password from the environment variable named \f3argument\fR\&. +.TP 0.2i +\(bu +\f3file\fR: Retrieve the password from the file named argument\&. +.RE + + +\fINote:\fR All other options that require passwords, such as \f3-keypass\fR, \f3-srckeypass\fR, -\f3destkeypass\fR, \f3-srcstorepass\fR, and \f3-deststorepass\fR, accept the \fIenv\fR and \fIfile\fR modifiers\&. Remember to separate the password option and the modifier with a colon (:)\&. + +The password must be provided to all commands that access the keystore contents\&. For such commands, when the \f3-storepass\fR option is not provided at the command line, the user is prompted for it\&. + +When retrieving information from the keystore, the password is optional\&. If no password is specified, then the integrity of the retrieved information cannot be verified and a warning is displayed\&. +.TP +-providerName \fIprovider_name\fR .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +Used to identify a cryptographic service provider\&'s name when listed in the security properties file\&. +.TP +-providerClass \fIprovider_class_name\fR .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -usage(,usage)*, usage can be one of anyExtendedKeyUsage, serverAuth, clientAuth, codeSigning, emailProtection, timeStamping, OCSPSigning, or any OID string. Named usage can be abbreviated with the first few letters or in camel\-case style, as long as no ambiguity is found. Usage is case\-insensitive. +Used to specify the name of a cryptographic service provider\&'s master class file when the service provider is not listed in the security properties file\&. +.TP +-providerArg \fIprovider_arg\fR .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 +Used with the \f3-providerClass\fR option to represent an optional string input argument for the constructor of \f3provider_class_name\fR\&. +.TP +-protected .br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +Either \f3true\fR or \f3false\fR\&. This value should be specified as \f3true\fR when a password must be specified by way of a protected authentication path such as a dedicated PIN reader\&.Because there are two keystores involved in the \f3-importkeystore\fR command, the following two options \f3-srcprotected\fR and -\f3destprotected\fR are provided for the source keystore and the destination keystore respectively\&. +.TP +-ext \fI{name{:critical} {=value}}\fR +.br +Denotes an X\&.509 certificate extension\&. The option can be used in \f3-genkeypair\fR and \f3-gencert\fR to embed extensions into the certificate generated, or in \f3-certreq\fR to show what extensions are requested in the certificate request\&. The option can appear multiple times\&. The \f3name\fR argument can be a supported extension name (see Named Extensions) or an arbitrary OID number\&. The \f3value\fR argument, when provided, denotes the argument for the extension\&. When \fIvalue\fR is omitted, that means that the default value of the extension or the extension requires no argument\&. The \f3:critical\fR modifier, when provided, means the extension\&'s \f3isCritical\fR attribute is \f3true\fR; otherwise, it is \f3false\fR\&. You can use \f3:c\fR in place of \f3:critical\fR\&. +.SH NAMED\ EXTENSIONS +The \f3keytool\fR command supports these named extensions\&. The names are not case-sensitive)\&. +.TP +BC or BasicContraints +\fIValues\fR: The full form is: \f3ca:{true|false}[,pathlen:<len>]\fR or \f3<len>\fR, which is short for \f3ca:true,pathlen:<len>\fR\&. When <\f3len\fR> is omitted, you have \f3ca:true\fR\&. +.TP +KU or KeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3digitalSignature\fR, \f3nonRepudiation\fR (contentCommitment), \f3keyEncipherment\fR, \f3dataEncipherment\fR, \f3keyAgreement\fR, \f3keyCertSign\fR, \f3cRLSign\fR, \f3encipherOnly\fR, \f3decipherOnly\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters (\f3dig\fR for \f3digitalSignature\fR) or in camel-case style (\f3dS\fR for \f3digitalSignature\fR or \f3cRLS\fR for \f3cRLSign\fR), as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP +EKU or ExtendedKeyUsage +\fIValues\fR: \f3usage\fR(,\f3usage\fR)*, where \fIusage\fR can be one of \f3anyExtendedKeyUsage\fR, \f3serverAuth\fR, \f3clientAuth\fR, \f3codeSigning\fR, \f3emailProtection\fR, \f3timeStamping\fR, \f3OCSPSigning\fR, or any \fIOID string\fR\&. The \fIusage\fR argument can be abbreviated with the first few letters or in camel-case style, as long as no ambiguity is found\&. The \f3usage\fR values are case-sensitive\&. +.TP SAN or SubjectAlternativeName -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -type:value(,type:value)*, type can be EMAIL, URI, DNS, IP, or OID, value is the string format value for the type. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +\fIValues\fR: \f3type\fR:\f3value\fR(,t\f3ype:value\fR)*, where \f3type\fR can be \f3EMAIL\fR, \f3URI\fR, \f3DNS\fR, \f3IP\fR, or \f3OID\fR\&. The \f3value\fR argument is the string format value for the \f3type\fR\&. +.TP IAN or IssuerAlternativeName -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -same as SubjectAlternativeName -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -method:location\-type:location\-value (,method:location\-type:location\-value)*, method can be "timeStamping", "caRepository" or any OID. location\-type and location\-value can be any type:value supported by the SubjectAlternativeName extension. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 +\fIValues\fR: Same as \f3SubjectAlternativeName\fR\&. +.TP +SIA or SubjectInfoAccess +\fIValues\fR: \f3method\fR:\f3location-type\fR:\f3location-value\fR (,\f3method:location-type\fR:\f3location-value\fR)*, where \f3method\fR can be \f3timeStamping\fR, \f3caRepository\fR or any OID\&. The \f3location-type\fR and \f3location-value\fR arguments can be any \f3type\fR:\f3value\fR supported by the \f3SubjectAlternativeName\fR extension\&. +.TP AIA or AuthorityInfoAccess +\fIValues\fR: Same as \f3SubjectInfoAccess\fR\&. The \f3method\fR argument can be \f3ocsp\fR,\f3caIssuers\fR, or any OID\&. +.PP +When \f3name\fR is OID, the value is the hexadecimal dumped DER encoding of the \f3extnValue\fR for the extension excluding the OCTET STRING type and length bytes\&. Any extra character other than standard hexadecimal numbers (0-9, a-f, A-F) are ignored in the HEX string\&. Therefore, both 01:02:03:04 and 01020304 are accepted as identical values\&. When there is no value, the extension has an empty value field\&. +.PP +A special name \f3honored\fR, used in \f3-gencert\fR only, denotes how the extensions included in the certificate request should be honored\&. The value for this name is a comma separated list of \f3all\fR (all requested extensions are honored), \f3name{:[critical|non-critical]}\fR (the named extension is honored, but using a different \f3isCritical\fR attribute) and \f3-name\fR (used with \f3all\fR, denotes an exception)\&. Requested extensions are not honored by default\&. +.PP +If, besides the\f3-ext honored\fR option, another named or OID \f3-ext\fR option is provided, this extension is added to those already honored\&. However, if this name (or OID) also appears in the honored value, then its value and criticality overrides the one in the request\&. +.PP +The \f3subjectKeyIdentifier\fR extension is always created\&. For non-self-signed certificates, the \f3authorityKeyIdentifier\fR is created\&. +.PP +\fINote:\fR Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard\&. See Certificate Conformance Warning\&. +.SH COMMANDS +.TP +-gencert .br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 +\f3{-rfc} {-infile infile} {-outfile outfile} {-alias alias} {-sigalg sigalg} {-dname dname} {-startdate startdate {-ext ext}* {-validity valDays} [-keypass keypass] {-keystore keystore} [-storepass storepass] {-storetype storetype} {-providername provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Generates a certificate as a response to a certificate request file (which can be created by the \f3keytool\fR\f3-certreq\fR command)\&. The command reads the request from \fIinfile\fR (if omitted, from the standard input), signs it using alias\&'s private key, and outputs the X\&.509 certificate into \fIoutfile\fR (if omitted, to the standard output)\&. When\f3-rfc\fR is specified, the output format is Base64-encoded PEM; otherwise, a binary DER is created\&. + +The \f3sigalg\fR value specifies the algorithm that should be used to sign the certificate\&. The \f3startdate\fR argument is the start time and date that the certificate is valid\&. The \f3valDays\fR argument tells the number of days for which the certificate should be considered valid\&. + +When \f3dname\fR is provided, it is used as the subject of the generated certificate\&. Otherwise, the one from the certificate request is used\&. + +The \f3ext\fR value shows what X\&.509 extensions will be embedded in the certificate\&. Read Common Options for the grammar of \f3-ext\fR\&. + +The \f3-gencert\fR option enables you to create certificate chains\&. The following example creates a certificate, \f3e1\fR, that contains three certificates in its certificate chain\&. + +The following commands creates four key pairs named \f3ca\fR, \f3ca1\fR, \f3ca2\fR, and \f3e1\fR: +.sp +.nf +\f3keytool \-alias ca \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca1 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias ca2 \-dname CN=CA \-genkeypair\fP +.fi +.nf +\f3keytool \-alias e1 \-dname CN=E1 \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following two commands create a chain of signed certificates; \f3ca\fR signs \f3ca1\fR and \f3ca1\fR signs \f3ca2\fR, all of which are self-issued: +.sp +.nf +\f3keytool \-alias ca1 \-certreq |\fP +.fi +.nf +\f3 keytool \-alias ca \-gencert \-ext san=dns:ca1 |\fP +.fi +.nf +\f3 keytool \-alias ca1 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-alias ca2 \-certreq |\fP +.fi +.nf +\f3 $KT \-alias ca1 \-gencert \-ext san=dns:ca2 |\fP +.fi +.nf +\f3 $KT \-alias ca2 \-importcert\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The following command creates the certificate \f3e1\fR and stores it in the file \f3e1\&.cert\fR, which is signed by \f3ca2\fR\&. As a result, \f3e1\fR should contain \f3ca\fR, \f3ca1\fR, and \f3ca2\fR in its certificate chain: +.sp +.nf +\f3keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1\&.cert\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-genkeypair .br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -same as SubjectInfoAccess. method can be "ocsp","caIssuers" or any OID. +\f3{-alias alias} {-keyalg keyalg} {-keysize keysize} {-sigalg sigalg} [-dname dname] [-keypass keypass] {-startdate value} {-ext ext}* {-validity valDays} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Generates a key pair (a public key and associated private key)\&. Wraps the public key into an X\&.509 v3 self-signed certificate, which is stored as a single-element certificate chain\&. This certificate chain and the private key are stored in a new keystore entry identified by alias\&. + +The \f3keyalg\fR value specifies the algorithm to be used to generate the key pair, and the \f3keysize\fR value specifies the size of each key to be generated\&. The \f3sigalg\fR value specifies the algorithm that should be used to sign the self-signed certificate\&. This algorithm must be compatible with the \f3keyalg\fR value\&. + +The \f3dname\fR value specifies the X\&.500 Distinguished Name to be associated with the value of \f3alias\fR, and is used as the issuer and subject fields in the self-signed certificate\&. If no distinguished name is provided at the command line, then the user is prompted for one\&. + +The value of \f3keypass\fR is a password used to protect the private key of the generated key pair\&. If no password is provided, then the user is prompted for it\&. If you press \fIthe Return key\fR at the prompt, then the key password is set to the same password as the keystore password\&. The \f3keypass\fR value must be at least 6 characters\&. + +The value of \f3startdate\fR specifies the issue time of the certificate, also known as the "Not Before" value of the X\&.509 certificate\&'s Validity field\&. + +The option value can be set in one of these two forms: + +\f3([+-]nnn[ymdHMS])+\fR + +\f3[yyyy/mm/dd] [HH:MM:SS]\fR + +With the first form, the issue time is shifted by the specified value from the current time\&. The value is a concatenation of a sequence of subvalues\&. Inside each subvalue, the plus sign (+) means shift forward, and the minus sign (-) means shift backward\&. The time to be shifted is \f3nnn\fR units of years, months, days, hours, minutes, or seconds (denoted by a single character of \f3y\fR, \f3m\fR, \f3d\fR, \f3H\fR, \f3M\fR, or \f3S\fR respectively)\&. The exact value of the issue time is calculated using the \f3java\&.util\&.GregorianCalendar\&.add(int field, int amount)\fR method on each subvalue, from left to right\&. For example, by specifying, the issue time will be: +.sp +.nf +\f3Calendar c = new GregorianCalendar();\fP +.fi +.nf +\f3c\&.add(Calendar\&.YEAR, \-1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.MONTH, 1);\fP +.fi +.nf +\f3c\&.add(Calendar\&.DATE, \-1);\fP +.fi +.nf +\f3return c\&.getTime()\fP +.fi +.nf +\f3\fP +.fi +.sp + + +With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone)\&. The user can provide only one part, which means the other part is the same as the current date (or time)\&. The user must provide the exact number of digits as shown in the format definition (padding with 0 when shorter)\&. When both the date and time are provided, there is one (and only one) space character between the two parts\&. The hour should always be provided in 24 hour format\&. + +When the option is not provided, the start date is the current time\&. The option can be provided at most once\&. + +The value of \f3valDays\fR specifies the number of days (starting at the date specified by \f3-startdate\fR, or the current date when \f3-startdate\fR is not specified) for which the certificate should be considered valid\&. + +This command was named \f3-genkey\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-genkeypair\fR, is preferred going forward\&. +.TP +-genseckey .br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Name\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wBC or BasicConstraints -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wKU or KeyUsage -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wEKU or ExtendedkeyUsage -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \wSIA or SubjectInfoAccess -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(f- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(i- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Value\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 319 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Name\fP\h'|\n(41u'\f3Value\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'BC or BasicConstraints\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'KU or KeyUsage\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'EKU or ExtendedkeyUsage\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.ne \n(g|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'SIA or SubjectInfoAccess\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.ne \n(j|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-38 +\f3-genseckey {-alias alias} {-keyalg keyalg} {-keysize keysize} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -For name as OID, value is the HEX dumped DER encoding of the extnValue for the extension excluding the OCTET STRING type and length bytes. Any extra character other than standard HEX numbers (0\-9, a\-f, A\-F) are ignored in the HEX string. Therefore, both \f2"01:02:03:04"\fP and \f2"01020304"\fP are accepted as identical values. If there's no value, the extension has an empty value field then. -.LP -.LP -A special name \f2'honored'\fP, used in \f2\-gencert\fP only, denotes how the extensions included in the certificate request should be honored. The value for this name is a comma separated list of \f2"all"\fP (all requested extensions are honored), \f2"name{:[critical|non\-critical]}"\fP (the named extension is honored, but using a different isCritical attribute) and \f2"\-name"\fP (used with all, denotes an exception). Requested extensions are not honored by default. -.LP -.LP -If, besides the \-ext honored option, another named or OID \-ext option is provided, this extension will be added to those already honored. However, if this name (or OID) also appears in the honored value, its value and criticality overrides the one in the request. -.LP -.LP -The subjectKeyIdentifier extension is always created. For non self\-signed certificates, the authorityKeyIdentifier is always created. -.LP -.LP -\f3Note:\fP Users should be aware that some combinations of extensions (and other certificate fields) may not conform to the Internet standard. See Warning Regarding Certificate Conformance for details. -.LP -.SH "COMMANDS" -.LP -.SS -Creating or Adding Data to the Keystore -.LP -.RS 3 -.TP 3 -\-gencert {\-rfc} {\-infile infile} {\-outfile outfile} {\-alias alias} {\-sigalg sigalg} {\-dname dname} {\-startdate startdate {\-ext ext}* {\-validity valDays} [\-keypass keypass] {\-keystore keystore} [\-storepass storepass] {\-storetype storetype} {\-providername provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a certificate as a response to a certificate request file (which can be created by the \f2keytool \-certreq\fP command). The command reads the request from \f2infile\fP (if omitted, from the standard input), signs it using alias's private key, and output the X.509 certificate into \f2outfile\fP (if omitted, to the standard output). If \f2\-rfc\fP is specified, output format is BASE64\-encoded PEM; otherwise, a binary DER is created. -.LP -\f2sigalg\fP specifies the algorithm that should be used to sign the certificate. \f2startdate\fP is the start time/date that the certificate is valid. \f2valDays\fP tells the number of days for which the certificate should be considered valid. -.LP -If \f2dname\fP is provided, it's used as the subject of the generated certificate. Otherwise, the one from the certificate request is used. -.LP -\f2ext\fP shows what X.509 extensions will be embedded in the certificate. Read Common Options for the grammar of \f2\-ext\fP. -.LP -The \f2\-gencert\fP command enables you to create certificate chains. The following example creates a certificate, \f2e1\fP, that contains three certificates in its certificate chain. -.LP -The following commands creates four key pairs named \f2ca\fP, \f2ca1\fP, \f2ca2\fP, and \f2e1\fP: -.nf -\f3 -.fl -keytool \-alias ca \-dname CN=CA \-genkeypair -.fl -keytool \-alias ca1 \-dname CN=CA \-genkeypair -.fl -keytool \-alias ca2 \-dname CN=CA \-genkeypair -.fl -keytool \-alias e1 \-dname CN=E1 \-genkeypair -.fl -\fP -.fi -.LP -The following two commands create a chain of signed certificates; \f2ca\fP signs ca1 and \f2ca1 signs ca2\fP, all of which are self\-issued: -.nf -\f3 -.fl -keytool \-alias ca1 \-certreq | keytool \-alias ca \-gencert \-ext san=dns:ca1 | keytool \-alias ca1 \-importcert -.fl -keytool \-alias ca2 \-certreq | $KT \-alias ca1 \-gencert \-ext san=dns:ca2 | $KT \-alias ca2 \-importcert -.fl -\fP -.fi -.LP -The following command creates the certificate \f2e1\fP and stores it in the file \f2e1.cert\fP, which is signed by \f2ca2\fP. As a result, \f2e1\fP should contain \f2ca\fP, \f2ca1\fP, and \f2ca2\fP in its certificate chain: -.nf -\f3 -.fl -keytool \-alias e1 \-certreq | keytool \-alias ca2 \-gencert > e1.cert -.fl -\fP -.fi -.TP 3 -\-genkeypair {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} {\-sigalg sigalg} [\-dname dname] [\-keypass keypass] {\-startdate value} {\-ext ext}* {\-validity valDays} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a key pair (a public key and associated private key). Wraps the public key into an X.509 v3 self\-signed certificate, which is stored as a single\-element certificate chain. This certificate chain and the private key are stored in a new keystore entry identified by \f2alias\fP. -.LP -\f2keyalg\fP specifies the algorithm to be used to generate the key pair, and \f2keysize\fP specifies the size of each key to be generated. \f2sigalg\fP specifies the algorithm that should be used to sign the self\-signed certificate; this algorithm must be compatible with \f2keyalg\fP. -.LP -\f2dname\fP specifies the X.500 Distinguished Name to be associated with \f2alias\fP, and is used as the \f2issuer\fP and \f2subject\fP fields in the self\-signed certificate. If no distinguished name is provided at the command line, the user will be prompted for one. -.LP -\f2keypass\fP is a password used to protect the private key of the generated key pair. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long. -.LP -\f2startdate\fP specifies the issue time of the certificate, also known as the "Not Before" value of the X.509 certificate's Validity field. -.LP -The option value can be set in one of these two forms: -.RS 3 -.TP 3 -1. -([+\-]\f2nnn\fP[ymdHMS])+ -.TP 3 -2. -[yyyy/mm/dd] [HH:MM:SS] -.RE -.LP -With the first form, the issue time is shifted by the specified value from the current time. The value is a concatenation of a sequence of sub values. Inside each sub value, the plus sign ("+") means shifting forward, and the minus sign ("\-") means shifting backward. The time to be shifted is \f2nnn\fP units of years, months, days, hours, minutes, or seconds (denoted by a single character of "y", "m", "d", "H", "M", or "S" respectively). The exact value of the issue time is calculated using the \f2java.util.GregorianCalendar.add(int field, int amount)\fP method on each sub value, from left to right. For example, by specifying \f2"\-startdate \-1y+1m\-1d"\fP, the issue time will be: -.nf -\f3 -.fl - Calendar c = new GregorianCalendar(); -.fl - c.add(Calendar.YEAR, \-1); -.fl - c.add(Calendar.MONTH, 1); -.fl - c.add(Calendar.DATE, \-1); -.fl - return c.getTime() -.fl -\fP -.fi -.LP -With the second form, the user sets the exact issue time in two parts, year/month/day and hour:minute:second (using the local time zone). The user may provide only one part, which means the other part is the same as the current date (or time). User must provide the exact number of digits as shown in the format definition (padding with 0 if shorter). When both the date and time are provided, there is one (and only one) space character between the two parts. The hour should always be provided in 24 hour format. -.LP -When the option is not provided, the start date is the current time. The option can be provided at most once. -.LP -\f2valDays\fP specifies the number of days (starting at the date specified by \f2\-startdate\fP, or the current date if \f2\-startdate\fP is not specified) for which the certificate should be considered valid. -.LP -This command was named \f2\-genkey\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarity the new name, \f2\-genkeypair\fP, is preferred going forward. -.TP 3 -\-genseckey {\-alias alias} {\-keyalg keyalg} {\-keysize keysize} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a secret key and stores it in a new \f2KeyStore.SecretKeyEntry\fP identified by \f2alias\fP. -.LP -\f2keyalg\fP specifies the algorithm to be used to generate the secret key, and \f2keysize\fP specifies the size of the key to be generated. \f2keypass\fP is a password used to protect the secret key. If no password is provided, the user is prompted for it. If you press RETURN at the prompt, the key password is set to the same password as that used for the keystore. \f2keypass\fP must be at least 6 characters long. -.TP 3 -\-importcert {\-alias alias} {\-file cert_file} [\-keypass keypass] {\-noprompt} {\-trustcacerts} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X.509 certificates) from the file \f2cert_file\fP, and stores it in the keystore entry identified by \f2alias\fP. If no file is given, the certificate or certificate chain is read from stdin. -.LP -\f3keytool\fP can import X.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type. The data to be imported must be provided either in binary encoding format, or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard. In the latter case, the encoding must be bounded at the beginning by a string that starts with "\-\-\-\-\-BEGIN", and bounded at the end by a string that starts with "\-\-\-\-\-END". -.LP -You import a certificate for two reasons: -.RS 3 -.TP 3 -1. -to add it to the list of trusted certificates, or -.TP 3 -2. -to import a certificate reply received from a CA as the result of submitting a Certificate Signing Request (see the \-certreq command) to that CA. -.RE -.LP -Which type of import is intended is indicated by the value of the \f2\-alias\fP option: -.RS 3 -.TP 3 -1. -\f3If the alias does not point to a key entry\fP, then \f3keytool\fP assumes you are adding a trusted certificate entry. In this case, the alias should not already exist in the keystore. If the alias does already exist, then \f3keytool\fP outputs an error, since there is already a trusted certificate for that alias, and does not import the certificate. -.TP 3 -2. -\f3If the alias points to a key entry\fP, then \f3keytool\fP assumes you are importing a certificate reply. -.RE -\f3Importing a New Trusted Certificate\fP -.LP -Before adding the certificate to the keystore, \f3keytool\fP tries to verify it by attempting to construct a chain of trust from that certificate to a self\-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore. -.LP -If the \f2\-trustcacerts\fP option has been specified, additional certificates are considered for the chain of trust, namely the certificates in a file named "cacerts". -.LP -If \f3keytool\fP fails to establish a trust path from the certificate to be imported up to a self\-signed certificate (either from the keystore or the "cacerts" file), the certificate information is printed out, and the user is prompted to verify it, e.g., by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner himself/herself. Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! \-\- see WARNING Regarding Importing Trusted Certificates. The user then has the option of aborting the import operation. If the \f2\-noprompt\fP option is given, however, there will be no interaction with the user. -\f3Importing a Certificate Reply\fP -.LP -When importing a certificate reply, the certificate reply is validated using trusted certificates from the keystore, and optionally using the certificates configured in the "cacerts" keystore file (if the \f2\-trustcacerts\fP option was specified). -.LP -The methods of determining whether the certificate reply is trusted are described in the following: -.RS 3 -.TP 2 -o -\f3If the reply is a single X.509 certificate\fP, \f3keytool\fP attempts to establish a trust chain, starting at the certificate reply and ending at a self\-signed certificate (belonging to a root CA). The certificate reply and the hierarchy of certificates used to authenticate the certificate reply form the new certificate chain of \f2alias\fP. If a trust chain cannot be established, the certificate reply is not imported. In this case, \f3keytool\fP does not print out the certificate and prompt the user to verify it, because it is very hard (if not impossible) for a user to determine the authenticity of the certificate reply. -.TP 2 -o -\f3If the reply is a PKCS#7 formatted certificate chain or a sequence of X.509 certificates\fP, the chain is ordered with the user certificate first followed by zero or more CA certificates. If the chain ends with a self\-signed root CA certificate and \f2\-trustcacerts\fP option was specified, \f3keytool\fP will attempt to match it with any of the trusted certificates in the keystore or the "cacerts" keystore file. If the chain does not end with a self\-signed root CA certificate and the \f2\-trustcacerts\fP option was specified, \f3keytool\fP will try to find one from the trusted certificates in the keystore or the "cacerts" keystore file and add it to the end of the chain. If the certificate is not found and \f2\-noprompt\fP option is not specified, the information of the last certificate in the chain is printed out, and the user is prompted to verify it. -.RE -.LP -If the public key in the certificate reply matches the user's public key already stored with under \f2alias\fP, the old certificate chain is replaced with the new certificate chain in the reply. The old chain can only be replaced if a valid \f2keypass\fP, the password used to protect the private key of the entry, is supplied. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it. -.LP -This command was named \f2\-import\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-importcert\fP, is preferred going forward. -.TP 3 -\-importkeystore \-srckeystore srckeystore \-destkeystore destkeystore {\-srcstoretype srcstoretype} {\-deststoretype deststoretype} [\-srcstorepass srcstorepass] [\-deststorepass deststorepass] {\-srcprotected} {\-destprotected} {\-srcalias srcalias {\-destalias destalias} [\-srckeypass srckeypass] [\-destkeypass destkeypass] } {\-noprompt} {\-srcProviderName src_provider_name} {\-destProviderName dest_provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Imports a single entry or all entries from a source keystore to a destination keystore. -.LP -When the \f2srcalias\fP option is provided, the command imports the single entry identified by the alias to the destination keystore. If a destination alias is not provided with \f2destalias\fP, then \f2srcalias\fP is used as the destination alias. If the source entry is protected by a password, \f2srckeypass\fP will be used to recover the entry. If \f2srckeypass\fP is not provided, then \f3keytool\fP will attempt to use \f2srcstorepass\fP to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. The destination entry will be protected using \f2destkeypass\fP. If \f2destkeypass\fP is not provided, the destination entry will be protected with the source entry password. -.LP -If the \f2srcalias\fP option is not provided, then all entries in the source keystore are imported into the destination keystore. Each destination entry will be stored under the alias from the source entry. If the source entry is protected by a password, \f2srcstorepass\fP will be used to recover the entry. If \f2srcstorepass\fP is either not provided or is incorrect, the user will be prompted for a password. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, the user will be prompted whether to skip the entry and continue, or to quit. The destination entry will be protected with the source entry password. -.LP -If the destination alias already exists in the destination keystore, the user is prompted to either overwrite the entry, or to create a new entry under a different alias name. -.LP -Note that if \f2\-noprompt\fP is provided, the user will not be prompted for a new destination alias. Existing entries will automatically be overwritten with the destination alias name. Finally, entries that can not be imported are automatically skipped and a warning is output. -.TP 3 -\-printcertreq {\-file file} -.LP -Prints the content of a PKCS #10 format certificate request, which can be generated by the keytool \-certreq command. The command reads the request from file; if omitted, from the standard input. -.RE +Generates a secret key and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. -.LP -.SS -Exporting Data -.LP -.RS 3 -.TP 3 -\-certreq {\-alias alias} {\-dname dname} {\-sigalg sigalg} {\-file certreq_file} [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Generates a Certificate Signing Request (CSR), using the PKCS#10 format. -.LP -A CSR is intended to be sent to a certificate authority (CA). The CA will authenticate the certificate requestor (usually off\-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self\-signed certificate) in the keystore. -.LP -The private key associated with \f2alias\fP is used to create the PKCS#10 certificate request. In order to access the private key, the appropriate password must be provided, since private keys are protected in the keystore with a password. If \f2keypass\fP is not provided at the command line, and is different from the password used to protect the integrity of the keystore, the user is prompted for it. If dname is provided, it's used as the subject in the CSR. Otherwise, the X.500 Distinguished Name associated with alias is used. -.LP -\f2sigalg\fP specifies the algorithm that should be used to sign the CSR. -.LP -The CSR is stored in the file \f2certreq_file\fP. If no file is given, the CSR is output to stdout. -.LP -Use the \f2importcert\fP command to import the response from the CA. -.TP 3 -\-exportcert {\-alias alias} {\-file cert_file} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-rfc} {\-v} {\-protected} {\-Jjavaoption} -.LP -Reads (from the keystore) the certificate associated with \f2alias\fP, and stores it in the file \f2cert_file\fP. -.LP -If no file is given, the certificate is output to stdout. -.LP -The certificate is by default output in binary encoding, but will instead be output in the printable encoding format, as defined by the Internet RFC 1421 standard, if the \f2\-rfc\fP option is specified. -.LP -If \f2alias\fP refers to a trusted certificate, that certificate is output. Otherwise, \f2alias\fP refers to a key entry with an associated certificate chain. In that case, the first certificate in the chain is returned. This certificate authenticates the public key of the entity addressed by \f2alias\fP. -.LP -This command was named \f2\-export\fP in previous releases. This old name is still supported in this release and will be supported in future releases, but for clarify the new name, \f2\-exportcert\fP, is preferred going forward. -.RE +The value of \f3keyalg\fR specifies the algorithm to be used to generate the secret key, and the value of \f3keysize\fR specifies the size of the key to be generated\&. The \f3keypass\fR value is a password that protects the secret key\&. If no password is provided, then the user is prompted for it\&. If you press the Return key at the prompt, then the key password is set to the same password that is used for the \f3keystore\fR\&. The \f3keypass\fR value must be at least 6 characters\&. +.TP +-importcert +.br +\f3-importcert {-alias alias} {-file cert_file} [-keypass keypass] {-noprompt} {-trustcacerts} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.SS -Displaying Data -.LP -.RS 3 -.TP 3 -\-list {\-alias alias} {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v | \-rfc} {\-protected} {\-Jjavaoption} -.LP -Prints (to stdout) the contents of the keystore entry identified by \f2alias\fP. If no alias is specified, the contents of the entire keystore are printed. -.LP -This command by default prints the SHA1 fingerprint of a certificate. If the \f2\-v\fP option is specified, the certificate is printed in human\-readable format, with additional information such as the owner, issuer, serial number, and any extensions. If the \f2\-rfc\fP option is specified, certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 standard -.LP -You cannot specify both \f2\-v\fP and \f2\-rfc\fP. -.TP 3 -\-printcert {\-file cert_file | \-sslserver host[:port]} {\-jarfile JAR_file {\-rfc} {\-v} {\-Jjavaoption} -.LP -Reads the certificate from the file \f2cert_file\fP, the SSL server located at \f2host:port\fP, or the signed JAR file \f2JAR_file\fP (with the option \f2\-jarfile\fP and prints its contents in a human\-readable format. When no port is specified, the standard HTTPS port 443 is assumed. Note that \f2\-sslserver\fP and \f2\-file\fP options cannot be provided at the same time. Otherwise, an error is reported. If neither option is given, the certificate is read from stdin. -.LP -If \f2\-rfc\fP is specified, keytool prints the certificate in PEM mode as defined by the Internet RFC 1421 standard. -.LP -If the certificate is read from a file or stdin, it may be either binary encoded or in printable encoding format, as defined by the Internet RFC 1421 standard -.LP -If the SSL server is behind a firewall, \f2\-J\-Dhttps.proxyHost=proxyhost\fP and \f2\-J\-Dhttps.proxyPort=proxyport\fP can be specified on the command line for proxy tunneling. See the -.na -\f2JSSE Reference Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html for more information. -.LP -\f3Note\fP: This option can be used independently of a keystore. -.TP 3 -\-printcrl \-file crl_ {\-v} -.LP -Reads the certificate revocation list (CRL) from the file \f2crl_file\fP. -.LP -A Certificate Revocation List (CRL) is a list of digital certificates which have been revoked by the Certificate Authority (CA) that issued them. The CA generates \f2crl_file\fP. -.LP -\f3Note\fP: This option can be used independently of a keystore. -.RE +Reads the certificate or certificate chain (where the latter is supplied in a PKCS#7 formatted reply or a sequence of X\&.509 certificates) from the file \f3cert_file\fR, and stores it in the \f3keystore\fR entry identified by \f3alias\fR\&. If no file is specified, then the certificate or certificate chain is read from \f3stdin\fR\&. -.LP -.SS -Managing the Keystore -.LP -.RS 3 -.TP 3 -\-storepasswd [\-new new_storepass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption} -.LP -Changes the password used to protect the integrity of the keystore contents. The new password is \f2new_storepass\fP, which must be at least 6 characters long. -.TP 3 -\-keypasswd {\-alias alias} [\-keypass old_keypass] [\-new new_keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-Jjavaoption} -.LP -Changes the password under which the private/secret key identified by \f2alias\fP is protected, from \f2old_keypass\fP to \f2new_keypass\fP, which must be at least 6 characters long. -.LP -If the \f2\-keypass\fP option is not provided at the command line, and the key password is different from the keystore password, the user is prompted for it. -.LP -If the \f2\-new\fP option is not provided at the command line, the user is prompted for it. -.TP 3 -\-delete [\-alias alias] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Deletes from the keystore the entry identified by \f2alias\fP. The user is prompted for the alias, if no alias is provided at the command line. -.TP 3 -\-changealias {\-alias alias} [\-destalias destalias] [\-keypass keypass] {\-storetype storetype} {\-keystore keystore} [\-storepass storepass] {\-providerName provider_name} {\-providerClass provider_class_name {\-providerArg provider_arg}} {\-v} {\-protected} {\-Jjavaoption} -.LP -Move an existing keystore entry from the specified \f2alias\fP to a new alias, \f2destalias\fP. If no destination alias is provided, the command will prompt for one. If the original entry is protected with an entry password, the password can be supplied via the "\-keypass" option. If no key password is provided, the \f2storepass\fP (if given) will be attempted first. If that attempt fails, the user will be prompted for a password. -.RE +The \f3keytool\fR command can import X\&.509 v1, v2, and v3 certificates, and PKCS#7 formatted certificate chains consisting of certificates of that type\&. The data to be imported must be provided either in binary encoding format or in printable encoding format (also known as Base64 encoding) as defined by the Internet RFC 1421 standard\&. In the latter case, the encoding must be bounded at the beginning by a string that starts with \f3-\fR\f3----BEGIN\fR, and bounded at the end by a string that starts with \f3-----END\fR\&. -.LP -.SS -Getting Help -.LP -.RS 3 -.TP 3 -\-help -.LP -Lists the basic commands and their options. -.LP -For more information about a specific command, enter the following, where \f2command_name\fP is the name of the command: -.nf -\f3 -.fl - keytool \-\fP\f4command_name\fP\f3 \-help -.fl -\fP -.fi -.RE +You import a certificate for two reasons: To add it to the list of trusted certificates, and to import a certificate reply received from a certificate authority (CA) as the result of submitting a Certificate Signing Request to that CA (see the \f3-certreq\fR option in Commands)\&. -.LP -.SH "EXAMPLES" -.LP -.LP -Suppose you want to create a keystore for managing your public/private key pair and certificates from entities you trust. -.LP -.SS -Generating Your Key Pair -.LP -.LP -The first thing you need to do is create a keystore and generate the key pair. You could use a command such as the following: -.LP -.nf -\f3 -.fl - keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US" -.fl - \-alias business \-keypass \fP\f4<new password for private key>\fP\f3 \-keystore /working/mykeystore -.fl - \-storepass \fP\f4<new password for keystore>\fP\f3 \-validity 180 -.fl -\fP -.fi +Which type of import is intended is indicated by the value of the \f3-alias\fR option\&. If the alias does not point to a key entry, then the \f3keytool\fR command assumes you are adding a trusted certificate entry\&. In this case, the alias should not already exist in the keystore\&. If the alias does already exist, then the \f3keytool\fR command outputs an error because there is already a trusted certificate for that alias, and does not import the certificate\&. If the alias points to a key entry, then the \f3keytool\fR command assumes you are importing a certificate reply\&. +.TP +-importpassword +.br +\f3{-alias alias} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -(Please note: This must be typed as a single line. Multiple lines are used in the examples just for legibility purposes.) -.LP -.LP -This command creates the keystore named "mykeystore" in the "working" directory (assuming it doesn't already exist), and assigns it the password specified by \f2<new password for keystore>\fP. It generates a public/private key pair for the entity whose "distinguished name" has a common name of "Mark Jones", organizational unit of "Java", organization of "Oracle" and two\-letter country code of "US". It uses the default "DSA" key generation algorithm to create the keys, both 1024 bits long. -.LP -.LP -It creates a self\-signed certificate (using the default "SHA1withDSA" signature algorithm) that includes the public key and the distinguished name information. This certificate will be valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias "business". The private key is assigned the password specified by \f2<new password for private key>\fP. -.LP -.LP -The command could be significantly shorter if option defaults were accepted. As a matter of fact, no options are required; defaults are used for unspecified options that have default values, and you are prompted for any required values. Thus, you could simply have the following: -.LP -.nf -\f3 -.fl - keytool \-genkeypair -.fl -\fP -.fi +Imports a passphrase and stores it in a new \f3KeyStore\&.SecretKeyEntry\fR identified by \f3alias\fR\&. The passphrase may be supplied via the standard input stream; otherwise the user is prompted for it\&. \f3keypass\fR is a password used to protect the imported passphrase\&. If no password is provided, the user is prompted for it\&. If you press the Return key at the prompt, the key password is set to the same password as that used for the \f3keystore\fR\&. \f3keypass\fR must be at least 6 characters long\&. +.TP +-importkeystore +.br +\f3{-srcstoretype srcstoretype} {-deststoretype deststoretype} [-srcstorepass srcstorepass] [-deststorepass deststorepass] {-srcprotected} {-destprotected} {-srcalias srcalias {-destalias destalias} [-srckeypass srckeypass] } [-destkeypass destkeypass] {-noprompt} {-srcProviderName src_provider_name} {-destProviderName dest_provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -In this case, a keystore entry with alias "mykey" is created, with a newly\-generated key pair and a certificate that is valid for 90 days. This entry is placed in the keystore named ".keystore" in your home directory. (The keystore is created if it doesn't already exist.) You will be prompted for the distinguished name information, the keystore password, and the private key password. -.LP -.LP -The rest of the examples assume you executed the \f2\-genkeypair\fP command without options specified, and that you responded to the prompts with values equal to those given in the first \f2\-genkeypair\fP command, above (for example, a distinguished name of "cn=Mark Jones, ou=Java, o=Oracle, c=US"). -.LP -.SS -Requesting a Signed Certificate from a Certification Authority -.LP -.LP -So far all we've got is a self\-signed certificate. A certificate is more likely to be trusted by others if it is signed by a Certification Authority (CA). To get such a signature, you first generate a Certificate Signing Request (CSR), via the following: -.LP -.nf -\f3 -.fl - keytool \-certreq \-file MarkJ.csr -.fl -\fP -.fi +Imports a single entry or all entries from a source keystore to a destination keystore\&. -.LP -.LP -This creates a CSR (for the entity identified by the default alias "mykey") and puts the request in the file named "MarkJ.csr". Submit this file to a CA, such as VeriSign, Inc. The CA will authenticate you, the requestor (usually off\-line), and then will return a certificate, signed by them, authenticating your public key. (In some cases, they will actually return a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain.) -.LP -.SS -Importing a Certificate for the CA -.LP -.LP -You need to replace your self\-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a "root" CA. -.LP -.LP -Before you import the certificate reply from a CA, you need one or more "trusted certificates" in your keystore or in the \f2cacerts\fP keystore file (which is described in importcert command): -.LP -.RS 3 -.TP 2 -o -If the certificate reply is a certificate chain, you just need the top certificate of the chain (that is, the "root" CA certificate authenticating that CA's public key). -.TP 2 -o -If the certificate reply is a single certificate, you need a certificate for the issuing CA (the one that signed it), and if that certificate is not self\-signed, you need a certificate for its signer, and so on, up to a self\-signed "root" CA certificate. -.RE +When the \f3-srcalias\fR option is provided, the command imports the single entry identified by the alias to the destination keystore\&. If a destination alias is not provided with \f3destalias\fR, then \f3srcalias\fR is used as the destination alias\&. If the source entry is protected by a password, then \f3srckeypass\fR is used to recover the entry\&. If \fIsrckeypass\fR is not provided, then the \f3keytool\fR command attempts to use \f3srcstorepass\fR to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. The destination entry is protected with \f3destkeypass\fR\&. If \f3destkeypass\fR is not provided, then the destination entry is protected with the source entry password\&. For example, most third-party tools require \f3storepass\fR and \f3keypass\fR in a PKCS #12 keystore to be the same\&. In order to create a PKCS #12 keystore for these tools, always specify a \f3-destkeypass\fR to be the same as \f3-deststorepass\fR\&. -.LP -.LP -The "cacerts" keystore file ships with several VeriSign root CA certificates, so you probably won't need to import a VeriSign certificate as a trusted certificate in your keystore. But if you request a signed certificate from a different CA, and a certificate authenticating that CA's public key hasn't been added to "cacerts", you will need to import a certificate from the CA as a "trusted certificate". -.LP -.LP -A certificate from a CA is usually either self\-signed, or signed by another CA (in which case you also need a certificate authenticating that CA's public key). Suppose company ABC, Inc., is a CA, and you obtain a file named "ABCCA.cer" that is purportedly a self\-signed certificate from ABC, authenticating that CA's public key. -.LP -.LP -Be very careful to ensure the certificate is valid prior to importing it as a "trusted" certificate! View it first (using the \f3keytool\fP \f2\-printcert\fP command, or the \f3keytool\fP \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. You can call the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show (or that a secure public key repository shows). Only if the fingerprints are equal is it guaranteed that the certificate has not been replaced in transit with somebody else's (for example, an attacker's) certificate. If such an attack took place, and you did not check the certificate before you imported it, you would end up trusting anything the attacker has signed. -.LP -.LP -If you trust that the certificate is valid, then you can add it to your keystore via the following: -.LP -.nf -\f3 -.fl - keytool \-importcert \-alias abc \-file ABCCA.cer -.fl -\fP -.fi +If the \f3-srcalias\fR option is not provided, then all entries in the source keystore are imported into the destination keystore\&. Each destination entry is stored under the alias from the source entry\&. If the source entry is protected by a password, then \f3srcstorepass\fR is used to recover the entry\&. If \f3srcstorepass\fR is either not provided or is incorrect, then the user is prompted for a password\&. If a source keystore entry type is not supported in the destination keystore, or if an error occurs while storing an entry into the destination keystore, then the user is prompted whether to skip the entry and continue or to quit\&. The destination entry is protected with the source entry password\&. -.LP -.LP -This creates a "trusted certificate" entry in the keystore, with the data from the file "ABCCA.cer", and assigns the alias "abc" to the entry. -.LP -.SS -Importing the Certificate Reply from the CA -.LP -.LP -Once you've imported a certificate authenticating the public key of the CA you submitted your certificate signing request to (or there's already such a certificate in the "cacerts" file), you can import the certificate reply and thereby replace your self\-signed certificate with a certificate chain. This chain is the one returned by the CA in response to your request (if the CA reply is a chain), or one constructed (if the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the "cacerts" keystore file. -.LP -.LP -For example, suppose you sent your certificate signing request to VeriSign. You can then import the reply via the following, which assumes the returned certificate is named "VSMarkJ.cer": -.LP -.nf -\f3 -.fl - keytool \-importcert \-trustcacerts \-file VSMarkJ.cer -.fl -\fP -.fi +If the destination alias already exists in the destination keystore, then the user is prompted to either overwrite the entry or to create a new entry under a different alias name\&. -.LP -.SS -Exporting a Certificate Authenticating Your Public Key -.LP -.LP -Suppose you have used the jarsigner(1) tool to sign a Java ARchive (JAR) file. Clients that want to use the file will want to authenticate your signature. -.LP -.LP -One way they can do this is by first importing your public key certificate into their keystore as a "trusted" entry. You can export the certificate and supply it to your clients. As an example, you can copy your certificate to a file named \f2MJ.cer\fP via the following, assuming the entry is aliased by "mykey": -.LP -.nf -\f3 -.fl - keytool \-exportcert \-alias mykey \-file MJ.cer -.fl -\fP -.fi +If the \f3-noprompt\fR option is provided, then the user is not prompted for a new destination alias\&. Existing entries are overwritten with the destination alias name\&. Entries that cannot be imported are skipped and a warning is displayed\&. +.TP +-printcertreq +.br +\f3{-file file}\fR -.LP -.LP -Given that certificate, and the signed JAR file, a client can use the \f3jarsigner\fP tool to authenticate your signature. -.LP -.SS -Importing Keystore -.LP -.LP -The command "importkeystore" is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command. You can use this command to import entries from a different type of keystore. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys). If \f3keytool\fP has difficulties recover the private keys or secret keys from the source keystore, it will prompt you for a password. If it detects alias duplication, it will ask you for a new one, you can specify a new alias or simply allow \f3keytool\fP to overwrite the existing one. -.LP -.LP -For example, to import entries from a normal JKS type keystore key.jks into a PKCS #11 type hardware based keystore, you can use the command: -.LP -.nf -\f3 -.fl - keytool \-importkeystore -.fl - \-srckeystore key.jks \-destkeystore NONE -.fl - \-srcstoretype JKS \-deststoretype PKCS11 -.fl - \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3 -.fl -\fP -.fi +Prints the content of a PKCS #10 format certificate request, which can be generated by the \f3keytool\fR\f3-certreq\fR command\&. The command reads the request from file\&. If there is no file, then the request is read from the standard input\&. +.TP +-certreq +.br +\f3{-alias alias} {-dname dname} {-sigalg sigalg} {-file certreq_file} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR -.LP -.LP -The importkeystore command can also be used to import a single entry from a source keystore to a destination keystore. In this case, besides the options you see in the above example, you need to specify the alias you want to import. With the srcalias option given, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want. The following command demonstrates this: -.LP -.nf -\f3 -.fl - keytool \-importkeystore -.fl - \-srckeystore key.jks \-destkeystore NONE -.fl - \-srcstoretype JKS \-deststoretype PKCS11 -.fl - \-srcstorepass \fP\f4<source keystore password>\fP\f3 \-deststorepass \fP\f4<destination keystore password>\fP\f3 -.fl - \-srcalias myprivatekey \-destalias myoldprivatekey -.fl - \-srckeypass \fP\f4<source entry password>\fP\f3 \-destkeypass \fP\f4<destination entry password>\fP\f3 -.fl - \-noprompt -.fl -\fP -.fi +Generates a Certificate Signing Request (CSR) using the PKCS #10 format\&. -.LP -.SS -Generating Certificates for a Typical SSL Server -.LP -.LP -The following are keytool commands to generate keypairs and certificates for three entities, namely, Root CA (root), Intermediate CA (ca), and SSL server (server). Ensure that you store all the certificates in the same keystore. In these examples, it is recommended that you specify RSA as the key algorithm. -.LP -.nf -\f3 -.fl -keytool \-genkeypair \-keystore root.jks \-alias root \-ext bc:c -.fl -keytool \-genkeypair \-keystore ca.jks \-alias ca \-ext bc:c -.fl -keytool \-genkeypair \-keystore server.jks \-alias server -.fl +A CSR is intended to be sent to a certificate authority (CA)\&. The CA authenticates the certificate requestor (usually off-line) and will return a certificate or certificate chain, used to replace the existing certificate chain (which initially consists of a self-signed certificate) in the keystore\&. -.fl -keytool \-keystore root.jks \-alias root \-exportcert \-rfc > root.pem -.fl +The private key associated with alias is used to create the PKCS #10 certificate request\&. To access the private key, the correct password must be provided\&. If \f3keypass\fR is not provided at the command line and is different from the password used to protect the integrity of the keystore, then the user is prompted for it\&. If \f3dname\fR is provided, then it is used as the subject in the CSR\&. Otherwise, the X\&.500 Distinguished Name associated with alias is used\&. -.fl -keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-certreq \-alias ca | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore root.jks \-gencert \-alias root \-ext BC=0 \-rfc > ca.pem -.fl -keytool \-keystore ca.jks \-importcert \-alias ca \-file ca.pem -.fl +The \f3sigalg\fR value specifies the algorithm that should be used to sign the CSR\&. -.fl -keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore server.jks \-certreq \-alias server | keytool \-storepass \fP\f4<storepass>\fP\f3 \-keystore ca.jks \-gencert \-alias ca \-ext ku:c=dig,kE \-rfc > server.pem -.fl -cat root.pem ca.pem server.pem | keytool \-keystore server.jks \-importcert \-alias server -.fl -\fP -.fi +The CSR is stored in the file certreq_file\&. If no file is specified, then the CSR is output to \f3stdout\fR\&. -.LP -.SH "TERMINOLOGY and WARNINGS" -.LP -.SS -KeyStore -.LP -.LP -A keystore is a storage facility for cryptographic keys and certificates. -.LP -.RS 3 -.TP 2 -o -\f3KeyStore Entries\fP -.LP -Keystores may have different types of entries. The two most applicable entry types for \f3keytool\fP include: -.RS 3 -.TP 3 -1. -\f3key entries\fP \- each holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate "chain" for the corresponding public key. The \f3keytool\fP can handle both types of entries, while the \f3jarsigner\fP tool only handle the latter type of entry, that is private keys and their associated certificate chains. -.TP 3 -2. -\f3trusted certificate entries\fP \- each contains a single public key certificate belonging to another party. It is called a "trusted certificate" because the keystore owner trusts that the public key in the certificate indeed belongs to the identity identified by the "subject" (owner) of the certificate. The issuer of the certificate vouches for this, by signing the certificate. -.RE -.TP 2 -o -\f3KeyStore Aliases\fP -.LP -All keystore entries (key and trusted certificate entries) are accessed via unique \f2aliases\fP. -.LP -An alias is specified when you add an entity to the keystore using the \-genseckey command to generate a secret key, \-genkeypair command to generate a key pair (public and private key) or the \-importcert command to add a certificate or certificate chain to the list of trusted certificates. Subsequent \f3keytool\fP commands must use this same alias to refer to the entity. -.LP -For example, suppose you use the alias \f2duke\fP to generate a new public/private key pair and wrap the public key into a self\-signed certificate (see Certificate Chains) via the following command: -.nf -\f3 -.fl - keytool \-genkeypair \-alias duke \-keypass dukekeypasswd -.fl -\fP -.fi -.LP -This specifies an initial password of "dukekeypasswd" required by subsequent commands to access the private key associated with the alias \f2duke\fP. If you later want to change duke's private key password, you use a command like the following: -.nf -\f3 -.fl - keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass -.fl -\fP -.fi -.LP -This changes the password from "dukekeypasswd" to "newpass". -.LP -Please note: A password should not actually be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system. If you don't specify a required password option on a command line, you will be prompted for it. -.TP 2 -o -\f3KeyStore Implementation\fP -.LP -The \f2KeyStore\fP class provided in the \f2java.security\fP package supplies well\-defined interfaces to access and modify the information in a keystore. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular \f2type\fP of keystore. -.LP -Currently, two command\-line tools (\f3keytool\fP and \f3jarsigner\fP) and a GUI\-based tool named \f3Policy Tool\fP make use of keystore implementations. Since \f2KeyStore\fP is publicly available, users can write additional security applications that use it. -.LP -There is a built\-in default implementation, provided by Oracle. It implements the keystore as a file, utilizing a proprietary keystore type (format) named "JKS". It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password. -.LP -Keystore implementations are provider\-based. More specifically, the application interfaces supplied by \f2KeyStore\fP are implemented in terms of a "Service Provider Interface" (SPI). That is, there is a corresponding abstract \f2KeystoreSpi\fP class, also in the \f2java.security\fP package, which defines the Service Provider Interface methods that "providers" must implement. (The term "provider" refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API.) Thus, to provide a keystore implementation, clients must implement a "provider" and supply a KeystoreSpi subclass implementation, as described in -.na -\f2How to Implement a Provider for the Java Cryptography Architecture\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/crypto/HowToImplAProvider.html. -.LP -Applications can choose different \f2types\fP of keystore implementations from different providers, using the "getInstance" factory method supplied in the \f2KeyStore\fP class. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore itself. Keystore implementations of different types are not compatible. -.LP -\f3keytool\fP works on any file\-based keystore implementation. (It treats the keystore location that is passed to it at the command line as a filename and converts it to a FileInputStream, from which it loads the keystore information.) The \f3jarsigner\fP and \f3policytool\fP tools, on the other hand, can read a keystore from any location that can be specified using a URL. -.LP -For \f3keytool\fP and \f3jarsigner\fP, you can specify a keystore type at the command line, via the \f2\-storetype\fP option. For \f3Policy Tool\fP, you can specify a keystore type via the "Keystore" menu. -.LP -If you don't explicitly specify a keystore type, the tools choose a keystore implementation based simply on the value of the \f2keystore.type\fP property specified in the security properties file. The security properties file is called \f2java.security\fP, and it resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -Each tool gets the \f2keystore.type\fP value and then examines all the currently\-installed providers until it finds one that implements keystores of that type. It then uses the keystore implementation from that provider. -.LP -The \f2KeyStore\fP class defines a static method named \f2getDefaultType\fP that lets applications and applets retrieve the value of the \f2keystore.type\fP property. The following line of code creates an instance of the default keystore type (as specified in the \f2keystore.type\fP property): -.nf -\f3 -.fl - KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType()); -.fl -\fP -.fi -.LP -The default keystore type is "jks" (the proprietary type of the keystore implementation provided by Oracle). This is specified by the following line in the security properties file: -.nf -\f3 -.fl - keystore.type=jks -.fl -\fP -.fi -.LP -To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type. -.LP -For example, if you have a provider package that supplies a keystore implementation for a keystore type called "pkcs12", change the line to -.nf -\f3 -.fl - keystore.type=pkcs12 -.fl -\fP -.fi -.LP -Note: case doesn't matter in keystore type designations. For example, "JKS" would be considered the same as "jks". -.RE +Use the \f3importcert\fR command to import the response from the CA\&. +.TP +-exportcert +.br +\f3{-alias alias} {-file cert_file} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-rfc} {-v} {-protected} {-Jjavaoption}\fR -.LP -.SS +Reads from the keystore the certificate associated with \fIalias\fR and stores it in the cert_file file\&. When no file is specified, the certificate is output to \f3stdout\fR\&. + +The certificate is by default output in binary encoding\&. If the \f3-rfc\fR option is specified, then the output in the printable encoding format defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +If \f3alias\fR refers to a trusted certificate, then that certificate is output\&. Otherwise, \f3alias\fR refers to a key entry with an associated certificate chain\&. In that case, the first certificate in the chain is returned\&. This certificate authenticates the public key of the entity addressed by \f3alias\fR\&. + +This command was named \f3-export\fR in earlier releases\&. The old name is still supported in this release\&. The new name, \f3-exportcert\fR, is preferred going forward\&. +.TP +-list +.br +\f3{-alias alias} {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v | -rfc} {-protected} {-Jjavaoption}\fR + +Prints to \f3stdout\fR the contents of the keystore entry identified by \f3alias\fR\&. If no \f3alias\fR is specified, then the contents of the entire keystore are printed\&. + +This command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format, with additional information such as the owner, issuer, serial number, and any extensions\&. If the \f3-rfc\fR option is specified, then the certificate contents are printed using the printable encoding format, as defined by the Internet RFC 1421 Certificate Encoding Standard\&. + +You cannot specify both \f3-v\fR and \f3-rfc\fR\&. +.TP +-printcert +.br +\f3{-file cert_file | -sslserver host[:port]} {-jarfile JAR_file {-rfc} {-v} {-Jjavaoption}\fR + +Reads the certificate from the file cert_file, the SSL server located at host:port, or the signed JAR file \f3JAR_file\fR (with the \f3-jarfile\fR option and prints its contents in a human-readable format\&. When no port is specified, the standard HTTPS port 443 is assumed\&. Note that \f3-sslserver\fR and -file options cannot be provided at the same time\&. Otherwise, an error is reported\&. If neither option is specified, then the certificate is read from \f3stdin\fR\&. + +When\f3-rfc\fR is specified, the \f3keytool\fR command prints the certificate in PEM mode as defined by the Internet RFC 1421 Certificate Encoding standard\&. See Internet RFC 1421 Certificate Encoding Standard\&. + +If the certificate is read from a file or \f3stdin\fR, then it might be either binary encoded or in printable encoding format, as defined by the RFC 1421 Certificate Encoding standard\&. + +If the SSL server is behind a firewall, then the \f3-J-Dhttps\&.proxyHost=proxyhost\fR and \f3-J-Dhttps\&.proxyPort=proxyport\fR options can be specified on the command line for proxy tunneling\&. See Java Secure Socket Extension (JSSE) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide\&.html + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-printcrl +.br +\f3-file crl_ {-v}\fR + +Reads the Certificate Revocation List (CRL) from the file \f3crl_\fR\&. A CRL is a list of digital certificates that were revoked by the CA that issued them\&. The CA generates the \f3crl_\fR file\&. + +\fINote:\fR This option can be used independently of a keystore\&. +.TP +-storepasswd +.br +\f3[-new new_storepass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-Jjavaoption}\fR + +Changes the password used to protect the integrity of the keystore contents\&. The new password is \f3new_storepass\fR, which must be at least 6 characters\&. +.TP +-keypasswd +.br +\f3{-alias alias} [-keypass old_keypass] [-new new_keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-Jjavaoption}\fR + +Changes the password under which the private/secret key identified by \f3alias\fR is protected, from \f3old_keypass\fR to \f3new_keypass\fR, which must be at least 6 characters\&. + +If the \f3-keypass\fR option is not provided at the command line, and the key password is different from the keystore password, then the user is prompted for it\&. + +If the \f3-new\fR option is not provided at the command line, then the user is prompted for it +.TP +-delete +.br +\f3[-alias alias] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Deletes from the keystore the entry identified by \f3alias\fR\&. The user is prompted for the alias, when no alias is provided at the command line\&. +.TP +-changealias +.br +\f3{-alias alias} [-destalias destalias] [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass] {-providerName provider_name} {-providerClass provider_class_name {-providerArg provider_arg}} {-v} {-protected} {-Jjavaoption}\fR + +Move an existing keystore entry from the specified \f3alias\fR to a new alias, \f3destalias\fR\&. If no destination alias is provided, then the command prompts for one\&. If the original entry is protected with an entry password, then the password can be supplied with the \f3-keypass\fR option\&. If no key password is provided, then the \f3storepass\fR (if provided) is attempted first\&. If the attempt fails, then the user is prompted for a password\&. +.TP +-help +.br +Lists the basic commands and their options\&. + +For more information about a specific command, enter the following, where \f3command_name\fR is the name of the command: \f3keytool -command_name -help\fR\&. +.SH EXAMPLES +This example walks through the sequence of steps to create a keystore for managing public/private key pair and certificates from trusted entities\&. +.SS GENERATE\ THE\ KEY\ PAIR +First, create a keystore and generate the key pair\&. You can use a command such as the following typed as a single line: +.sp +.nf +\f3keytool \-genkeypair \-dname "cn=Mark Jones, ou=Java, o=Oracle, c=US"\fP +.fi +.nf +\f3 \-alias business \-keypass <new password for private key>\fP +.fi +.nf +\f3 \-keystore /working/mykeystore\fP +.fi +.nf +\f3 \-storepass <new password for keystore> \-validity 180\fP +.fi +.nf +\f3\fP +.fi +.sp +The command creates the keystore named \f3mykeystore\fR in the working directory (assuming it does not already exist), and assigns it the password specified by \f3<new password for keystore>\fR\&. It generates a public/private key pair for the entity whose distinguished name has a common name of Mark Jones, organizational unit of Java, organization of Oracle and two-letter country code of US\&. It uses the default DSA key generation algorithm to create the keys; both are 1024 bits\&. +.PP +The command uses the default SHA1withDSA signature algorithm to create a self-signed certificate that includes the public key and the distinguished name information\&. The certificate is valid for 180 days, and is associated with the private key in a keystore entry referred to by the alias \f3business\fR\&. The private key is assigned the password specified by \f3<new password for private key>\fR\&. +.PP +The command is significantly shorter when the option defaults are accepted\&. In this case, no options are required, and the defaults are used for unspecified options that have default values\&. You are prompted for any required values\&. You could have the following: +.sp +.nf +\f3keytool \-genkeypair\fP +.fi +.nf +\f3\fP +.fi +.sp +In this case, a keystore entry with the alias \f3mykey\fR is created, with a newly generated key pair and a certificate that is valid for 90 days\&. This entry is placed in the keystore named \f3\&.keystore\fR in your home directory\&. The keystore is created when it does not already exist\&. You are prompted for the distinguished name information, the keystore password, and the private key password\&. +.PP +The rest of the examples assume you executed the \f3-genkeypair\fR command without options specified, and that you responded to the prompts with values equal to those specified in the first \f3-genkeypair\fR command\&. For example, a distinguished name of \f3cn=Mark Jones\fR, \f3ou=Java\fR, \f3o=Oracle\fR, \f3c=US\fR)\&. +.SS REQUEST\ A\ SIGNED\ CERTIFICATE\ FROM\ A\ CA +Generating the key pair created a self-signed certificate\&. A certificate is more likely to be trusted by others when it is signed by a Certification Authority (CA)\&. To get a CA signature, first generate a Certificate Signing Request (CSR), as follows: +.sp +.nf +\f3keytool \-certreq \-file MarkJ\&.csr\fP +.fi +.nf +\f3\fP +.fi +.sp +This creates a CSR for the entity identified by the default alias \f3mykey\fR and puts the request in the file named MarkJ\&.csr\&. Submit this file to a CA, such as VeriSign\&. The CA authenticates you, the requestor (usually off-line), and returns a certificate, signed by them, authenticating your public key\&. In some cases, the CA returns a chain of certificates, each one authenticating the public key of the signer of the previous certificate in the chain\&. +.SS IMPORT\ A\ CERTIFICATE\ FOR\ THE\ CA +You now need to replace the self-signed certificate with a certificate chain, where each certificate in the chain authenticates the public key of the signer of the previous certificate in the chain, up to a root CA\&. +.PP +Before you import the certificate reply from a CA, you need one or more trusted certificates in your keystore or in the \f3cacerts\fR keystore file\&. See \f3-importcert\fR in Commands\&. +.TP 0.2i +\(bu +If the certificate reply is a certificate chain, then you need the top certificate of the chain\&. The root CA certificate that authenticates the public key of the CA\&. +.TP 0.2i +\(bu +If the certificate reply is a single certificate, then you need a certificate for the issuing CA (the one that signed it)\&. If that certificate is not self-signed, then you need a certificate for its signer, and so on, up to a self-signed root CA certificate\&. +.PP +The \f3cacerts\fR keystore file ships with several VeriSign root CA certificates, so you probably will not need to import a VeriSign certificate as a trusted certificate in your keystore\&. But if you request a signed certificate from a different CA, and a certificate authenticating that CA\&'s public key was not added to \f3cacerts\fR, then you must import a certificate from the CA as a trusted certificate\&. +.PP +A certificate from a CA is usually either self-signed or signed by another CA, in which case you need a certificate that authenticates that CA\&'s public key\&. Suppose company ABC, Inc\&., is a CA, and you obtain a file named A\f3BCCA\&.cer\fR that is supposed to be a self-signed certificate from ABC, that authenticates that CA\&'s public key\&. Be careful to ensure the certificate is valid before you import it as a trusted certificate\&. View it first with the \f3keytool -printcert\fR command or the \f3keytool -importcert\fR command without the \f3-noprompt\fR option, and make sure that the displayed certificate fingerprints match the expected ones\&. You can call the person who sent the certificate, and compare the fingerprints that you see with the ones that they show or that a secure public key repository shows\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s (for example, an attacker\&'s) certificate\&. If such an attack takes place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker has signed\&. +.PP +If you trust that the certificate is valid, then you can add it to your keystore with the following command: +.sp +.nf +\f3keytool \-importcert \-alias abc \-file ABCCA\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +This command creates a trusted certificate entry in the keystore, with the data from the file ABCCA\&.cer, and assigns the alias \f3abc\fR to the entry\&. +.SS IMPORT\ THE\ CERTIFICATE\ REPLY\ FROM\ THE\ CA +After you import a certificate that authenticates the public key of the CA you submitted your certificate signing request to (or there is already such a certificate in the cacerts file), you can import the certificate reply and replace your self-signed certificate with a certificate chain\&. This chain is the one returned by the CA in response to your request (when the CA reply is a chain), or one constructed (when the CA reply is a single certificate) using the certificate reply and trusted certificates that are already available in the keystore where you import the reply or in the \f3cacerts\fR keystore file\&. +.PP +For example, if you sent your certificate signing request to VeriSign, then you can import the reply with the following, which assumes the returned certificate is named VSMarkJ\&.cer: +.sp +.nf +\f3keytool \-importcert \-trustcacerts \-file VSMarkJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS EXPORT\ A\ CERTIFICATE\ THAT\ AUTHENTICATES\ THE\ PUBLIC\ KEY +If you used the \f3jarsigner\fR command to sign a Java Archive (JAR) file, then clients that want to use the file will want to authenticate your signature\&. One way the clients can authenticate you is by first importing your public key certificate into their keystore as a trusted entry\&. +.PP +You can export the certificate and supply it to your clients\&. As an example, you can copy your certificate to a file named MJ\&.cer with the following command that assumes the entry has an alias of \f3mykey\fR: +.sp +.nf +\f3keytool \-exportcert \-alias mykey \-file MJ\&.cer\fP +.fi +.nf +\f3\fP +.fi +.sp +With the certificate and the signed JAR file, a client can use the \f3jarsigner\fR command to authenticate your signature\&. +.SS IMPORT\ KEYSTORE +The command \f3importkeystore\fR is used to import an entire keystore into another keystore, which means all entries from the source keystore, including keys and certificates, are all imported to the destination keystore within a single command\&. You can use this command to import entries from a different type of keystore\&. During the import, all new entries in the destination keystore will have the same alias names and protection passwords (for secret keys and private keys)\&. If the \f3keytool\fR command cannot recover the private keys or secret keys from the source keystore, then it prompts you for a password\&. If it detects alias duplication, then it asks you for a new alias, and you can specify a new alias or simply allow the \f3keytool\fR command to overwrite the existing one\&. +.PP +For example, to import entries from a typical JKS type keystore key\&.jks into a PKCS #11 type hardware-based keystore, use the command: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3importkeystore\fR command can also be used to import a single entry from a source keystore to a destination keystore\&. In this case, besides the options you see in the previous example, you need to specify the alias you want to import\&. With the \f3-srcalias\fR option specified, you can also specify the destination alias name in the command line, as well as protection password for a secret/private key and the destination protection password you want\&. The following command demonstrates this: +.sp +.nf +\f3keytool \-importkeystore\fP +.fi +.nf +\f3 \-srckeystore key\&.jks \-destkeystore NONE\fP +.fi +.nf +\f3 \-srcstoretype JKS \-deststoretype PKCS11\fP +.fi +.nf +\f3 \-srcstorepass <src keystore password>\fP +.fi +.nf +\f3 \-deststorepass <destination keystore pwd>\fP +.fi +.nf +\f3 \-srcalias myprivatekey \-destalias myoldprivatekey\fP +.fi +.nf +\f3 \-srckeypass <source entry password>\fP +.fi +.nf +\f3 \-destkeypass <destination entry password>\fP +.fi +.nf +\f3 \-noprompt\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS GENERATE\ CERTIFICATES\ FOR\ AN\ SSL\ SERVER +The following are \f3keytool\fR commands to generate key pairs and certificates for three entities: Root CA (\f3root\fR), Intermediate CA (\f3ca\fR), and SSL server (\f3server\fR)\&. Ensure that you store all the certificates in the same keystore\&. In these examples, RSA is the recommended the key algorithm\&. +.sp +.nf +\f3keytool \-genkeypair \-keystore root\&.jks \-alias root \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore ca\&.jks \-alias ca \-ext bc:c\fP +.fi +.nf +\f3keytool \-genkeypair \-keystore server\&.jks \-alias server\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-keystore root\&.jks \-alias root \-exportcert \-rfc > root\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore ca\&.jks \-certreq \-alias ca |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore root\&.jks\fP +.fi +.nf +\f3 \-gencert \-alias root \-ext BC=0 \-rfc > ca\&.pem\fP +.fi +.nf +\f3keytool \-keystore ca\&.jks \-importcert \-alias ca \-file ca\&.pem\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3keytool \-storepass <storepass> \-keystore server\&.jks \-certreq \-alias server |\fP +.fi +.nf +\f3 keytool \-storepass <storepass> \-keystore ca\&.jks \-gencert \-alias ca\fP +.fi +.nf +\f3 \-ext ku:c=dig,kE \-rfc > server\&.pem\fP +.fi +.nf +\f3cat root\&.pem ca\&.pem server\&.pem |\fP +.fi +.nf +\f3 keytool \-keystore server\&.jks \-importcert \-alias server\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH TERMS +.TP +Keystore +A keystore is a storage facility for cryptographic keys and certificates\&. +.TP +Keystore entries +Keystores can have different types of entries\&. The two most applicable entry types for the \f3keytool\fR command include the following: + +\fIKey entries\fR: Each entry holds very sensitive cryptographic key information, which is stored in a protected format to prevent unauthorized access\&. Typically, a key stored in this type of entry is a secret key, or a private key accompanied by the certificate chain for the corresponding public key\&. See Certificate Chains\&. The \f3keytool\fR command can handle both types of entries, while the \f3jarsigner\fR tool only handles the latter type of entry, that is private keys and their associated certificate chains\&. + +\fITrusted certificate entries\fR: Each entry contains a single public key certificate that belongs to another party\&. The entry is called a trusted certificate because the keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject (owner) of the certificate\&. The issuer of the certificate vouches for this, by signing the certificate\&. +.TP +KeyStore aliases +All keystore entries (key and trusted certificate entries) are accessed by way of unique aliases\&. + +An alias is specified when you add an entity to the keystore with the \f3-genseckey\fR command to generate a secret key, the \f3-genkeypair\fR command to generate a key pair (public and private key), or the \f3-importcert\fR command to add a certificate or certificate chain to the list of trusted certificates\&. Subsequent \f3keytool\fR commands must use this same alias to refer to the entity\&. + +For example, you can use the alias \f3duke\fR to generate a new public/private key pair and wrap the public key into a self-signed certificate with the following command\&. See Certificate Chains\&. +.sp +.nf +\f3keytool \-genkeypair \-alias duke \-keypass dukekeypasswd\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This example specifies an initial password of \f3dukekeypasswd\fR required by subsequent commands to access the private key associated with the alias \f3duke\fR\&. If you later want to change Duke\&'s private key password, use a command such as the following: +.sp +.nf +\f3keytool \-keypasswd \-alias duke \-keypass dukekeypasswd \-new newpass\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This changes the password from \f3dukekeypasswd\fR to \f3newpass\fR\&. A password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system\&. If you do not specify a required password option on a command line, then you are prompted for it\&. +.TP +KeyStore implementation +The \f3KeyStore\fR class provided in the \f3java\&.security\fR package supplies well-defined interfaces to access and modify the information in a keystore\&. It is possible for there to be multiple different concrete implementations, where each implementation is that for a particular type of keystore\&. + +Currently, two command-line tools (\f3keytool\fR and \f3jarsigner\fR) and a GUI-based tool named Policy Tool make use of keystore implementations\&. Because the \f3KeyStore\fR class is \f3public\fR, users can write additional security applications that use it\&. + +There is a built-in default implementation, provided by Oracle\&. It implements the keystore as a file with a proprietary keystore type (format) named JKS\&. It protects each private key with its individual password, and also protects the integrity of the entire keystore with a (possibly different) password\&. + +Keystore implementations are provider-based\&. More specifically, the application interfaces supplied by \f3KeyStore\fR are implemented in terms of a Service Provider Interface (SPI)\&. That is, there is a corresponding abstract \f3KeystoreSpi\fR class, also in the \f3java\&.security package\fR, which defines the Service Provider Interface methods that providers must implement\&. The term \fIprovider\fR refers to a package or a set of packages that supply a concrete implementation of a subset of services that can be accessed by the Java Security API\&. To provide a keystore implementation, clients must implement a provider and supply a \f3KeystoreSpi\fR subclass implementation, as described in How to Implement a Provider in the Java Cryptography Architecture at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/HowToImplAProvider\&.html + +Applications can choose different types of keystore implementations from different providers, using the \f3getInstance\fR factory method supplied in the \f3KeyStore\fR class\&. A keystore type defines the storage and data format of the keystore information, and the algorithms used to protect private/secret keys in the keystore and the integrity of the keystore\&. Keystore implementations of different types are not compatible\&. + +The \f3keytool\fR command works on any file-based keystore implementation\&. It treats the keystore location that is passed to it at the command line as a file name and converts it to a \f3FileInputStream\fR, from which it loads the keystore information\&.)The \f3jarsigner\fR and \f3policytool\fR commands can read a keystore from any location that can be specified with a URL\&. + +For \f3keytool\fR and \f3jarsigner\fR, you can specify a keystore type at the command line, with the \f3-storetype\fR option\&. For Policy Tool, you can specify a keystore type with the \fIKeystore\fR menu\&. + +If you do not explicitly specify a keystore type, then the tools choose a keystore implementation based on the value of the \f3keystore\&.type\fR property specified in the security properties file\&. The security properties file is called \f3java\&.security\fR, and resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment directory\&. The \f3jre\fR directory in the SDK or the top-level directory of the Java Runtime Environment (JRE)\&. + +Each tool gets the \f3keystore\&.type\fR value and then examines all the currently installed providers until it finds one that implements a keystores of that type\&. It then uses the keystore implementation from that provider\&.The \f3KeyStore\fR class defines a static method named \f3getDefaultType\fR that lets applications and applets retrieve the value of the \f3keystore\&.type\fR property\&. The following line of code creates an instance of the default keystore type as specified in the \f3keystore\&.type\fR property: +.sp +.nf +\f3KeyStore keyStore = KeyStore\&.getInstance(KeyStore\&.getDefaultType());\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The default keystore type is \f3jks\fR, which is the proprietary type of the keystore implementation provided by Oracle\&. This is specified by the following line in the security properties file: +.sp +.nf +\f3keystore\&.type=jks\fP +.fi +.nf +\f3\fP +.fi +.sp + + +To have the tools utilize a keystore implementation other than the default, you can change that line to specify a different keystore type\&. For example, if you have a provider package that supplies a keystore implementation for a keystore type called \f3pkcs12\fR, then change the line to the following: +.sp +.nf +\f3keystore\&.type=pkcs12\fP +.fi +.nf +\f3\fP +.fi +.sp + + +\fINote:\fR Case does not matter in keystore type designations\&. For example, JKS would be considered the same as jks\&. +.TP Certificate -.LP -A \f3certificate\fP (also known as a \f3public\-key certificate\fP) is a digitally signed statement from one entity (the \f2issuer\fP), saying that the public key (and some other information) of another entity (the \f2subject\fP) has some specific value. -.RS 3 -.TP 2 -o -\f3Certificate Terms\fP -.RS 3 -.TP 3 -Public Keys -.LP -These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity. Public keys are used to verify signatures. -.TP 3 -Digitally Signed -.LP -If some data is \f2digitally signed\fP it has been stored with the "identity" of an entity, and a signature that proves that entity knows about the data. The data is rendered unforgeable by signing with the entity's private key. -.TP 3 -Identity -.LP -A known way of addressing an entity. In some systems the identity is the public key, in others it can be anything from a Unix UID to an Email address to an X.509 Distinguished Name. -.TP 3 -Signature -.LP -A signature is computed over some data using the private key of an entity (the \f2signer\fP, which in the case of a certificate is also known as the \f2issuer\fP). -.TP 3 -Private Keys -.LP -These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it's supposed to be kept secret). Private and public keys exist in pairs in all public key cryptography systems (also referred to as "public key crypto systems"). In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key. Private keys are used to compute signatures. -.TP 3 -Entity -.LP -An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree. -.RE -.LP -Basically, public key cryptography requires access to users' public keys. In a large\-scale networked environment it is impossible to guarantee that prior relationships between communicating entities have been established or that a trusted repository exists with all used public keys. Certificates were invented as a solution to this public key distribution problem. Now a \f2Certification Authority\fP (CA) can act as a trusted third party. CAs are entities (for example, businesses) that are trusted to sign (issue) certificates for other entities. It is assumed that CAs will only create valid and reliable certificates, as they are bound by legal agreements. There are many public Certification Authorities, such as -.na -\f2VeriSign\fP @ -.fi -http://www.verisign.com/, -.na -\f2Thawte\fP @ -.fi -http://www.thawte.com/, -.na -\f2Entrust\fP @ -.fi -http://www.entrust.com/, and so on. You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization. -.LP -Using \f3keytool\fP, it is possible to display, import, and export certificates. It is also possible to generate self\-signed certificates. -.LP -\f3keytool\fP currently handles X.509 certificates. -.TP 2 -o -\f3X.509 Certificates\fP -.LP -The X.509 standard defines what information can go into a certificate, and describes how to write it down (the data format). All the data in a certificate is encoded using two related standards called ASN.1/DER. \f2Abstract Syntax Notation 1\fP describes data. The \f2Definite Encoding Rules\fP describe a single way to store and transfer that data. -.LP -All X.509 certificates have the following data, in addition to the signature: -.RS 3 -.TP 3 -Version -.LP -This identifies which version of the X.509 standard applies to this certificate, which affects what information can be specified in it. Thus far, three versions are defined. \f3keytool\fP can import and export v1, v2, and v3 certificates. It generates v3 certificates. -.LP -\f2X.509 Version 1\fP has been available since 1988, is widely deployed, and is the most generic. -.LP -\f2X.509 Version 2\fP introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject and/or issuer names over time. Most certificate profile documents strongly recommend that names not be reused, and that certificates should not make use of unique identifiers. Version 2 certificates are not widely used. -.LP -\f2X.509 Version 3\fP is the most recent (1996) and supports the notion of extensions, whereby anyone can define an extension and include it in the certificate. Some common extensions in use today are: \f2KeyUsage\fP (limits the use of the keys to particular purposes such as "signing\-only") and \f2AlternativeNames\fP (allows other identities to also be associated with this public key, e.g. DNS names, Email addresses, IP addresses). Extensions can be marked \f2critical\fP to indicate that the extension should be checked and enforced/used. For example, if a certificate has the KeyUsage extension marked critical and set to "keyCertSign" then if this certificate is presented during SSL communication, it should be rejected, as the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use. -.TP 3 -Serial Number -.LP -The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues. This information is used in numerous ways, for example when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL). -.TP 3 -Signature Algorithm Identifier -.LP -This identifies the algorithm used by the CA to sign the certificate. -.TP 3 -Issuer Name -.LP -The X.500 Distinguished Name of the entity that signed the certificate. This is normally a CA. Using this certificate implies trusting the entity that signed this certificate. (Note that in some cases, such as \f2root or top\-level\fP CA certificates, the issuer signs its own certificate.) -.TP 3 -Validity Period -.LP -Each certificate is valid only for a limited amount of time. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate or the amount one is willing to pay for a certificate. This is the expected period that entities can rely on the public value, if the associated private key has not been compromised. -.TP 3 -Subject Name -.LP -The name of the entity whose public key the certificate identifies. This name uses the X.500 standard, so it is intended to be unique across the Internet. This is the X.500 Distinguished Name (DN) of the entity, for example, -.nf -\f3 -.fl - CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US -.fl -\fP -.fi -.LP -(These refer to the subject's Common Name, Organizational Unit, Organization, and Country.) -.TP 3 -Subject Public Key Information -.LP -This is the public key of the entity being named, together with an algorithm identifier which specifies which public key crypto system this key belongs to and any associated key parameters. -.RE -.TP 2 -o -\f3Certificate Chains\fP -.LP -\f3keytool\fP can create and manage keystore "key" entries that each contain a private key and an associated certificate "chain". The first certificate in the chain contains the public key corresponding to the private key. -.LP -When keys are first generated (see the \-genkeypair command), the chain starts off containing a single element, a \f2self\-signed certificate\fP. A self\-signed certificate is one for which the issuer (signer) is the same as the subject (the entity whose public key is being authenticated by the certificate). Whenever the \f2\-genkeypair\fP command is called to generate a new public/private key pair, it also wraps the public key into a self\-signed certificate. -.LP -Later, after a Certificate Signing Request (CSR) has been generated (see the \-certreq command) and sent to a Certification Authority (CA), the response from the CA is imported (see \-importcert), and the self\-signed certificate is replaced by a chain of certificates. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject's public key. The next certificate in the chain is one that authenticates the \f2CA\fP's public key. -.LP -In many cases, this is a self\-signed certificate (that is, a certificate from the CA authenticating its own public key) and the last certificate in the chain. In other cases, the CA may return a chain of certificates. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a \f2different\fP CA, authenticating the public key of the CA you sent the CSR to. Then, the next certificate in the chain will be a certificate authenticating the second CA's key, and so on, until a self\-signed "root" certificate is reached. Each certificate in the chain (after the first) thus authenticates the public key of the signer of the previous certificate in the chain. -.LP -Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs). In this case, the certificate chain must be established from trusted certificate information already stored in the keystore. -.LP -A different reply format (defined by the PKCS#7 standard) also includes the supporting certificate chain, in addition to the issued certificate. Both reply formats can be handled by \f3keytool\fP. -.LP -The top\-level (root) CA certificate is self\-signed. However, the trust into the root's public key does not come from the root certificate itself (anybody could generate a self\-signed certificate with the distinguished name of say, the VeriSign root CA!), but from other sources like a newspaper. The root CA public key is widely known. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a "vehicle" to transport the root CA's public key. Before you add the root CA certificate to your keystore, you should view it (using the \f2\-printcert\fP option) and compare the displayed fingerprint with the well\-known fingerprint (obtained from a newspaper, the root CA's Web page, etc.). -.TP 2 -o -\f3The cacerts Certificates File\fP -.LP -A certificates file named \f3"cacerts"\fP resides in the security properties directory, \f2java.home\fP/lib/security, where \f2java.home\fP is the runtime environment's directory (the \f2jre\fP directory in the SDK or the top\-level directory of the Java 2 Runtime Environment). -.LP -The "cacerts" file represents a system\-wide keystore with CA certificates. System administrators can configure and manage that file using \f3keytool\fP, specifying "jks" as the keystore type. The "cacerts" keystore file ships with a default set of root CA certificates; list them with the following command: -.nf -\f3 -.fl -keytool \-list \-keystore \fP\f4java.home\fP\f3/lib/security/cacerts -.fl -\fP -.fi -.LP -The initial password of the "cacerts" keystore file is "changeit". System administrators should change that password and the default access permission of that file upon installing the SDK. -.LP -\f3IMPORTANT: Verify Your \fP\f4cacerts\fP\f3 File\fP: Since you trust the CAs in the \f2cacerts\fP file as entities for signing and issuing certificates to other entities, you must manage the \f2cacerts\fP file carefully. The \f2cacerts\fP file should contain only certificates of the CAs you trust. It is your responsibility to verify the trusted root CA certificates bundled in the \f2cacerts\fP file and make your own trust decisions. To remove an untrusted CA certificate from the \f2cacerts\fP file, use the delete option of the \f2keytool\fP command. You can find the \f2cacerts\fP file in the JRE installation directory. Contact your system administrator if you do not have permission to edit this file. -.TP 2 -o -\f3The Internet RFC 1421 Certificate Encoding Standard\fP -.LP -Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding. This certificate format, also known as "Base 64 encoding", facilitates exporting certificates to other applications by email or through some other mechanism. -.LP -Certificates read by the \f2\-importcert\fP and \f2\-printcert\fP commands can be in either this format or binary encoded. -.LP -The \f2\-exportcert\fP command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, if the \f2\-rfc\fP option is specified. -.LP -The \f2\-list\fP command by default prints the SHA1 fingerprint of a certificate. If the \f2\-v\fP option is specified, the certificate is printed in human\-readable format, while if the \f2\-rfc\fP option is specified, the certificate is output in the printable encoding format. -.LP -In its printable encoding format, the encoded certificate is bounded at the beginning by -.nf -\f3 -.fl -\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\- -.fl -\fP -.fi -.LP -and at the end by -.nf -\f3 -.fl -\-\-\-\-\-END CERTIFICATE\-\-\-\-\- -.fl -\fP -.fi -.RE +A certificate (or public-key certificate) is a digitally signed statement from one entity (the issuer), saying that the public key and some other information of another entity (the subject) has some specific value\&. The following terms are related to certificates: -.LP -.SS -X.500 Distinguished Names -.LP -.LP -X.500 Distinguished Names are used to identify entities, such as those which are named by the \f2subject\fP and \f2issuer\fP (signer) fields of X.509 certificates. \f3keytool\fP supports the following subparts: -.LP -.RS 3 -.TP 2 -o -\f2commonName\fP \- common name of a person, e.g., "Susan Jones" -.TP 2 -o -\f2organizationUnit\fP \- small organization (e.g., department or division) name, e.g., "Purchasing" -.TP 2 -o -\f2organizationName\fP \- large organization name, e.g., "ABCSystems, Inc." -.TP 2 -o -\f2localityName\fP \- locality (city) name, e.g., "Palo Alto" -.TP 2 -o -\f2stateName\fP \- state or province name, e.g., "California" -.TP 2 -o -\f2country\fP \- two\-letter country code, e.g., "CH" -.RE +\fIPublic Keys\fR: These are numbers associated with a particular entity, and are intended to be known to everyone who needs to have trusted interactions with that entity\&. Public keys are used to verify signatures\&. -.LP -.LP -When supplying a distinguished name string as the value of a \f2\-dname\fP option, as for the \f2\-genkeypair\fP command, the string must be in the following format: -.LP -.nf -\f3 -.fl -CN=\fP\f4cName\fP\f3, OU=\fP\f4orgUnit\fP\f3, O=\fP\f4org\fP\f3, L=\fP\f4city\fP\f3, S=\fP\f4state\fP\f3, C=\fP\f4countryCode\fP\f3 -.fl -\fP -.fi +\fIDigitally Signed\fR: If some data is digitally signed, then it is stored with the identity of an entity and a signature that proves that entity knows about the data\&. The data is rendered unforgeable by signing with the entity\&'s private key\&. -.LP -.LP -where all the italicized items represent actual values and the above keywords are abbreviations for the following: -.LP -.nf -\f3 -.fl - CN=commonName -.fl - OU=organizationUnit -.fl - O=organizationName -.fl - L=localityName -.fl - S=stateName -.fl - C=country -.fl -\fP -.fi +\fIIdentity\fR: A known way of addressing an entity\&. In some systems, the identity is the public key, and in others it can be anything from an Oracle Solaris UID to an email address to an X\&.509 distinguished name\&. -.LP -.LP -A sample distinguished name string is -.LP -.nf -\f3 -.fl -CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US -.fl -\fP -.fi +\fISignature\fR: A signature is computed over some data using the private key of an entity\&. The signer, which in the case of a certificate is also known as the issuer\&. -.LP -.LP -and a sample command using such a string is -.LP -.nf -\f3 -.fl -keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, -.fl -S=California, C=US" \-alias mark -.fl -\fP -.fi +\fIPrivate Keys\fR: These are numbers, each of which is supposed to be known only to the particular entity whose private key it is (that is, it is supposed to be kept secret)\&. Private and public keys exist in pairs in all public key cryptography systems (also referred to as public key crypto systems)\&. In a typical public key crypto system, such as DSA, a private key corresponds to exactly one public key\&. Private keys are used to compute signatures\&. -.LP -.LP -Case does not matter for the keyword abbreviations. For example, "CN", "cn", and "Cn" are all treated the same. -.LP -.LP -Order matters; each subcomponent must appear in the designated order. However, it is not necessary to have all the subcomponents. You may use a subset, for example: -.LP -.nf -\f3 -.fl -CN=Steve Meier, OU=Java, O=Oracle, C=US -.fl -\fP -.fi +\fIEntity\fR: An entity is a person, organization, program, computer, business, bank, or something else you are trusting to some degree\&. -.LP -.LP -If a distinguished name string value contains a comma, the comma must be escaped by a "\\" character when you specify the string on a command line, as in -.LP -.nf -\f3 -.fl - cn=Peter Schuster, ou=Java\\, Product Development, o=Oracle, c=US -.fl -\fP -.fi +Public key cryptography requires access to users\&' public keys\&. In a large-scale networked environment, it is impossible to guarantee that prior relationships between communicating entities were established or that a trusted repository exists with all used public keys\&. Certificates were invented as a solution to this public key distribution problem\&. Now a Certification Authority (CA) can act as a trusted third party\&. CAs are entities such as businesses that are trusted to sign (issue) certificates for other entities\&. It is assumed that CAs only create valid and reliable certificates because they are bound by legal agreements\&. There are many public Certification Authorities, such as VeriSign, Thawte, Entrust, and so on\&. -.LP -.LP -It is never necessary to specify a distinguished name string on a command line. If it is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents. In this case, a comma does not need to be escaped by a "\\". -.LP -.SS -WARNING Regarding Importing Trusted Certificates -.LP -.LP -IMPORTANT: Be sure to check a certificate very carefully before importing it as a trusted certificate! -.LP -.LP -View it first (using the \f2\-printcert\fP command, or the \f2\-importcert\fP command without the \f2\-noprompt\fP option), and make sure that the displayed certificate fingerprint(s) match the expected ones. For example, suppose someone sends or emails you a certificate, and you put it in a file named \f2/tmp/cert\fP. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f2\-printcert\fP command to view its fingerprints, as in -.LP -.nf -\f3 -.fl - keytool \-printcert \-file /tmp/cert -.fl - Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll -.fl - Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll -.fl - Serial Number: 59092b34 -.fl - Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997 -.fl - Certificate Fingerprints: -.fl - MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F -.fl - SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE -.fl - SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90: -.fl - 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4 -.fl -\fP -.fi +You can also run your own Certification Authority using products such as Microsoft Certificate Server or the Entrust CA product for your organization\&. With the \f3keytool\fR command, it is possible to display, import, and export certificates\&. It is also possible to generate self-signed certificates\&. -.LP -.LP -Then call or otherwise contact the person who sent the certificate, and compare the fingerprint(s) that you see with the ones that they show. Only if the fingerprints are equal is it guaranteed that the certificate has not been replaced in transit with somebody else's (for example, an attacker's) certificate. If such an attack took place, and you did not check the certificate before you imported it, you would end up trusting anything the attacker has signed (for example, a JAR file with malicious class files inside). -.LP -.LP -Note: it is not required that you execute a \f2\-printcert\fP command prior to importing a certificate, since before adding a certificate to the list of trusted certificates in the keystore, the \f2\-importcert\fP command prints out the certificate information and prompts you to verify it. You then have the option of aborting the import operation. Note, however, this is only the case if you invoke the \f2\-importcert\fP command without the \f2\-noprompt\fP option. If the \f2\-noprompt\fP option is given, there is no interaction with the user. -.LP -.SS -Warning Regarding Passwords -.LP -.LP -Most commands operating on a keystore require the store password. Some commands require a private/secret key password. -.LP -.LP -Passwords can be specified on the command line (in the \f2\-storepass\fP and \f2\-keypass\fP options, respectively). However, a password should not be specified on a command line or in a script unless it is for testing purposes, or you are on a secure system. -.LP -.LP -If you don't specify a required password option on a command line, you will be prompted for it. -.LP -.SS -Warning Regarding Certificate Conformance -.LP -.LP -The Internet standard -.na -\f2RFC 5280\fP @ -.fi -http://tools.ietf.org/rfc/rfc5280.txt has defined a profile on conforming X.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions. \f3keytool\fP has not enforced all these rules so it can generate certificates which do not conform to the standard, and these certificates might be rejected by JRE or other applications. Users should make sure that they provide the correct options for \f2\-dname\fP, \f2\-ext\fP, etc. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -jar(1) tool documentation -.TP 2 -o -jarsigner(1) tool documentation -.TP 2 -o -the -.na -\f4Security\fP @ -.fi -http://download.oracle.com/javase/tutorial/security/index.html trail of the -.na -\f4Java Tutorial\fP @ -.fi -http://download.oracle.com/javase/tutorial/ for examples of the use of \f3keytool\fP -.RE +The \f3keytool\fR command currently handles X\&.509 certificates\&. +.TP +X\&.509 Certificates +The X\&.509 standard defines what information can go into a certificate and describes how to write it down (the data format)\&. All the data in a certificate is encoded with two related standards called ASN\&.1/DER\&. Abstract Syntax Notation 1 describes data\&. The Definite Encoding Rules describe a single way to store and transfer that data\&. -.LP -.SH "CHANGES" -.LP -.LP -The command interface for keytool changed in Java SE 6. -.LP -.LP -\f3keytool\fP no longer displays password input when entered by users. Since password input can no longer be viewed when entered, users will be prompted to re\-enter passwords any time a password is being set or changed (for example, when setting the initial keystore password, or when changing a key password). -.LP -.LP -Some commands have simply been renamed, and other commands deemed obsolete are no longer listed in this document. All previous commands (both renamed and obsolete) are still supported in this release and will continue to be supported in future releases. The following summarizes all of the changes made to the keytool command interface: -.LP -.LP -Renamed commands: -.LP -.RS 3 -.TP 2 -o -\f2\-export\fP, renamed to \f2\-exportcert\fP -.TP 2 -o -\f2\-genkey\fP, renamed to \f2\-genkeypair\fP -.TP 2 -o -\f2\-import\fP, renamed to \f2\-importcert\fP -.RE +All X\&.509 certificates have the following data, in addition to the signature: -.LP -.LP -Commands deemed obsolete and no longer documented: -.LP -.RS 3 -.TP 2 -o -.na -\f2\-keyclone\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#keycloneCmd -.TP 2 -o -.na -\f2\-identitydb\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#identitydbCmd -.TP 2 -o -.na -\f2\-selfcert\fP @ -.fi -http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/keytool.html#selfcertCmd -.RE +\fIVersion\fR: This identifies which version of the X\&.509 standard applies to this certificate, which affects what information can be specified in it\&. Thus far, three versions are defined\&. The \f3keytool\fR command can import and export v1, v2, and v3 certificates\&. It generates v3 certificates\&. -.LP - +X\&.509 Version 1 has been available since 1988, is widely deployed, and is the most generic\&. + +X\&.509 Version 2 introduced the concept of subject and issuer unique identifiers to handle the possibility of reuse of subject or issuer names over time\&. Most certificate profile documents strongly recommend that names not be reused and that certificates should not make use of unique identifiers\&. Version 2 certificates are not widely used\&. + +X\&.509 Version 3 is the most recent (1996) and supports the notion of extensions where anyone can define an extension and include it in the certificate\&. Some common extensions are: KeyUsage (limits the use of the keys to particular purposes such as \f3signing-only\fR) and AlternativeNames (allows other identities to also be associated with this public key, for example\&. DNS names, email addresses, IP addresses)\&. Extensions can be marked critical to indicate that the extension should be checked and enforced or used\&. For example, if a certificate has the KeyUsage extension marked critical and set to \f3keyCertSign\fR, then when this certificate is presented during SSL communication, it should be rejected because the certificate extension indicates that the associated private key should only be used for signing certificates and not for SSL use\&. + +\fISerial number\fR: The entity that created the certificate is responsible for assigning it a serial number to distinguish it from other certificates it issues\&. This information is used in numerous ways\&. For example, when a certificate is revoked its serial number is placed in a Certificate Revocation List (CRL)\&. + +\fISignature algorithm identifier\fR: This identifies the algorithm used by the CA to sign the certificate\&. + +\fIIssuer name\fR: The X\&.500 Distinguished Name of the entity that signed the certificate\&. See X\&.500 Distinguished Names\&. This is typically a CA\&. Using this certificate implies trusting the entity that signed this certificate\&. In some cases, such as root or top-level CA certificates, the issuer signs its own certificate\&. + +\fIValidity period\fR: Each certificate is valid only for a limited amount of time\&. This period is described by a start date and time and an end date and time, and can be as short as a few seconds or almost as long as a century\&. The validity period chosen depends on a number of factors, such as the strength of the private key used to sign the certificate, or the amount one is willing to pay for a certificate\&. This is the expected period that entities can rely on the public value, when the associated private key has not been compromised\&. + +\fISubject name\fR: The name of the entity whose public key the certificate identifies\&. This name uses the X\&.500 standard, so it is intended to be unique across the Internet\&. This is the X\&.500 Distinguished Name (DN) of the entity\&. See X\&.500 Distinguished Names\&. For example, +.sp +.nf +\f3CN=Java Duke, OU=Java Software Division, O=Oracle Corporation, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +These refer to the subject\&'s common name (CN), organizational unit (OU), organization (O), and country (C)\&. + +\fISubject public key information\fR: This is the public key of the entity being named with an algorithm identifier that specifies which public key crypto system this key belongs to and any associated key parameters\&. +.TP +Certificate Chains +The \f3keytool\fR command can create and manage keystore key entries that each contain a private key and an associated certificate chain\&. The first certificate in the chain contains the public key that corresponds to the private key\&. + +When keys are first generated, the chain starts off containing a single element, a self-signed certificate\&. See \f3-genkeypair\fR in Commands\&. A self-signed certificate is one for which the issuer (signer) is the same as the subject\&. The subject is the entity whose public key is being authenticated by the certificate\&. Whenever the \f3-genkeypair\fR command is called to generate a new public/private key pair, it also wraps the public key into a self-signed certificate\&. + +Later, after a Certificate Signing Request (CSR) was generated with the \f3-certreq\fR command and sent to a Certification Authority (CA), the response from the CA is imported with \f3-importcert\fR, and the self-signed certificate is replaced by a chain of certificates\&. See the \f3-certreq\fR and \f3-importcert\fR options in Commands\&. At the bottom of the chain is the certificate (reply) issued by the CA authenticating the subject\&'s public key\&. The next certificate in the chain is one that authenticates the CA\&'s public key\&. + +In many cases, this is a self-signed certificate, which is a certificate from the CA authenticating its own public key, and the last certificate in the chain\&. In other cases, the CA might return a chain of certificates\&. In this case, the bottom certificate in the chain is the same (a certificate signed by the CA, authenticating the public key of the key entry), but the second certificate in the chain is a certificate signed by a different CA that authenticates the public key of the CA you sent the CSR to\&. The next certificate in the chain is a certificate that authenticates the second CA\&'s key, and so on, until a self-signed root certificate is reached\&. Each certificate in the chain (after the first) authenticates the public key of the signer of the previous certificate in the chain\&. + +Many CAs only return the issued certificate, with no supporting chain, especially when there is a flat hierarchy (no intermediates CAs)\&. In this case, the certificate chain must be established from trusted certificate information already stored in the keystore\&. + +A different reply format (defined by the PKCS #7 standard) includes the supporting certificate chain in addition to the issued certificate\&. Both reply formats can be handled by the \f3keytool\fR command\&. + +The top-level (root) CA certificate is self-signed\&. However, the trust into the root\&'s public key does not come from the root certificate itself, but from other sources such as a newspaper\&. This is because anybody could generate a self-signed certificate with the distinguished name of, for example, the VeriSign root CA\&. The root CA public key is widely known\&. The only reason it is stored in a certificate is because this is the format understood by most tools, so the certificate in this case is only used as a vehicle to transport the root CA\&'s public key\&. Before you add the root CA certificate to your keystore, you should view it with the \f3-printcert\fR option and compare the displayed fingerprint with the well-known fingerprint obtained from a newspaper, the root CA\&'s Web page, and so on\&. +.TP +The cacerts Certificates File +A certificates file named \f3cacerts\fR resides in the security properties directory, \f3java\&.home\elib\esecurity\fR on Windows and \f3java\&.home/lib/security\fR on Oracle Solaris, where \f3java\&.home\fR is the runtime environment\&'s directory, which would be the \f3jre\fR directory in the SDK or the top-level directory of the JRE\&. + +The \f3cacerts\fR file represents a system-wide keystore with CA certificates\&. System administrators can configure and manage that file with the \f3keytool\fR command by specifying \f3jks\fR as the keystore type\&. The \f3cacerts\fR keystore file ships with a default set of root CA certificates\&. You can list the default certificates with the following command: +.sp +.nf +\f3keytool \-list \-keystore java\&.home/lib/security/cacerts\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The initial password of the \f3cacerts\fR keystore file is \f3changeit\fR\&. System administrators should change that password and the default access permission of that file upon installing the SDK\&. + +\fINote:\fR It is important to verify your \f3cacerts\fR file\&. Because you trust the CAs in the \f3cacerts\fR file as entities for signing and issuing certificates to other entities, you must manage the \f3cacerts\fR file carefully\&. The \f3cacerts\fR file should contain only certificates of the CAs you trust\&. It is your responsibility to verify the trusted root CA certificates bundled in the \f3cacerts\fR file and make your own trust decisions\&. + +To remove an untrusted CA certificate from the \f3cacerts\fR file, use the \f3delete\fR option of the \f3keytool\fR command\&. You can find the \f3cacerts\fR file in the JRE installation directory\&. Contact your system administrator if you do not have permission to edit this file +.TP +Internet RFC 1421 Certificate Encoding Standard +Certificates are often stored using the printable encoding format defined by the Internet RFC 1421 standard, instead of their binary encoding\&. This certificate format, also known as Base64 encoding, makes it easy to export certificates to other applications by email or through some other mechanism\&. + +Certificates read by the \f3-importcert\fR and \f3-printcert\fR commands can be in either this format or binary encoded\&. The \f3-exportcert\fR command by default outputs a certificate in binary encoding, but will instead output a certificate in the printable encoding format, when the \f3-rfc\fR option is specified\&. + +The \f3-list\fR command by default prints the SHA1 fingerprint of a certificate\&. If the \f3-v\fR option is specified, then the certificate is printed in human-readable format\&. If the \f3-rfc\fR option is specified, then the certificate is output in the printable encoding format\&. + +In its printable encoding format, the encoded certificate is bounded at the beginning and end by the following text: +.sp +.nf +\f3\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3encoded certificate goes here\&. \fP +.fi +.nf +\f3\fP +.fi +.nf +\f3\-\-\-\-\-END CERTIFICATE\-\-\-\-\-\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +X\&.500 Distinguished Names +X\&.500 Distinguished Names are used to identify entities, such as those that are named by the \f3subject\fR and \f3issuer\fR (signer) fields of X\&.509 certificates\&. The \f3keytool\fR command supports the following subparts: + +\fIcommonName\fR: The common name of a person such as Susan Jones\&. + +\fIorganizationUnit\fR: The small organization (such as department or division) name\&. For example, Purchasing\&. + +\fIlocalityName\fR: The locality (city) name, for example, Palo Alto\&. + +\fIstateName\fR: State or province name, for example, California\&. + +\fIcountry\fR: Two-letter country code, for example, CH\&. + +When you supply a distinguished name string as the value of a \f3-dname\fR option, such as for the \f3-genkeypair\fR command, the string must be in the following format: +.sp +.nf +\f3CN=cName, OU=orgUnit, O=org, L=city, S=state, C=countryCode\fP +.fi +.nf +\f3\fP +.fi +.sp + + +All the italicized items represent actual values and the previous keywords are abbreviations for the following: +.sp +.nf +\f3CN=commonName\fP +.fi +.nf +\f3OU=organizationUnit\fP +.fi +.nf +\f3O=organizationName\fP +.fi +.nf +\f3L=localityName\fP +.fi +.nf +\f3S=stateName\fP +.fi +.nf +\f3C=country\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample distinguished name string is: +.sp +.nf +\f3CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino, S=California, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +A sample command using such a string is: +.sp +.nf +\f3keytool \-genkeypair \-dname "CN=Mark Smith, OU=Java, O=Oracle, L=Cupertino,\fP +.fi +.nf +\f3S=California, C=US" \-alias mark\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Case does not matter for the keyword abbreviations\&. For example, CN, cn, and Cn are all treated the same\&. + +Order matters; each subcomponent must appear in the designated order\&. However, it is not necessary to have all the subcomponents\&. You can use a subset, for example: +.sp +.nf +\f3CN=Steve Meier, OU=Java, O=Oracle, C=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +If a distinguished name string value contains a comma, then the comma must be escaped by a backslash (\e) character when you specify the string on a command line, as in: +.sp +.nf +\f3cn=Peter Schuster, ou=Java\e, Product Development, o=Oracle, c=US\fP +.fi +.nf +\f3\fP +.fi +.sp + + +It is never necessary to specify a distinguished name string on a command line\&. When the distinguished name is needed for a command, but not supplied on the command line, the user is prompted for each of the subcomponents\&. In this case, a comma does not need to be escaped by a backslash (\e)\&. +.SH WARNINGS +.SS IMPORTING\ TRUSTED\ CERTIFICATES\ WARNING +\fIImportant\fR: Be sure to check a certificate very carefully before importing it as a trusted certificate\&. +.PP +Windows Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose sends or emails you a certificate that you put it in a file named \f3\etmp\ecert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file \etmp\ecert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.sp + +.PP +Oracle Solaris Example: + +View the certificate first with the \f3-printcert\fR command or the \f3-importcert\fR command without the \f3-noprompt\fR option\&. Ensure that the displayed certificate fingerprints match the expected ones\&. For example, suppose someone sends or emails you a certificate that you put it in a file named \f3/tmp/cert\fR\&. Before you consider adding the certificate to your list of trusted certificates, you can execute a \f3-printcert\fR command to view its fingerprints, as follows: +.sp +.nf +\f3 keytool \-printcert \-file /tmp/cert\fP +.fi +.nf +\f3 Owner: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Issuer: CN=ll, OU=ll, O=ll, L=ll, S=ll, C=ll\fP +.fi +.nf +\f3 Serial Number: 59092b34\fP +.fi +.nf +\f3 Valid from: Thu Sep 25 18:01:13 PDT 1997 until: Wed Dec 24 17:01:13 PST 1997\fP +.fi +.nf +\f3 Certificate Fingerprints:\fP +.fi +.nf +\f3 MD5: 11:81:AD:92:C8:E5:0E:A2:01:2E:D4:7A:D7:5F:07:6F\fP +.fi +.nf +\f3 SHA1: 20:B6:17:FA:EF:E5:55:8A:D0:71:1F:E8:D6:9D:C0:37:13:0E:5E:FE\fP +.fi +.nf +\f3 SHA256: 90:7B:70:0A:EA:DC:16:79:92:99:41:FF:8A:FE:EB:90:\fP +.fi +.nf +\f3 17:75:E0:90:B2:24:4D:3A:2A:16:A6:E4:11:0F:67:A4\fP +.fi +.nf +\f3\fP +.fi +.sp +Then call or otherwise contact the person who sent the certificate and compare the fingerprints that you see with the ones that they show\&. Only when the fingerprints are equal is it guaranteed that the certificate was not replaced in transit with somebody else\&'s certificate such as an attacker\&'s certificate\&. If such an attack took place, and you did not check the certificate before you imported it, then you would be trusting anything the attacker signed, for example, a JAR file with malicious class files inside\&. +.PP +\fINote:\fR It is not required that you execute a \f3-printcert\fR command before importing a certificate\&. This is because before you add a certificate to the list of trusted certificates in the keystore, the \f3-importcert\fR command prints out the certificate information and prompts you to verify it\&. You can then stop the import operation\&. However, you can do this only when you call the \f3-importcert\fR command without the \f3-noprompt\fR option\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS PASSWORDS\ WARNING +Most commands that operate on a keystore require the store password\&. Some commands require a private/secret key password\&. Passwords can be specified on the command line in the \f3-storepass\fR and \f3-keypass\fR options\&. However, a password should not be specified on a command line or in a script unless it is for testing, or you are on a secure system\&. When you do not specify a required password option on a command line, you are prompted for it\&. +.SS CERTIFICATE\ CONFORMANCE\ WARNING +The Internet standard RFC 5280 has defined a profile on conforming X\&.509 certificates, which includes what values and value combinations are valid for certificate fields and extensions\&. See the standard at http://tools\&.ietf\&.org/rfc/rfc5280\&.txt +.PP +The \f3keytool\fR command does not enforce all of these rules so it can generate certificates that do not conform to the standard\&. Certificates that do not conform to the standard might be rejected by JRE or other applications\&. Users should ensure that they provide the correct options for \f3-dname\fR, \f3-ext\fR, and so on\&. +.SH NOTES +.SS IMPORT\ A\ NEW\ TRUSTED\ CERTIFICATE +Before you add the certificate to the keystore, the \f3keytool\fR command verifies it by attempting to construct a chain of trust from that certificate to a self-signed certificate (belonging to a root CA), using trusted certificates that are already available in the keystore\&. +.PP +If the \f3-trustcacerts\fR option was specified, then additional certificates are considered for the chain of trust, namely the certificates in a file named \f3cacerts\fR\&. +.PP +If the \f3keytool\fR command fails to establish a trust path from the certificate to be imported up to a self-signed certificate (either from the keystore or the \f3cacerts\fR file), then the certificate information is printed, and the user is prompted to verify it by comparing the displayed certificate fingerprints with the fingerprints obtained from some other (trusted) source of information, which might be the certificate owner\&. Be very careful to ensure the certificate is valid before importing it as a trusted certificate\&. See Importing Trusted Certificates Warning\&. The user then has the option of stopping the import operation\&. If the \f3-noprompt\fR option is specified, then there is no interaction with the user\&. +.SS IMPORT\ A\ CERTIFICATE\ REPLY +When you import a certificate reply, the certificate reply is validated with trusted certificates from the keystore, and optionally, the certificates configured in the \f3cacerts\fR keystore file when the \f3-trustcacert\fR\f3s\fR option is specified\&. See The cacerts Certificates File\&. +.PP +The methods of determining whether the certificate reply is trusted are as follows: +.TP 0.2i +\(bu +If the reply is a single X\&.509 certificate, then the \f3keytool\fR command attempts to establish a trust chain, starting at the certificate reply and ending at a self-signed certificate (belonging to a root CA)\&. The certificate reply and the hierarchy of certificates is used to authenticate the certificate reply from the new certificate chain of aliases\&. If a trust chain cannot be established, then the certificate reply is not imported\&. In this case, the \f3keytool\fR command does not print the certificate and prompt the user to verify it, because it is very difficult for a user to determine the authenticity of the certificate reply\&. +.TP 0.2i +\(bu +If the reply is a PKCS #7 formatted certificate chain or a sequence of X\&.509 certificates, then the chain is ordered with the user certificate first followed by zero or more CA certificates\&. If the chain ends with a self-signed root CA certificate and the\f3-trustcacerts\fR option was specified, the \f3keytool\fR command attempts to match it with any of the trusted certificates in the keystore or the \f3cacerts\fR keystore file\&. If the chain does not end with a self-signed root CA certificate and the \f3-trustcacerts\fR option was specified, the \f3keytool\fR command tries to find one from the trusted certificates in the keystore or the \f3cacerts\fR keystore file and add it to the end of the chain\&. If the certificate is not found and the \f3-noprompt\fR option is not specified, the information of the last certificate in the chain is printed, and the user is prompted to verify it\&. +.PP +If the public key in the certificate reply matches the user\&'s public key already stored with \f3alias\fR, then the old certificate chain is replaced with the new certificate chain in the reply\&. The old chain can only be replaced with a valid \f3keypass\fR, and so the password used to protect the private key of the entry is supplied\&. If no password is provided, and the private key password is different from the keystore password, the user is prompted for it\&. +.PP +This command was named \f3-import\fR in earlier releases\&. This old name is still supported in this release\&. The new name, \f3-importcert\fR, is preferred going forward\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Trail: Security Features in Java SE at http://docs\&.oracle\&.com/javase/tutorial/security/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/native2ascii.1 b/jdk/src/solaris/doc/sun/man/man1/native2ascii.1 index 54beff1d0ab..7e7ec7cfaa9 100644 --- a/jdk/src/solaris/doc/sun/man/man1/native2ascii.1 +++ b/jdk/src/solaris/doc/sun/man/man1/native2ascii.1 @@ -1,72 +1,87 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH native2ascii 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Internationalization Tools +.\" Title: native2ascii.1 +.\" +.if n .pl 99999 +.TH native2ascii 1 "21 November 2013" "JDK 8" "Internationalization Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -native2ascii \- Native\-to\-ASCII Converter -.LP -.LP -Converts a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes, or visa versa. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f4native2ascii\fP\f2 [options] [inputfile [outputfile]]\fP -.fl -.fi +.SH NAME +native2ascii \- Creates localizable applications by converting a file with characters in any supported character encoding to one with ASCII and/or Unicode escapes or vice versa\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f2native2ascii\fP converts files that are encoded to any character encoding that is supported by the Java runtime environment to files encoded in ASCII, using Unicode escapes ("\\uxxxx" notation) for all characters that are not part of the ASCII character set. This process is required for properties files containing characters not in ISO\-8859\-1 character sets. The tool can also perform the reverse conversion. -.LP -.LP -If \f2outputfile\fP is omitted, standard output is used for output. If, in addition, \f2inputfile\fP is omitted, standard input is used for input. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-reverse -Perform the reverse operation: Convert a file encoded in ISO\-8859\-1 with Unicode escapes to a file in any character encoding supported by the Java runtime environment. +\fBnative2ascii\fR [ \fIinputfile\fR ] [ \fIoutputfile\fR ] +.fi +.sp +.TP +\fIinputfile\fR +The encoded file to be converted to ASCII\&. +.TP +\fIoutputfile\fR +The converted ASCII file\&. +.SH DESCRIPTION +The \f3native2ascii\fR command converts encoded files supported by the Java Runtime Environment (JRE) to files encoded in ASCII, using Unicode escapes (\f3\eu\fR\fIxxxx\fR) notation for all characters that are not part of the ASCII character set\&. This process is required for properties files that contain characters not in ISO-8859-1 character sets\&. The tool can also perform the reverse conversion\&. +.PP +If the \f3outputfile\fR value is omitted, then standard output is used for output\&. If, in addition, the \f3inputfile\fR value is omitted, then standard input is used for input\&. +.SH OPTIONS +.TP +-reverse .br +Perform the reverse operation: Converts a file encoded in ISO-8859-1 with Unicode escapes to a file in any character encoding supported by the JRE\&. +.TP +-encoding \fIencoding_name\fR .br -.TP 3 -\-encoding encoding_name -Specifies the name of the character encoding to be used by the conversion procedure. If this option is not present, the default character encoding (as determined by the \f2java.nio.charset.Charset.defaultCharset\fP method) is used. The \f2encoding_name\fP string must be the name of a character encoding that is supported by the Java runtime environment \- see the -.na -\f4Supported Encodings\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html document. +Specifies the name of the character encoding to be used by the conversion procedure\&. If this option is not present, then the default character encoding (as determined by the \f3java\&.nio\&.charset\&.Charset\&.defaultCharset\fR method) is used\&. The \f3encoding_name\fR string must be the name of a character encoding that is supported by the JRE\&. See Supported Encodings at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/intl/encoding\&.doc\&.html +.TP +-J\fIoption\fR .br -.br -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP - +Passes \f3option\fR to the Java Virtual Machine (JVM), where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/orbd.1 b/jdk/src/solaris/doc/sun/man/man1/orbd.1 index 108ad9e1ce2..1575df4bdea 100644 --- a/jdk/src/solaris/doc/sun/man/man1/orbd.1 +++ b/jdk/src/solaris/doc/sun/man/man1/orbd.1 @@ -1,368 +1,214 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH orbd 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: orbd.1 +.\" +.if n .pl 99999 +.TH orbd 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -orbd \- The Object Request Broker Daemon -.LP -.LP -\f3orbd\fP is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. -.LP -.LP -\f3See also:\fP -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -orbd <\fP\f3options\fP\f3> -.fl -\fP -.fi +.SH NAME +orbd \- Enables clients to locate and call persistent objects on servers in the CORBA environment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The Server Manager included with the \f3orbd\fP tool is used to enable clients to transparently locate and invoke persistent objects on servers in the CORBA environment. The persistent servers, while publishing the persistent object references in the Naming Service, include the port number of the ORBD in the object reference instead of the port number of the Server. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages: -.LP -.RS 3 -.TP 2 -o -The object reference in the Naming Service remains independent of the server life cycle. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shutdown, the ORBD will always return the correct object reference to the invoking client. -.TP 2 -o -The client needs to lookup the object reference in the Naming Service only once, and can keep re\-using this reference independent of the changes introduced due to server life cycle. -.RE - -.LP -.LP -To access ORBD's Server Manager, the server must be started using servertool(1), which is a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. For more information on the Server Manager, see the section in this document titled \f2Server Manager\fP. -.LP -.LP -When \f2orbd\fP starts up, it also starts a naming service. For more information on the naming service, link to -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html. -.LP -.SH "OPTIONS" -.LP -.SS -Required Options -.LP -.RS 3 -.TP 3 -\-ORBInitialPort nameserverport -Specifies the port on which the name server should be started. Once started, \f2orbd\fP will listen for incoming requests on this port. Note that when using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. (required) -.RE - -.LP -.LP - -.LP -.SS -OTHER OPTIONS -.LP -.RS 3 -.TP 3 -\-port port -Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects. The default value for this port is 1049. This port number is added to the port field of the persistent Interoperable Object References (IOR). (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-defaultdb directory -Specifies the base where the ORBD persistent storage directory \f2orb.db\fP is created. If this option is not specified, the default value is "./orb.db". (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-serverPollingTime milliseconds -Specifies how often ORBD checks for the health of persistent servers registered via \f2servertool\fP. The default value is 1,000 ms. The value specified for \f2milliseconds\fP must be a valid positive integer. (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-serverStartupDelay milliseconds -Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered via \f2servertool\fP is restarted. The default value is 1,000 ms. The value specified for \f2milliseconds\fP must be a valid positive integer. (optional) -.RE - -.LP -.RS 3 -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.TP 3 - -.RE - -.LP -.SH "Starting and Stopping the Naming Service" -.LP -.LP -A Naming Service is a CORBA service that allows -.na -\f2CORBA objects\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#CORBA%20object to be named by means of binding a name to an object reference. The -.na -\f2name binding\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlGlossary.html#name%20binding may be stored in the naming service, and a client may supply the name to obtain the desired object reference. -.LP -.LP -Prior to running a client or a server, you will start ORBD. ORBD includes a persistent Naming Service and a transient Naming Service, both of which are an implementation of the COS Naming Service. -.LP -.LP -The \f4Persistent\fP\f3 Naming Service\fP provides persistence for naming contexts. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure. If ORBD is restarted, the Persistent Naming Service will restore the naming context graph, so that the binding of all clients' and servers' names remains intact (persistent). -.LP -.LP -\ -.LP -.LP -For backward compatibility, \f2tnameserv\fP, a \f4Transient\fP\f3 Naming Service\fP shipped with older versions of the JDK, is also included in this release of J2SE. A transient naming service retains naming contexts as long as it is running. If there is a service interruption, the naming context graph is lost. -.LP -.LP -The \f2\-ORBInitialPort\fP argument is a required command\-line argument for \f2orbd\fP, and is used to set the port number on which the Naming Service will run. The following instructions assume you can use port 1050 for the Java\ IDL Object Request Broker Daemon. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. You can substitute a different port if necessary. -.LP -.LP -To start \f2orbd\fP from a UNIX command shell, enter: -.LP -.nf -\f3 -.fl - orbd \-ORBInitialPort 1050& -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Now that ORBD is running, you can run your server and client applications. When running the client and server applications, they must be made aware of the port number (and machine name, if applicable) where the Naming Service is running. One way to do this is to add the following code to your application: -.LP -.nf -\f3 -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - props.put("org.omg.CORBA.ORBInitialHost", "MyHost"); -.fl - ORB orb = ORB.init(args, props); -.fl -\fP -.fi - -.LP -.LP -In this example, the Naming Service is running on port 1050 on host "MyHost". Another way is to specify the port number and/or machine name when running the server or client application from the command line. For example, you would start your "HelloApplication" with the following command line: -.LP -.nf -\f3 -.fl - java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost -.fl -\fP -.fi - -.LP -.LP -To stop the naming service, use the relevant operating system command, such as \f2pkill orbd\fP on Solaris, or \f2Ctrl+C\fP in the DOS window in which \f2orbd\fP is running. Note that names registered with the naming service may disappear when the service is terminated if the naming service is transient. The Java IDL naming service will run until it is explicitly stopped. -.LP -.LP -For more information on the Naming Service included with ORBD, see -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html. -.LP -.SH "Server Manager" -.LP -.LP -To access ORBD's Server Manager and run a persistent server, the server must be started using servertool(1), which is a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. When a server is started using \f2servertool\fP, it must be started on the same host and port on which \f2orbd\fP is executing. If the server is run on a different port, the information stored in the database for local contexts will be invalid and the service will not work properly. -.LP -.SS -Server Manager: an Example -.LP -.LP -Using the -.na -\f2sample tutorial\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlExample.html for our demonstration, you would run the \f2idlj\fP compiler and \f2javac\fP compiler as shown in the tutorial. To run the Server Manager, follow these steps for running the application: -.LP -.LP -Start \f2orbd\fP. -.LP -.LP -To start \f2orbd\fP from a UNIX command shell, enter: -.LP -.LP -\ -.LP -.nf -\f3 -.fl - orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start orbd \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Note that \f21050\fP is the port on which you want the name server to run. \f2\-ORBInitialPort\fP is a required command\-line argument. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. -.LP -.LP -Start the \f2servertool\fP: -.LP -.LP -To start the Hello server, enter: -.LP -.nf -\f3 -.fl - servertool \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Make sure the name server (\f2orbd\fP) port is the same as in the previous step, for example, \f2\-ORBInitialPort 1050\fP. The \f2servertool\fP must be started on the same port as the name server. -.LP -.LP -The \f2servertool\fP command line interface appears. -.LP -.LP - -.LP -.LP -Start the Hello server from the \f2servertool\fP prompt: -.LP -.nf -\f3 -.fl - servertool > register \-server HelloServer \-classpath . \-applicationName -.fl - HelloServerApName -.fl -\fP -.fi - -.LP -.LP -The \f2servertool\fP registers the server, assigns it the name of "HelloServerApName", and displays its server id, along with a listing of all registered servers. -.LP -.LP - -.LP -.LP -Run the client application from another terminal window or prompt: -.LP -.LP -\ -.LP -.nf -\f3 -.fl - java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost -.fl -\fP -.fi - -.LP -.LP -For this example, you can omit \f2\-ORBInitialHost localhost\fP since the name server is running on the same host as the Hello client. If the name server is running on a different host, use \f2\-ORBInitialHost\fP \f2nameserverhost\fP to specify the host on which the IDL name server is running. -.LP -.LP -Specify the name server (\f2orbd\fP) port as done in the previous step, for example, \f2\-ORBInitialPort 1050\fP. -.LP -.LP -\ -.LP -.LP -\ -.LP -.LP -When you have finished experimenting with the Server Manager, be sure to shut down or kill the name server (\f2orbd\fP) and \f2servertool\fP. -.LP -.LP -To shut down \f2orbd\fP from a DOS prompt, select the window that is running the server and enter \f2Ctrl+C\fP to shut it down. To shut down \f2orbd\fPfrom a Unix shell, find the process, and kill it. The server will continue to wait for invocations until it is explicitly stopped. -.LP -.LP -To shut down the \f2servertool\fP, type \f2quit\fP and press the \f2Enter\fP key on the keyboard. -.LP -.SH "See Also" -.LP -.RS 3 -.TP 2 -o -.na -\f2Naming Service\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html +\fBorbd\fR [ \fIoptions\fR ] +.fi +.sp +.TP +\fIoptions\fR +Command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3orbd\fR command enables clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The Server Manager included with the orbd tool is used to enable clients to transparently locate and call persistent objects on servers in the CORBA environment\&. The persistent servers, while publishing the persistent object references in the naming service, include the port number of the ORBD in the object reference instead of the port number of the server\&. The inclusion of an ORBD port number in the object reference for persistent object references has the following advantages: +.TP 0.2i +\(bu +The object reference in the naming service remains independent of the server life cycle\&. For example, the object reference could be published by the server in the Naming Service when it is first installed, and then, independent of how many times the server is started or shut down, the ORBD returns the correct object reference to the calling client\&. +.TP 0.2i +\(bu +The client needs to look up the object reference in the naming service only once, and can keep reusing this reference independent of the changes introduced due to server life cycle\&. +.PP +To access the ORBD Server Manager, the server must be started using \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. For more information on the Server Manager, see Server Manager\&. +.PP +When \f3orbd\fR starts, it also starts a naming service\&. For more information about the naming service\&. See Start and Stop the Naming Service\&. +.SH OPTIONS +.TP +-ORBInitialPort \fInameserverport\fR .br -.TP 2 -o -servertool(1) -.RE - -.LP +Required\&. Specifies the port on which the name server should be started\&. After it is started, \f3orbd\fR listens for incoming requests on this port\&. On Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, Oracle recommends that you use a port number above or equal to 1024\&. +.SS NONREQUIRED\ OPTIONS +.TP +-port \fIport\fR .br - -.LP - +Specifies the activation port where ORBD should be started, and where ORBD will be accepting requests for persistent objects\&. The default value for this port is 1049\&. This port number is added to the port field of the persistent Interoperable Object References (IOR)\&. +.TP +-defaultdb \fIdirectory\fR +.br +Specifies the base where the ORBD persistent storage directory, \f3orb\&.db\fR, is created\&. If this option is not specified, then the default value is \f3\&./orb\&.db\fR\&. +.TP +-serverPollingTime \fImilliseconds\fR +.br +Specifies how often ORBD checks for the health of persistent servers registered through \f3servertool\fR\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-serverStartupDelay milliseconds +.br +Specifies how long ORBD waits before sending a location forward exception after a persistent server that is registered through \f3servertool\fR is restarted\&. The default value is 1000 ms\&. The value specified for \f3milliseconds\fR must be a valid positive integer\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SS START\ AND\ STOP\ THE\ NAMING\ SERVICE +A naming service is a CORBA service that allows CORBA objects to be named by means of binding a name to an object reference\&. The name binding can be stored in the naming service, and a client can supply the name to obtain the desired object reference\&. +.PP +Before running a client or a server, you will start ORBD\&. ORBD includes a persistent naming service and a transient naming service, both of which are an implementation of the COS Naming Service\&. +.PP +The Persistent Naming Service provides persistence for naming contexts\&. This means that this information is persistent across service shutdowns and startups, and is recoverable in the event of a service failure\&. If ORBD is restarted, then the Persistent Naming Service restores the naming context graph, so that the binding of all clients\&' and servers\&' names remains intact (persistent)\&. +.PP +For backward compatibility, \f3tnameserv\fR, a Transient Naming Service that shipped with earlier releases of the JDK, is also included in this release of Java SE\&. A transient naming service retains naming contexts as long as it is running\&. If there is a service interruption, then the naming context graph is lost\&. +.PP +The \f3-ORBInitialPort\fR argument is a required command-line argument for \f3orbd\fR, and is used to set the port number on which the naming service runs\&. The following instructions assume you can use port 1050 for the Java IDL Object Request Broker Daemon\&. When using Oracle Solaris software, you must become a root user to start a process on a port lower than 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. You can substitute a different port when necessary\&. +.PP +To start \f3orbd\fR from a UNIX command shell, enter: +.sp +.nf +\f3orbd \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start orbd \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Now that ORBD is running, you can run your server and client applications\&. When running the client and server applications, they must be made aware of the port number (and machine name, when applicable) where the Naming Service is running\&. One way to do this is to add the following code to your application: +.sp +.nf +\f3Properties props = new Properties();\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3props\&.put("org\&.omg\&.CORBA\&.ORBInitialHost", "MyHost");\fP +.fi +.nf +\f3ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, the naming service is running on port 1050 on host \f3MyHost\fR\&. Another way is to specify the port number and/or machine name when running the server or client application from the command line\&. For example, you would start your \f3HelloApplication\fR with the following command line: +.sp +.nf +\f3java HelloApplication \-ORBInitialPort 1050 \-ORBInitialHost MyHost\fP +.fi +.nf +\f3\fP +.fi +.sp +To stop the naming service, use the relevant operating system command, such as \f3pkill\fR\f3orbd\fR on Oracle Solaris, or \fICtrl+C\fR in the DOS window in which \f3orbd\fR is running\&. Note that names registered with the naming service can disappear when the service is terminated because of a transient naming service\&. The Java IDL naming service will run until it is explicitly stopped\&. +.PP +For more information about the naming service included with ORBD, see Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.SH SERVER\ MANAGER +To access the ORBD Server Manager and run a persistent server, the server must be started with \f3servertool\fR, which is a command-line interface for application programmers to register, unregister, start up, and shut down a persistent server\&. When a server is started using \f3servertool\fR, it must be started on the same host and port on which \f3orbd\fR is executing\&. If the server is run on a different port, then the information stored in the database for local contexts will be invalid and the service will not work properly\&. +.PP +See Java IDL: The "Hello World" Example at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlExample\&.html +.PP +In this example, you run the \f3idlj\fR compiler and \f3javac\fR compiler as shown in the tutorial\&. To run the ORBD Server Manager, follow these steps for running the application: +.PP +Start \f3orbd\fR\&. +.PP +UNIX command shell, enter: \f3orbd -ORBInitialPort 1050\fR\&. +.PP +MS-DOS system prompt (Windows), enter: \f3s\fR\f3tart orbd -ORBInitialPort 105\fR\f30\fR\&. +.PP +Port 1050 is the port on which you want the name server to run\&. The \f3-ORBInitialPort\fR option is a required command-line argument\&. When using Oracle Solaris software, you must become a root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number above or equal to 1024\&. +.PP +Start the \f3servertool\fR: \f3servertool -ORBInitialPort 1050\fR\&. +.PP +Make sure the name server (\f3orbd\fR) port is the same as in the previous step, for example, \f3-ORBInitialPort 1050\&.\fR The \f3servertool\fR must be started on the same port as the name server\&. +.PP +In the \f3servertool\fR command line interface, start the \f3Hello\fR server from the \f3servertool\fR prompt: +.sp +.nf +\f3servertool > register \-server HelloServer \-classpath \&. \-applicationName\fP +.fi +.nf +\f3 HelloServerApName\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3servertool\fR registers the server, assigns it the name \f3HelloServerApName\fR, and displays its server ID with a listing of all registered servers\&.Run the client application from another terminal window or prompt: +.sp +.nf +\f3java HelloClient \-ORBInitialPort 1050 \-ORBInitialHost localhost\fP +.fi +.nf +\f3\fP +.fi +.sp +For this example, you can omit \f3-ORBInitialHost localhost\fR because the name server is running on the same host as the \f3Hello\fR client\&. If the name server is running on a different host, then use the -\f3ORBInitialHost nameserverhost\fR option to specify the host on which the IDL name server is running\&.Specify the name server (\f3orbd\fR) port as done in the previous step, for example, \f3-ORBInitialPort 1050\fR\&. When you finish experimenting with the ORBD Server Manager, be sure to shut down or terminate the name server (\f3orbd\fR) and \f3servertool\fR\&. To shut down \f3orbd\fR from am MS-DOS prompt, select the window that is running the server and enter \fICtrl+C\fR to shut it down\&. +.PP +To shut down \f3orbd\fR from an Oracle Solaris shell, find the process, and terminate with the \f3kill\fR command\&. The server continues to wait for invocations until it is explicitly stopped\&. To shut down the \f3servertool\fR, type \fIquit\fR and press the \fIEnter\fR key\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +servertool(1) +.TP 0.2i +\(bu +Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/pack200.1 b/jdk/src/solaris/doc/sun/man/man1/pack200.1 index 8f34d6dd51a..f414cdb6170 100644 --- a/jdk/src/solaris/doc/sun/man/man1/pack200.1 +++ b/jdk/src/solaris/doc/sun/man/man1/pack200.1 @@ -1,340 +1,291 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH pack200 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: pack200.1 +.\" +.if n .pl 99999 +.TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -pack200 \- JAR Packing tool -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4pack200\fP\f2 [ \fP\f2options\fP ] \f2output\-file\fP \f2JAR\-file\fP -.LP -.LP -Options may be in any order. The last option on the command line or in a properties file supersedes all previously specified options. -.LP -.RS 3 -.TP 3 -options -Command\-line options. -.TP 3 -output\-file -Name of the output file. -.TP 3 -JAR\-file -Name of the input file. -.RE +.SH NAME +pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f2pack200\fP tool is a Java application that transforms a JAR file into a compressed \f2pack200\fP file using the Java \f2gzip\fP compressor. The \f2pack200\fP files are highly compressed files that can be directly deployed, saving bandwidth and reducing download time. -.LP -.LP -The \f2pack200\fP tool uses several options to fine\-tune and set the compression engine. -.LP -.SS -Typical usage: -.LP -.LP -\f2% pack200 myarchive.pack.gz myarchive.jar\fP -.LP -.LP -In this example, \f2myarchive.pack.gz\fP is produced using the default \f2pack200\fP settings. -.LP -.SH "OPTIONS" -.LP -.LP -\f4\-r \-\-repack\fP -.LP -.LP -Produces a JAR file by packing the file \f2myarchive.jar\fP and unpacking it. The resulting file can be used as an input to the \f2jarsigner(1)\fP tool. -.LP -.LP -\f2% pack200 \-\-repack myarchive\-packer.jar myarchive.jar\fP -.LP -.LP -\f2% pack200 \-\-repack myarchive.jar\fP -.LP -.LP -\f4\-g \-\-no\-gzip\fP -.LP -.LP -Produces a \f2pack200\fP file. With this option a suitable compressor must be used, and the target system must use a corresponding decompresser. -.LP -.LP -\f2% pack200 \-\-no\-gzip myarchive.pack myarchive.jar\fP -.LP -.LP -\f4\-G \-\-strip\-debug\fP -.LP -.LP -Strips attributes used for debugging from the output. These include \f2SourceFile\fP, \f2LineNumberTable\fP, \f2LocalVariableTable\fP and \f2LocalVariableTypeTable\fP. Removing these attributes reduces the size of both downloads and installations but reduces the usefulness of debuggers. -.LP -.LP -\f4\-\-keep\-file\-order\fP -.LP -.LP -Preserve the order of files in the input file; this is the default behavior. -.LP -.LP -\f4\-O \-\-no\-keep\-file\-order\fP -.LP -.LP -The packer will reorder and transmit all elements. Additionally, the packer may remove JAR directory names. This will reduce the download size; however, certain JAR file optimizations, such as indexing, may not work correctly. -.LP -.LP -\f4\-Svalue \-\-segment\-limit=\fP\f2value\fP -.LP -.LP -The value is the estimated target size N (in bytes) of each archive segment. If a single input file requires +\fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR +.fi +.sp +Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&. +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIoutput-file\fR +Name of the output file\&. +.TP +\fIJAR-file\fR +Name of the input file\&. +.SH DESCRIPTION +The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&. +.PP +The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings: +.sp +.nf +\f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-r, --repack .br -more than N bytes, it will be given its own archive segment. As a special case, a value of \f2\-1\fP will produce a single large segment with all input files, while a value of \f20\fP will produce one segment for each class. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory. -.LP -.LP -The size of each segment is estimated by counting the size of each input file to be transmitted in the segment, along with the size of its name and other transmitted properties. -.LP -.LP -The default is \-1, which means the packer will always create a single segment output file. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs. -.LP -.LP -A 10MB JAR packed without this limit will typically pack about 10% smaller, but the packer may require a larger Java heap (about ten times the segment limit). -.LP -.LP -\f4\-Evalue \-\-effort=\fP\f2value\fP -.LP -.LP -If the value is set to a single decimal digit, the packer will use the indicated amount of effort in compressing the archive. Level \f21\fP may produce somewhat larger size and faster compression speed, while level \f29\fP will take much longer but may produce better compression. The special value \f20\fP instructs the packer to copy through the original JAR file directly with no compression. The JSR 200 standard requires any unpacker to understand this special case as a pass\-through of the entire archive. -.LP -.LP -The default is \f25\fP, investing a modest amount of time to produce reasonable compression. -.LP -.LP -\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP -.LP -.LP -Overrides the default, which preserves the input information, but may cause the transmitted archive to be larger. The possible values are: -.LP -.RS 3 -.TP 3 -true -.TP 3 -false -In either case, the packer will set the deflation hint accordingly in the output archive, and will not transmit the individual deflation hints of archive elements. -.RE +Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file: +.sp +.nf +\f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP +.fi +.nf +\f3pack200 \-\-repack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.RS 3 -.TP 3 -keep -Preserve deflation hints observed in the input JAR. (This is the default.) -.RE -.LP -.LP -\f4\-mvalue \-\-modification\-time=\fP\f2value\fP -.LP -.LP -The possible values are: -.LP -.RS 3 -.TP 3 -latest -The packer will attempt to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment. This single value will be transmitted as part of the segment and applied to all the entries in each segment. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date. -.TP 3 -keep -Preserves modification times observed in the input JAR. (This is the default.) -.RE +The following example preserves the order of files in the input file\&. +.TP +-g, --no-gzip +.br +Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&. +.sp +.nf +\f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -\f4\-Pfile \-\-pass\-file=\fP\f2file\fP -.LP -.LP -Indicates that a file should be passed through bytewise with no compression. By repeating the option, multiple files may be specified. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator "\f2/\fP". The resulting file names must match exactly as strings with their occurrences in the JAR file. If file is a directory name, all files under that directory will be passed. -.LP -.LP -\f4\-Uaction \-\-unknown\-attribute=\fP\f2action\fP -.LP -.LP -Overrides the default behavior; i.e., the classfile containing the unknown attribute will be passed through with the specified action. The possible values for actions are: -.LP -.RS 3 -.TP 3 -error -The \f2pack200\fP operation as a whole will fail with a suitable explanation. -.TP 3 -strip -The attribute will be dropped. Note: Removing the required VM attributes may cause Class Loader failures. -.TP 3 -pass -Upon encountering this attribute, the entire class will be transmitted as though it is a resource. -.RE +.TP +-G, --strip-debug +.br +Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&. +.TP +--keep-file-order +.br +Preserve the order of files in the input file\&. This is the default behavior\&. +.TP +-O, --no-keep-file-order +.br +The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&. +.TP +-S\fIvalue\fR , --segment-limit=\fIvalue\fR +.br +The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&. -.LP -.LP -\f4\-Cattribute\-name=\fP\f2layout\fP \f3\-\-class\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Fattribute\-name=\fP\f2layout\fP \f3\-\-field\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Mattribute\-name=\fP\f2layout\fP \f3\-\-method\-attribute=\fP\f2attribute\-name=action\fP -.br -\f4\-Dattribute\-name=\fP\f2layout\fP \f3\-\-code\-attribute=\fP\f2attribute\-name=action\fP -.LP -.LP -With the above four options, the attribute layout can be specified for a class entity, such as Class attribute, Field attribute, Method attribute, and Code attribute. The attribute\-name is the name of the attribute for which the layout or action is being defined. The possible values for action are: -.LP -.RS 3 -.TP 3 -some\-layout\-string -The layout language is defined in the JSR 200 specification. -.LP -Example: \f2\-\-class\-attribute=SourceFile=RUH\fP -.TP 3 -error -Upon encountering this attribute, the pack200 operation will fail with a suitable explanation. -.TP 3 -strip -Upon encountering this attribute, the attribute will be removed from the output. Note: removing VM\-required attributes may cause Class Loader failures. -.RE +The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&. -.LP -.LP -Example: \f2\-\-class\-attribute=CompilationID=pass\fP will cause the class file containing this attribute to be passed through without further action by the packer. -.LP -.LP -\f4\-f\fP\f2 \fP\f2pack.properties\fP \f3\-\-config\-file=\fP\f2pack.properties\fP -.LP -.LP -A configuration file, containing Java properties to initialize the packer, may be specified on the command line. -.LP -.LP -\f2% pack200 \-f pack.properties myarchive.pack.gz myarchive.jar\fP +The default is -1, which means that the packer creates a single segment output file\&. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs\&. + +A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&. +.TP +-E\fIvalue\fR , --effort=\fIvalue\fR .br -\f2% more pack.properties\fP +If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command to copy through the original JAR file directly with no compression\&. The JSR 200 standard requires any unpacker to understand this special case as a pass-through of the entire archive\&. + +The default is 5, to invest a modest amount of time to produce reasonable compression\&. +.TP +-H\fIvalue\fR , --deflate-hint=\fIvalue\fR .br -\f2# Generic properties for the packer.\fP +Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&. + +If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&. + +The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&. +.TP +-m\fIvalue\fR , --modification-time=\fIvalue\fR .br -\f2modification.time=latest\fP +The possible values are \f3latest\fR and \f3keep\fR\&. + +If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&. + +If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&. +.TP +-P\fIfile\fR , --pass-file=\fIfile\fR .br -\f2deflate.hint=false\fP +Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&. +.TP +-U\fIaction\fR , --unknown-attribute=\fIaction\fR .br -\f2keep.file.order=false\fP +Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&. + +If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&. + +If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +.nf +-C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR .br -\f2# This option will cause the files bearing new attributes to\fP -.br -\f2# be reported as an error rather than passed uncompressed.\fP -.br -\f2unknown.attribute=error\fP -.br -\f2# Change the segment limit to be unlimited.\fP -.br -\f2segment.limit=\-1\fP -.LP -.LP -\f4\-v \-\-verbose\fP -.LP -.LP -Outputs minimal messages. Multiple specification of this option will output more verbose messages. -.LP -.LP -\f4\-q \-\-quiet\fP -.LP -.LP -Specifies quiet operation with no messages. -.LP -.LP -\f4\-lfilename \-\-log\-file=\fP\f2filename\fP -.LP -.LP -Specifies a log file to output messages. -.LP -.LP -\f4\-? \-h \-\-help\fP -.LP -.LP -Prints help information about this command. -.LP -.LP -\f4\-V \-\-version\fP -.LP -.LP -Prints version information about this command. -.LP -.LP -\f4\-J\fP\f2option\fP -.LP -.LP -Passes \f2option\fP to the Java launcher called by \f2pack200\fP. For example, \f2\-J\-Xms48m\fP sets the startup memory to 48 megabytes. Although it does not begin with \f2\-X\fP, it is not a standard option of \f2pack200\fP. It is a common convention for \f2\-J\fP to pass options to the underlying VM executing applications written in Java. -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are returned: -.LP -.LP -\f2\ 0\fP for successful completion; -.LP -.LP -\f2>0\fP if an error occurs. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -unpack200(1) -.TP 2 -o -.na -\f2Java SE Documentation\fP @ .fi -http://download.oracle.com/javase/7/docs/index.html -.TP 2 -o -.na -\f2Java Deployment Guide \- Pack200\fP @ +See next option\&. +.TP +.nf +-F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR +.br .fi -http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html -.TP 2 -o -jar(1) \- Java Archive Tool -.TP 2 -o -jarsigner(1) \- JAR Signer tool -.TP 2 -o -\f2attributes(5)\fP man page -.RE +See next option\&. +.TP +.nf +-M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +See next option\&. +.TP +.nf +-D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR +.br +.fi +With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&. -.LP -.SH "NOTES" -.LP -.LP -This command should not be confused with \f2pack(1)\fP. They are distinctly separate products. -.LP -.LP -The Java SE API Specification provided with the JDK is the superseding authority, in case of discrepancies. -.LP - +\f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&. + +If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&. + +If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&. + +If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&. +.TP +-f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR +.br +A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&. +.sp +.nf +\f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3more pack\&.properties\fP +.fi +.nf +\f3# Generic properties for the packer\&.\fP +.fi +.nf +\f3modification\&.time=latest\fP +.fi +.nf +\f3deflate\&.hint=false\fP +.fi +.nf +\f3keep\&.file\&.order=false\fP +.fi +.nf +\f3# This option will cause the files bearing new attributes to\fP +.fi +.nf +\f3# be reported as an error rather than passed uncompressed\&.\fP +.fi +.nf +\f3unknown\&.attribute=error\fP +.fi +.nf +\f3# Change the segment limit to be unlimited\&.\fP +.fi +.nf +\f3segment\&.limit=\-1\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-v, --verbose +.br +Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&. +.TP +-q, --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-l\fIfilename\fR , --log-file=\fIfilename\fR +.br +Specifies a log file to output messages\&. +.TP +-?, -h, --help +.br +Prints help information about this command\&. +.TP +-V, --version +.br +Prints version information about this command\&. +.TP +-J\fIoption\fR +.br +Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&. +.SH NOTES +This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +unpack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/policytool.1 b/jdk/src/solaris/doc/sun/man/man1/policytool.1 index 8fd33bcdbf4..a82f7be956c 100644 --- a/jdk/src/solaris/doc/sun/man/man1/policytool.1 +++ b/jdk/src/solaris/doc/sun/man/man1/policytool.1 @@ -1,89 +1,115 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH policytool 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Security Tools +.\" Title: policytool.1 +.\" +.if n .pl 99999 +.TH policytool 1 "21 November 2013" "JDK 8" "Security Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -policytool \- PolicyTool Administration GUI Utility -.LP -\f3policytool\fP reads and writes a plain text policy file based on user input via the utility GUI. -.SH "SYNOPSIS" -.LP -.RS 3 -.TP 3 -\ -.TP 3 -Run the policytool Administrator's utility -\f4policytool\fP -.TP 3 -Run policytool and load the specified policy file -\f4policytool\fP\f2[\-file\ \fP\f2filename\fP\f2]\fP -.TP 3 -\ -.TP 3 -where: -.RS 3 -.TP 3 -file -directs \f2policytool\fP to load a local policy file -.TP 3 -filename -The file name -.RE -.SH "DESCRIPTION" -.LP -\f3policytool\fP is a GUI that allows users to create and manage policy files. For details, see -.na -\f2the Policytool Users Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html. -.SH "OPTIONS" -.RS 3 -.TP 3 -file -Loads \f2filename\fP. -.SH "SEE ALSO" -.na -\f2Default Policy Implementation and Syntax\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyFiles.html -.br -.na -\f2Policy Tool Users' Guide\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/PolicyGuide.html -.br -.na -\f2Security Permissions\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/permissions.html -.br -.na -\f2Security Overview\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/security/overview/jsoverview.html -.br -.RE -.RE +.SH NAME +policytool \- Reads and writes a plain text policy file based on user input through the utility GUI\&. +.SH SYNOPSIS +.sp +.nf -.LP - +\fBpolicytool\fR [ \fB\-file\fR ] [ \fIfilename\fR ] +.fi +.sp +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.TP +\fIfilename\fR +The name of the file to be loaded\&. +.PP +\fIExamples\fR: +.PP +Run the policy tool administrator utility: +.sp +.nf +\f3policytool\fP +.fi +.nf +\f3\fP +.fi +.sp +Run the \f3policytool\fR command and load the specified file: +.sp +.nf +\f3policytool\-file mypolicyfile\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH DESCRIPTION +The \f3policytool\fR command calls an administrator\&'s GUI that enables system administrators to manage the contents of local policy files\&. A policy file is a plain-text file with a \f3\&.policy\fR extension, that maps remote requestors by domain, to permission objects\&. For details, see Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.SH OPTIONS +.TP +-file +.br +Directs the \f3policytool\fR command to load a policy file\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html +.TP 0.2i +\(bu +Policy File Creation and Management at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyGuide\&.html +.TP 0.2i +\(bu +Permissions in Java SE Development Kit (JDK) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/permissions\&.html +.TP 0.2i +\(bu +Java Security Overview at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/overview/jsoverview\&.html +.TP 0.2i +\(bu +Java Cryptography Architecture (JCA) Reference Guide at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/rmic.1 b/jdk/src/solaris/doc/sun/man/man1/rmic.1 index 95f166206f2..9f7397edb54 100644 --- a/jdk/src/solaris/doc/sun/man/man1/rmic.1 +++ b/jdk/src/solaris/doc/sun/man/man1/rmic.1 @@ -1,227 +1,224 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmic 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmic.1 +.\" +.if n .pl 99999 +.TH rmic 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmic \- The Java RMI Compiler -.LP -.LP -\f3rmic\fP generates stub, skeleton, and tie classes for remote objects using either the JRMP or IIOP protocols. Also generates OMG IDL. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmic [ \fP\f3options\fP\f3 ] \fP\f4package\-qualified\-class\-name(s)\fP\f3 -.fl -\fP -.fi +.SH NAME +rmic \- Generates stub, skeleton, and tie classes for remote objects that use the Java Remote Method Protocol (JRMP) or Internet Inter-Orb protocol (IIOP)\&. Also generates Object Management Group (OMG) Interface Definition Language (IDL) +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmic\fP compiler generates stub and skeleton class files (JRMP protocol) and stub and tie class files (IIOP protocol) for remote objects. These classes files are generated from compiled Java programming language classes that are remote object implementation classes. A remote implementation class is a class that implements the interface \f2java.rmi.Remote\fP. The class names in the \f3rmic\fP command must be for classes that have been compiled successfully with the \f3javac\fP command and must be fully package qualified. For example, running \f3rmic\fP on the class file name \f2HelloImpl\fP as shown here: -.LP -.nf -\f3 -.fl -rmic hello.HelloImpl -.fl -\fP -.fi +\fBrmic\fR [ \fIoptions\fR ] \fIpackage\-qualified\-class\-names\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line \f3options\fR\&. See Options\&. +.TP +\fIpackage-qualified-class-names\fR +Class names that include their packages, for example, \f3java\&.awt\&.Color\fR\&. +.SH DESCRIPTION +\fIDeprecation Note:\fR Support for static generation of Java Remote Method Protocol (JRMP) stubs and skeletons has been deprecated\&. Oracle recommends that you use dynamically generated JRMP stubs instead, eliminating the need to use this tool for JRMP-based applications\&. See the \f3java\&.rmi\&.server\&.UnicastRemoteObject\fR specification at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/server/UnicastRemoteObject\&.html for further information\&. +.PP +The \f3rmic\fR compiler generates stub and skeleton class files using the Java Remote Method Protocol (JRMP) and stub and tie class files (IIOP protocol) for remote objects\&. These class files are generated from compiled Java programming language classes that are remote object implementation classes\&. A remote implementation class is a class that implements the interface \f3java\&.rmi\&.Remote\fR\&. The class names in the \f3rmic\fR command must be for classes that were compiled successfully with the \f3javac\fR command and must be fully package qualified\&. For example, running the \f3rmic\fR command on the class file name \f3HelloImpl\fR as shown here creates the \f3HelloImpl_Stub\&.class\fRfile in the hello subdirectory (named for the class\&'s package): +.sp +.nf +\f3rmic hello\&.HelloImpl\fP +.fi +.nf +\f3\fP +.fi +.sp +A skeleton for a remote object is a JRMP protocol server-side entity that has a method that dispatches calls to the remote object implementation\&. +.PP +A tie for a remote object is a server-side entity similar to a skeleton, but communicates with the client with the IIOP protocol\&. +.PP +A stub is a client-side proxy for a remote object that is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides\&. A client\&'s reference to a remote object, therefore, is actually a reference to a local stub\&. +.PP +By default, the \f3rmic\fR command generates stub classes that use the 1\&.2 JRMP stub protocol version only, as though the \f3-v1\&.2\fR option was specified\&. The \f3-vcompat\fR option was the default in releases before 5\&.0\&. Use the \f3-iiop\fR option to generate stub and tie classes for the IIOP protocol\&. See Options\&. +.PP +A stub implements only the remote interfaces, and not any local interfaces that the remote object also implements\&. Because a JRMP stub implements the same set of remote interfaces as the remote object, a client can use the Java programming language built-in operators for casting and type checking\&. For IIOP, the \f3PortableRemoteObject\&.narrow\fR method must be used\&. +.SH OPTIONS +.TP +-bootclasspath \fIpath\fR +.br +Overrides the location of bootstrap class files\&. +.TP +-classpath path +.br +Specifies the path the \f3rmic\fR command uses to look up classes\&. This option overrides the default or the \f3CLASSPATH\fR environment variable when it is set\&. Directories are separated by colons\&. The general format for path is: \f3\&.:<your_path>\fR, for example: \f3\&.:/usr/local/java/classes\fR\&. +.TP +-d \fIdirectory\fR +.br +Specifies the root destination directory for the generated class hierarchy\&. You can use this option to specify a destination directory for the stub, skeleton, and tie files\&. For example, the following command places the stub and skeleton classes derived from MyClass into the directory /java/classes/exampleclass\&. +.sp +.nf +\f3rmic \-d /java/classes exampleclass\&.MyClass\fP +.fi +.nf +\f3\fP +.fi +.sp -.LP -.LP -creates the \f2HelloImpl_Stub.class\fP file in the \f2hello\fP subdirectory (named for the class's package). -.LP -.LP -A \f2skeleton\fP for a remote object is a JRMP protocol server\-side entity that has a method that dispatches calls to the actual remote object implementation. -.LP -.LP -A \f2tie\fP for a remote object is a server\-side entity similar to a skeleton, but which communicates with the client using the IIOP protocol. -.LP -.LP -A \f2stub\fP is a client\-side proxy for a remote object which is responsible for communicating method invocations on remote objects to the server where the actual remote object implementation resides. A client's reference to a remote object, therefore, is actually a reference to a local stub. -.LP -.LP -By default, \f3rmic\fP generates stub classes that use the 1.2 JRMP stub protocol version only, as if the \f2\-v1.2\fP option had been specified. (Note that the \f2\-vcompat\fP option was the default in releases prior to 5.0.) Use the \f2\-iiop\fP option to generate stub and tie classes for the IIOP protocol. -.LP -.LP -A stub implements only the remote interfaces, not any local interfaces that the remote object also implements. Because a JRMP stub implements the same set of remote interfaces as the remote object itself, a client can use the Java programming language's built\-in operators for casting and type checking. For IIOP, the \f2PortableRemoteObject.narrow\fP method must be used. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-bootclasspath path -Overrides location of bootstrap class files -.TP 3 -\-classpath path -Specifies the path \f3rmic\fP uses to look up classes. This option overrides the default or the CLASSPATH environment variable if it is set. Directories are separated by colons. Thus the general format for \f2path\fP is: -.nf -\f3 -.fl -.:<your_path> -.fl -\fP -.fi -For example: -.nf -\f3 -.fl -.:/usr/local/java/classes -.fl -\fP -.fi -.TP 3 -\-d directory -Specifies the root destination directory for the generated class hierarchy. You can use this option to specify a destination directory for the stub, skeleton, and tie files. For example, the command -.nf -\f3 -.fl -% rmic \-d /java/classes foo.MyClass -.fl -\fP -.fi -would place the stub and skeleton classes derived from \f2MyClass\fP into the directory \f2/java/classes/foo\fP. If the \f2\-d\fP option is not specified, the default behavior is as if \f2"\-d\ ."\fP were specified: the package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it. (Note that in some previous versions of \f3rmic\fP, if \f2\-d\fP was not specified, then the package hierarchy was \f2not\fP created, and all of the output files were placed directly in the current directory.) -.br -\ -.TP 3 -\-extdirs path -Overrides location of installed extensions -.TP 3 -\-g -Enables generation of all debugging information, including local variables. By default, only line number information is generated. -.TP 3 -\-idl -Causes \f2rmic\fP to generate OMG IDL for the classes specified and any classes referenced. IDL provides a purely declarative, programming language\-independent way of specifying an object's API. The IDL is used as a specification for methods and data that can be written in and invoked from any language that provides CORBA bindings. This includes Java and C++ among others. See the -.na -\f2Java Language to IDL Mapping\fP @ -.fi -http://www.omg.org/technology/documents/formal/java_language_mapping_to_omg_idl.htm (OMG) document for a complete description. -.br -.br -When the \f2\-idl\fP option is used, other options also include: -.RS 3 -.TP 3 -\-always or \-alwaysgenerate -Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. -.TP 3 -\-factory -Uses factory keyword in generated IDL. -.TP 3 -\-idlModule\ fromJavaPackage[.class]\ toIDLModule -Specifies IDLEntity package mapping. For example:\ \f2\-idlModule foo.bar my::real::idlmod\fP. -.TP 3 -\-idlFile\ fromJavaPackage[.class]\ toIDLFile -Specifies IDLEntity file mapping. For example:\ \f2\-idlFile test.pkg.X TEST16.idl\fP.\ -.RE -.TP 3 -\-iiop -Causes \f2rmic\fP to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes. A stub class is a local proxy for a remote object and is used by clients to send calls to a server. Each remote interface requires a stub class, which implements that remote interface. A client's reference to a remote object is actually a reference to a stub. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class. Each implementation class requires a tie class. -.br -.br -Invoking \f2rmic\fP with the \f2\-iiop\fP generates stubs and ties that conform to this naming convention: -.nf -\f3 -.fl -_<implementationName>_stub.class -.fl -_<interfaceName>_tie.class -.fl -\fP -.fi -When the \f2\-iiop\fP option is used, other options also include: -.RS 3 -.TP 3 -\-always or \-alwaysgenerate -Forces re\-generation even when existing stubs/ties/IDL are newer than the input class. -.TP 3 -\-nolocalstubs -Do not create stubs optimized for same\-process clients and servers. -.TP 3 -\-noValueMethods -Must be used with the \f2\-idl\fP option. Prevents addition of \f2valuetype\fP methods and initializers to emitted IDL. These methods and initializers are optional for \f2valuetype\fPs, and are generated unless the \f2\-noValueMethods\fP option is specified when using the \f2\-idl\fP option. -.TP 3 -\-poa -Changes the inheritance from \f2org.omg.CORBA_2_3.portable.ObjectImpl\fP to \f2org.omg.PortableServer.Servant\fP. The \f2PortableServer\fP module for the -.na -\f2Portable Object Adapter\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/POA.html (POA) defines the native \f2Servant\fP type. In the Java programming language, the \f2Servant\fP type is mapped to the Java \f2org.omg.PortableServer.Servant\fP class. It serves as the base class for all POA servant implementations and provides a number of methods that may be invoked by the application programmer, as well as methods which are invoked by the POA itself and may be overridden by the user to control aspects of servant behavior. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2.3.1 ptc/00\-01\-08.pdf. -.RE -.TP 3 -\-J -Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter. -.TP 3 -\-keep or \-keepgenerated -Retains the generated \f2.java\fP source files for the stub, skeleton, and/or tie classes and writes them to the same directory as the \f2.class\fP files. -.TP 3 -\-nowarn -Turns off warnings. If used the compiler does not print out any warnings. -.TP 3 -\-nowrite -Does not write compiled classes to the file system. -.TP 3 -\-vcompat -Generates stub and skeleton classes compatible with both the 1.1 and 1.2 JRMP stub protocol versions. (This option was the default in releases prior to 5.0.) The generated stub classes will use the 1.1 stub protocol version when loaded in a JDK 1.1 virtual machine and will use the 1.2 stub protocol version when loaded into a 1.2 (or later) virtual machine. The generated skeleton classes will support both 1.1 and 1.2 stub protocol versions. The generated classes are relatively large in order to support both modes of operation. -.TP 3 -\-verbose -Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded. -.TP 3 -\-v1.1 -Generates stub and skeleton classes for the 1.1 JRMP stub protocol version only. Note that this option is only useful for generating stub classes that are serialization\-compatible with pre\-existing, statically\-deployed stub classes that were generated by the \f3rmic\fP tool from JDK 1.1 and that cannot be upgraded (and dynamic class loading is not being used). -.TP 3 -\-v1.2 -(default) Generates stub classes for the 1.2 JRMP stub protocol version only. No skeleton classes are generated with this option because skeleton classes are not used with the 1.2 stub protocol version. The generated stub classes will not work if they are loaded into a JDK 1.1 virtual machine. -.RE -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 -CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example, -.nf -\f3 -.fl -.:/usr/local/java/classes -.fl -\fP -.fi -.RE +If the \f3-d\fR option is not specified, then the default behavior is as if \f3-d \&.\fR was specified\&. The package hierarchy of the target class is created in the current directory, and stub/tie/skeleton files are placed within it\&. In some earlier releases of the \f3rmic\fR command, if the \f3-d\fR option was not specified, then the package hierarchy was not created, and all of the output files were placed directly in the current directory\&. +.TP +-extdirs \fIpath\fR +.br +Overrides the location of installed extensions\&. +.TP +-g +.br +Enables the generation of all debugging information, including local variables\&. By default, only line number information is generated\&. +.TP +-idl +.br +Causes the \f3rmic\fR command to generate OMG IDL for the classes specified and any classes referenced\&. IDL provides a purely declarative, programming language-independent way to specify an API for an object\&. The IDL is used as a specification for methods and data that can be written in and called from any language that provides CORBA bindings\&. This includes Java and C++ among others\&. See Java IDL: IDL to Java Language Mapping at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/mapping/jidlMapping\&.html -.LP -.SH "SEE ALSO" -.LP -.LP -java(1), javac(1), -.na -\f2CLASSPATH\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath -.LP - +When the \f3-idl\fR option is used, other options also include: +.RS +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-factory\fR option uses the \f3factory\fR keyword in generated IDL\&. +.TP 0.2i +\(bu +The \f3-idlModule\fR from J\f3avaPackage[\&.class]\fR\f3toIDLModule\fR specifies \f3IDLEntity\fR package mapping, for example: \f3-idlModule\fR\f3my\&.module my::real::idlmod\fR\&. +.TP 0.2i +\(bu +\f3-idlFile\fR\f3fromJavaPackage[\&.class] toIDLFile\fR specifies \f3IDLEntity\fR file mapping, for example: \f3-idlFile test\&.pkg\&.X TEST16\&.idl\fR\&. +.RE + +.TP +-iiop +.br +Causes the \f3rmic\fR command to generate IIOP stub and tie classes, rather than JRMP stub and skeleton classes\&. A stub class is a local proxy for a remote object and is used by clients to send calls to a server\&. Each remote interface requires a stub class, which implements that remote interface\&. A client reference to a remote object is a reference to a stub\&. Tie classes are used on the server side to process incoming calls, and dispatch the calls to the proper implementation class\&. Each implementation class requires a tie class\&. + +If you call the \f3rmic\fR command with the \f3-iiop\fR, then it generates stubs and ties that conform to this naming convention: +.sp +.nf +\f3_<implementationName>_stub\&.class\fP +.fi +.nf +\f3_<interfaceName>_tie\&.class\fP +.fi +.nf +\f3\fP +.fi +.sp +.RS +.TP 0.2i +\(bu +When you use the \f3-iiop\fR option, other options also include: +.TP 0.2i +\(bu +The \f3-always\fR or \f3-alwaysgenerate\fR options force regeneration even when existing stubs/ties/IDL are newer than the input class\&. +.TP 0.2i +\(bu +The \f3-nolocalstubs\fR option means do not create stubs optimized for same-process clients and servers\&. +.TP 0.2i +\(bu +The \f3-noValueMethods\fR option must be used with the \f3-idl\fR option\&. The \f3-noValueMethods\fR option prevents the addition of \f3valuetype\fR methods and initializers to emitted IDL\&. These methods and initializers are optional for valuetypes, and are generated unless the \f3-noValueMethods\fR option is specified with the \f3-idl\fR option\&. +.TP 0.2i +\(bu +The \f3-poa\fR option changes the inheritance from \f3org\&.omg\&.CORBA_2_3\&.portable\&.ObjectImpl\fR to \f3org\&.omg\&.PortableServer\&.Servant\fR\&. The \f3PortableServer\fR module for the Portable Object Adapter (POA) defines the native \f3Servant\fR type\&. In the Java programming language, the \f3Servant\fR type is mapped to the \f3Java org\&.omg\&.PortableServer\&.Servant\fR class\&. It serves as the base class for all POA servant implementations and provides a number of methods that can be called by the application programmer, and methods that are called by the POA and that can be overridden by the user to control aspects of servant behavior\&. Based on the OMG IDL to Java Language Mapping Specification, CORBA V 2\&.3\&.1 ptc/00-01-08\&.pdf\&..RE + +.TP +-J +.br +Used with any Java command, the \f3-J\fR option passes the argument that follows the \f3-J\fR (no spaces between the \f3-J\fRand the argument) to the Java interpreter +.TP +-keep or -keepgenerated +.br +Retains the generated \f3\&.java\fR source files for the stub, skeleton, and tie classes and writes them to the same directory as the\f3\&.class\fR files\&. +.TP +-nowarn +.br +Turns off warnings\&. When the \f3-nowarn\fR options is used\&. The compiler does not print out any warnings\&. +.TP +-nowrite +.br +Does not write compiled classes to the file system\&. +.TP +-vcompat (deprecated) +.br +Generates stub and skeleton classes that are compatible with both the 1\&.1 and 1\&.2 JRMP stub protocol versions\&. This option was the default in releases before 5\&.0\&. The generated stub classes use the 1\&.1 stub protocol version when loaded in a JDK 1\&.1 virtual machine and use the 1\&.2 stub protocol version when loaded into a 1\&.2 (or later) virtual machine\&. The generated skeleton classes support both 1\&.1 and 1\&.2 stub protocol versions\&. The generated classes are relatively large to support both modes of operation\&. Note: This option has been deprecated\&. See Description\&. +.TP +-verbose +.br +Causes the compiler and linker to print out messages about what classes are being compiled and what class files are being loaded\&. +.TP +-v1\&.1 (deprecated) +.br +Generates stub and skeleton classes for the 1\&.1 JRMP stub protocol version only\&. The \f3-v1\&.1\fR option is only useful for generating stub classes that are serialization-compatible with preexisting, statically deployed stub classes that were generated by the \f3rmic\fR command from JDK 1\&.1 and that cannot be upgraded (and dynamic class loading is not being used)\&. Note: This option has been deprecated\&. See Description\&. +.TP +-v1\&.2 (deprecated) +.br +(Default) Generates stub classes for the 1\&.2 JRMP stub protocol version only\&. No skeleton classes are generated because skeleton classes are not used with the 1\&.2 stub protocol version\&. The generated stub classes do not work when they are loaded into a JDK 1\&.1 virtual machine\&. Note: This option has been deprecated\&. See Description\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +javac(1) +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/rmid.1 b/jdk/src/solaris/doc/sun/man/man1/rmid.1 index 763ee378af9..0a01aa90827 100644 --- a/jdk/src/solaris/doc/sun/man/man1/rmid.1 +++ b/jdk/src/solaris/doc/sun/man/man1/rmid.1 @@ -1,328 +1,315 @@ -." Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmid 1 "10 May 2011" +'\" t +.\" Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmid.1 +.\" +.if n .pl 99999 +.TH rmid 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmid \- The Java RMI Activation System Daemon -.LP -.LP -\f3rmid\fP starts the activation system daemon that allows objects to be registered and activated in a virtual machine (VM). -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmid [options] -.fl -\fP -.fi +.SH NAME +rmid \- Starts the activation system daemon that enables objects to be registered and activated in a Java Virtual Machine (JVM)\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmid\fP tool starts the activation system daemon. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a VM. See the -.na -\f2Java RMI Specification\fP @ -.fi -http://download.oracle.com/javase/7/docs/platform/rmi/spec/rmiTOC.html and -.na -\f2Activation tutorials\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/rmi/activation/overview.html for details on how to write programs that use activatable remote objects. -.LP -.LP -The daemon can be started by executing the \f2rmid\fP command, and specifying a security policy file, as follows: -.LP -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy -.fl -\fP -.fi - -.LP -.LP -\f3Note:\fP When running Sun's implementation of \f2rmid\fP, by default you will need to specify a security policy file so that \f2rmid\fP can verify whether or not the information in each \f2ActivationGroupDesc\fP is allowed to be used to launch a VM for an activation group. Specifically, the command and options specified by the \f2CommandEnvironment\fP and any \f2Properties\fP passed to an \f2ActivationGroupDesc\fP's constructor must now be explicitly allowed in the security policy file for \f2rmid\fP. The value of the \f2sun.rmi.activation.execPolicy\fP property dictates the policy that \f2rmid\fP uses to determine whether or not the information in an \f2ActivationGroupDesc\fP may be used to launch a VM for an activation group. -.LP -.LP -Executing \f2rmid\fP by default -.LP -.RS 3 -.TP 2 -o -starts the Activator and an internal registry on the default port, 1098, and -.TP 2 -o -binds an \f2ActivationSystem\fP to the name \f2java.rmi.activation.ActivationSystem\fP in this internal registry. -.RE - -.LP -.LP -To specify an alternate port for the registry, you must specify the \f2\-port\fP option when starting up \f2rmid\fP. For example, -.LP -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy \-port 1099 -.fl -\fP -.fi - -.LP -.LP -starts the activation system daemon and a registry on the registry's default port, 1099. -.LP -.SS -Starting rmid from inetd/xinetd -.LP -.LP -An alternative to starting \f2rmid\fP from the command line is to configure \f2inetd\fP (Solaris) or \f2xinetd\fP (Linux) to start \f2rmid\fP on demand. -.LP -.LP -When \f2rmid\fP starts up, it attempts to obtain an inherited channel (inherited from \f2inetd\fP/\f2xinetd\fP) by invoking the \f2System.inheritedChannel\fP method. If the inherited channel is \f2null\fP or not an instance of \f2java.nio.channels.ServerSocketChannel\fP, then \f2rmid\fP assumes that it was not started by \f2inetd\fP/\f2xinetd\fP, and it starts up as described above. -.LP -.LP -If the inherited channel is a \f2ServerSocketChannel\fP instance, then \f2rmid\fP uses the \f2java.net.ServerSocket\fP obtained from the \f2ServerSocketChannel\fP as the server socket that accepts requests for the remote objects it exports, namely the registry in which the \f2java.rmi.activation.ActivationSystem\fP is bound and the \f2java.rmi.activation.Activator\fP remote object. In this mode, \f2rmid\fP behaves the same as when it is started from the command line, \f2except\fP: -.LP -.RS 3 -.TP 2 -o -Output printed to \f2System.err\fP is redirected to a file. This file is located in the directory specified by the \f2java.io.tmpdir\fP system property (typically \f2/var/tmp\fP or \f2/tmp\fP) with the prefix \f2"rmid\-err"\fP and the suffix \f2"tmp"\fP. -.TP 2 -o -The \f2\-port\fP option is disallowed. If this option is specified, \f2rmid\fP will exit with an error message. -.TP 2 -o -The \f2\-log\fP option is required. If this option is not specified, \f2rmid\fP will exit with an error message. -.RE - -.LP -.LP -See the man pages for \f2inetd\fP (Solaris) or \f2xinetd\fP (Linux) for details on how to configure services to be started on demand. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-C<someCommandLineOption> -Specifies an option that is passed as a command\-line argument to each child process (activation group) of \f2rmid\fP when that process is created. For example, you could pass a property to each virtual machine spawned by the activation system daemon: -.nf -\f3 -.fl - rmid \-C\-Dsome.property=value -.fl -\fP -.fi -This ability to pass command\-line arguments to child processes can be useful for debugging. For example, the following command: -.nf -\f3 -.fl - rmid \-C\-Djava.rmi.server.logCalls=true -.fl -\fP -.fi -will enable server\-call logging in all child VMs. -.LP -.TP 3 -\-J<someCommandLineOption> -Specifies an option that is passed to the \f2java\fP interpreter running \f2rmid\fP. For example, to specify that \f2rmid\fP use a policy file named \f2rmid.policy\fP, the \f2\-J\fP option can be used to define the \f2java.security.policy\fP property on \f2rmid\fP's command line, for example: -.nf -\f3 -.fl - rmid \-J\-Djava.security.policy=rmid.policy -.fl -\fP -.fi -.TP 3 -\-J\-Dsun.rmi.activation.execPolicy=<policy> -Specifies the policy that \f2rmid\fP employs to check commands and command\-line options used to launch the VM in which an activation group runs. Please note that this option exists only in Sun's implementation of the Java RMI activation daemon. If this property is not specified on the command line, the result is the same as if \f2\-J\-Dsun.rmi.activation.execPolicy=default\fP were specified. The possible values of \f2<policy>\fP can be \f2default\fP, \f2<policyClassName>\fP, or \f2none\fP: -.RS 3 -.TP 2 -o -\f3default (or if this property is \fP\f4unspecified\fP\f3)\fP -.LP -The default \f2execPolicy\fP allows \f2rmid\fP to execute commands with specific command\-line options only if \f2rmid\fP has been granted permission to execute those commands and options in the security policy file that \f2rmid\fP uses. Only the default activation group implementation can be used with the \f2default\fP execution policy. -.LP -\f2rmid\fP launches a VM for an activation group using the information in the group's registered activation group descriptor, an \f2ActivationGroupDesc\fP. The group descriptor specifies an optional \f2ActivationGroupDesc.CommandEnvironment\fP which includes the \f2command\fP to execute to start the activation group as well as any command line \f2options\fP to be added to the command line. By default, \f2rmid\fP uses the \f2java\fP command found in \f2java.home\fP. The group descriptor also contains \f2properties\fP overrides that are added to the command line as options defined as: -.nf -\f3 -.fl - \-D\fP\f4<property>\fP\f3=\fP\f4<value>\fP\f3 -.fl -\fP -.fi -.LP -The permission \f2com.sun.rmi.rmid.ExecPermission\fP is used to grant \f2rmid\fP permission to execute a command, specified in the group descriptor's \f2CommandEnvironment\fP to launch an activation group. The permission \f2com.sun.rmi.rmid.ExecOptionPermission\fP is used to allow \f2rmid\fP to use command\-line options, specified as properties overrides in the group descriptor or as options in the \f2CommandEnvironment\fP, when launching the activation group. -.LP -When granting \f2rmid\fP permission to execute various commands and options, the permissions \f2ExecPermission\fP and \f2ExecOptionPermission\fP need to be granted universally (i.e., granted to all code sources). -.RS 3 -.TP 3 -ExecPermission -The \f2ExecPermission\fP class represents permission for \f2rmid\fP to execute a specific \f2command\fP to launch an activation group. -.LP -\f3Syntax\fP +\fBrmid\fR [\fIoptions\fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.SH DESCRIPTION +The \f3rmid\fR command starts the activation system daemon\&. The activation system daemon must be started before activatable objects can be either registered with the activation system or activated in a JVM\&. For details on how to write programs that use activatable objects, the \fIUsing Activation\fR tutorial at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi/activation/overview\&.html +.PP +Start the daemon by executing the \f3rmid\fR command and specifying a security policy file, as follows: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp +When you run Oracle\(cqs implementation of the \f3rmid\fR command, by default you must specify a security policy file so that the \f3rmid\fR command can verify whether or not the information in each \f3ActivationGroupDesc\fR is allowed to be used to start a JVM for an activation group\&. Specifically, the command and options specified by the \f3CommandEnvironment\fR and any properties passed to an \f3ActivationGroupDesc\fR constructor must now be explicitly allowed in the security policy file for the \f3rmid\fR command\&. The value of the \f3sun\&.rmi\&.activation\&.execPolicy\fR property dictates the policy that the \f3rmid\fR command uses to determine whether or not the information in an \f3ActivationGroupDesc\fR can be used to start a JVM for an activation group\&. For more information see the description of the -J-Dsun\&.rmi\&.activation\&.execPolicy=policy option\&. +.PP +Executing the \f3rmid\fR command starts the Activator and an internal registry on the default port1098 and binds an \f3ActivationSystem\fR to the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR in this internal registry\&. +.PP +To specify an alternate port for the registry, you must specify the \f3-port\fR option when you execute the \f3rmid\fR command\&. For example, the following command starts the activation system daemon and a registry on the registry\&'s default port, 1099\&. +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy=rmid\&.policy \-port 1099\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH START\ RMID\ ON\ DEMAND +An alternative to starting \f3rmid\fR from the command line is to configure \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) to start \f3rmid\fR on demand\&. +.PP +When RMID starts, it attempts to obtain an inherited channel (inherited from \f3inetd\fR/\f3xinetd\fR) by calling the \f3System\&.inheritedChannel\fR method\&. If the inherited channel is null or not an instance of \f3java\&.nio\&.channels\&.ServerSocketChannel\fR, then RMID assumes that it was not started by \f3inetd\fR/\f3xinetd\fR, and it starts as previously described\&. +.PP +If the inherited channel is a \f3ServerSocketChannel\fR instance, then RMID uses the \f3java\&.net\&.ServerSocket\fR obtained from the \f3ServerSocketChannel\fR as the server socket that accepts requests for the remote objects it exports: The registry in which the \f3java\&.rmi\&.activation\&.ActivationSystem\fR is bound and the \f3java\&.rmi\&.activation\&.Activator\fR remote object\&. In this mode, RMID behaves the same as when it is started from the command line, except in the following cases: +.TP 0.2i +\(bu +Output printed to \f3System\&.err\fR is redirected to a file\&. This file is located in the directory specified by the \f3java\&.io\&.tmpdir\fR system property (typically \f3/var/tmp\fR or \f3/tmp\fR) with the prefix \f3rmid-err\fR and the suffix \f3tmp\fR\&. +.TP 0.2i +\(bu +The \f3-port\fR option is not allowed\&. If this option is specified, then RMID exits with an error message\&. +.TP 0.2i +\(bu +The \f3-log\fR option is required\&. If this option is not specified, then RMID exits with an error message +.PP +See the man pages for \f3inetd\fR (Oracle Solaris) or \f3xinetd\fR (Linux) for details on how to configure services to be started on demand\&. +.SH OPTIONS +.TP +-C\fIoption\fR .br -The \f2name\fP of an \f2ExecPermission\fP is the path name of a command to grant \f2rmid\fP permission to execute. A path name that ends in "/*" indicates all the files contained in that directory (where "/" is the file\-separator character, \f2File.separatorChar\fP). A path name that ends with "/\-" indicates all files and subdirectories contained in that directory (recursively). A path name consisting of the special token "<<ALL FILES>>" matches \f3any\fP file. -.LP -\f3Note:\fP A path name consisting of a single "*" indicates all the files in the current directory, while a path name consisting of a single "\-" indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory. -.TP 3 -ExecOptionPermission -The \f2ExecOptionPermission\fP class represents permission for \f2rmid\fP to use a specific command\-line \f2option\fP when launching an activation group. The \f2name\fP of an \f2ExecOptionPermission\fP is the value of a command line option. -.LP -\f3Syntax\fP +Specifies an option that is passed as a command-line argument to each child process (activation group) of the \f3rmid\fR command when that process is created\&. For example, you could pass a property to each virtual machine spawned by the activation system daemon: +.sp +.nf +\f3rmid \-C\-Dsome\&.property=value\fP +.fi +.nf +\f3\fP +.fi +.sp + + +This ability to pass command-line arguments to child processes can be useful for debugging\&. For example, the following command enables server-call logging in all child JVMs\&. +.sp +.nf +\f3rmid \-C\-Djava\&.rmi\&.server\&.logCalls=true\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-J\fIoption\fR .br -Options support a limited wildcard scheme. An asterisk signifies a wildcard match, and it may appear as the option name itself (i.e., it matches any option), or an asterisk may appear at the end of the option name only if the asterisk follows either a "." or "=". -.LP -For example: "*" or "\-Dfoo.*" or "\-Da.b.c=*" is valid, "*foo" or "\-Da*b" or "ab*" is not. -.TP 3 -Policy file for rmid -When granting \f2rmid\fP permission to execute various commands and options, the permissions \f2ExecPermission\fP and \f2ExecOptionPermission\fP need to be granted universally (i.e., granted to all code sources). It is safe to grant these permissions universally because only \f2rmid\fP checks these permissions. -.LP -An example policy file that grants various execute permissions to \f2rmid\fP is: -.nf -\f3 -.fl -grant { -.fl - permission com.sun.rmi.rmid.ExecPermission -.fl - "/files/apps/java/jdk1.7.0/solaris/bin/java"; -.fl +Specifies an option that is passed to the Java interpreter running RMID\&. For example, to specify that the \f3rmid\fR command use a policy file named \f3rmid\&.policy\fR, the \f3-J\fR option can be used to define the \f3java\&.security\&.policy\fR property on the \f3rmid\fR command line, for example: +.sp +.nf +\f3rmid \-J\-Djava\&.security\&.policy\-rmid\&.policy\fP +.fi +.nf +\f3\fP +.fi +.sp -.fl - permission com.sun.rmi.rmid.ExecPermission -.fl - "/files/apps/rmidcmds/*"; -.fl +.TP +-J-Dsun\&.rmi\&.activation\&.execPolicy=\fIpolicy\fR +.br +Specifies the policy that RMID employs to check commands and command-line options used to start the JVM in which an activation group runs\&. Please note that this option exists only in Oracle\&'s implementation of the Java RMI activation daemon\&. If this property is not specified on the command line, then the result is the same as though \f3-J-Dsun\&.rmi\&.activation\&.execPolicy=default\fR were specified\&. The possible values of \f3policy\fR can be \f3default\fR, \f3policyClassName\fR, or \f3none\fR\&. +.RS +.TP 0.2i +\(bu +default -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Djava.security.policy=/files/policies/group.policy"; -.fl +The \f3default\fR or unspecified value \f3execPolicy\fR allows the \f3rmid\fR command to execute commands with specific command-line options only when the \f3rmid\fR command was granted permission to execute those commands and options in the security policy file that the \f3rmid\fR command uses\&. Only the default activation group implementation can be used with the default execution policy\&. -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Djava.security.debug=*"; -.fl +The \f3rmid\fR command starts a JVM for an activation group with the information in the group\&'s registered activation group descriptor, an \f3ActivationGroupDesc\fR\&. The group descriptor specifies an optional \f3ActivationGroupDesc\&.CommandEnvironment\fR that includes the command to execute to start the activation group and any command-line options to be added to the command line\&. By default, the \f3rmid\fR command uses the \f3java\fR command found in \f3java\&.home\fR\&. The group descriptor also contains properties overrides that are added to the command line as options defined as: \f3-D<property>=<value>\fR\&.The \f3com\&.sun\&.rmi\&.rmid\&.ExecPermission\fR permission grants the \f3rmid\fR command permission to execute a command that is specified in the group descriptor\&'s \f3CommandEnvironment\fR to start an activation group\&. The \f3com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fR permission enables the \f3rmid\fR command to use command-line options, specified as properties overrides in the group descriptor or as options in the \f3CommandEnvironment\fR when starting the activation group\&.When granting the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources\&. -.fl - permission com.sun.rmi.rmid.ExecOptionPermission -.fl - "\-Dsun.rmi.*"; -.fl -}; -.fl -\fP -.fi -The first permission granted allow \f2rmid\fP to execute the 1.7.0 version of the \f2java\fP command, specified by its explicit path name. Note that by default, the version of the \f2java\fP command found in \f2java.home\fP is used (the same one that \f2rmid\fP uses), and does not need to be specified in the policy file. The second permission allows \f2rmid\fP to execute any command in the directory \f2/files/apps/rmidcmds\fP. -.LP -The third permission granted, an \f2ExecOptionPermission\fP, allows \f2rmid\fP to launch an activation group that defines the security policy file to be \f2/files/policies/group.policy\fP. The next permission allows the \f2java.security.debug\fP property to be used by an activation group. The last permission allows any property in the \f2sun.rmi\fP property name hierarchy to be used by activation groups. -.LP -To start \f2rmid\fP with a policy file, the \f2java.security.policy\fP property needs to be specified on \f2rmid\fP's command line, for example: -.LP -\f2rmid \-J\-Djava.security.policy=rmid.policy\fP -.RE -.TP 2 -o -\f4<policyClassName>\fP -.LP -If the default behavior is not flexible enough, an administrator can provide, when starting \f2rmid\fP, the name of a class whose \f2checkExecCommand\fP method is executed in order to check commands to be executed by rmid. -.LP -The \f2policyClassName\fP specifies a public class with a public, no\-argument constructor and an implementation of the following \f2checkExecCommand\fP method: -.nf -\f3 -.fl - public void checkExecCommand(ActivationGroupDesc desc, -.fl - String[] command) -.fl - throws SecurityException; -.fl -\fP -.fi -Before launching an activation group, \f2rmid\fP calls the policy's \f2checkExecCommand\fP method, passing it the activation group descriptor and an array containing the complete command to launch the activation group. If the \f2checkExecCommand\fP throws a \f2SecurityException\fP, \f2rmid\fP will not launch the activation group and an \f2ActivationException\fP will be thrown to the caller attempting to activate the object. -.TP 2 -o -\f3none\fP -.LP -If the \f2sun.rmi.activation.execPolicy\fP property value is "none", then \f2rmid\fP will not perform any validation of commands to launch activation groups. -.RE -.LP -.TP 3 -\-log dir -Specifies the name of the directory the activation system daemon uses to write its database and associated information. The log directory defaults to creating a directory, \f2log\fP, in the directory in which the \f2rmid\fP command was executed. -.LP -.TP 3 -\-port port -Specifies the port \f2rmid\fP's registry uses. The activation system daemon binds the \f2ActivationSystem\fP, with the name \f2java.rmi.activation.ActivationSystem\fP, in this registry. Thus, the \f2ActivationSystem\fP on the local machine can be obtained using the following \f2Naming.lookup\fP method call: -.nf -\f3 -.fl - import java.rmi.*; -.fl - import java.rmi.activation.*; -.fl +\fIExecPermission\fR -.fl - ActivationSystem system; system = (ActivationSystem) -.fl - Naming.lookup("//:\fP\f4port\fP/java.rmi.activation.ActivationSystem"); -.fl -.fi -.TP 3 -\-stop -Stops the current invocation of \f2rmid\fP, for a port specified by the \f2\-port\fP option. If no port is specified, it will stop the \f2rmid\fP running on port 1098. -.RE +The \f3ExecPermission\fR class represents permission for the \f3rmid\fR command to execute a specific command to start an activation group\&. -.LP -.SH "ENVIRONMENT VARIABLES" -.LP -.RS 3 -.TP 3 -CLASSPATH -Used to provide the system a path to user\-defined classes. Directories are separated by colons. For example: -.nf -\f3 -.fl - .:/usr/local/java/classes -.fl -\fP -.fi -.RE +\fISyntax\fR: The name of an \f3ExecPermission\fR is the path name of a command to grant the \f3rmid\fR command permission to execute\&. A path name that ends in a slash (/) and an asterisk (*) indicates that all of the files contained in that directory where slash is the file-separator character, \f3File\&.separatorChar\fR\&. A path name that ends in a slash (/) and a minus sign (-) indicates all files and subdirectories contained in that directory (recursively)\&. A path name that consists of the special token \f3<<ALL FILES>>\fR matches any file\&. -.LP -.SH "SEE ALSO" -.LP -.LP -rmic(1), -.na -\f2CLASSPATH\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/tools/index.html#classpath, java(1) -.LP - +A path name that consists of an asterisk (*) indicates all the files in the current directory\&. A path name that consists of a minus sign (-) indicates all the files in the current directory and (recursively) all files and subdirectories contained in the current directory\&. + +\fIExecOptionPermission\fR + +The \f3ExecOptionPermission\fR class represents permission for the \f3rmid\fR command to use a specific command-line option when starting an activation group\&. The name of an \f3ExecOptionPermission\fR is the value of a command-line option\&. + +\fISyntax\fR: Options support a limited wild card scheme\&. An asterisk signifies a wild card match, and it can appear as the option name itself (matches any option), or an asterisk (*) can appear at the end of the option name only when the asterisk (*) follows a dot (\&.) or an equals sign (=)\&. + +For example: \f3*\fR or \f3-Dmydir\&.*\fR or \f3-Da\&.b\&.c=*\fR is valid, but \f3*mydir\fR or \f3-Da*b\fR or \f3ab*\fR is not\&. + +\fIPolicy file for rmid\fR + +When you grant the \f3rmid\fR command permission to execute various commands and options, the permissions \f3ExecPermission\fR and \f3ExecOptionPermission\fR must be granted to all code sources (universally)\&. It is safe to grant these permissions universally because only the \f3rmid\fR command checks these permissions\&. + +An example policy file that grants various execute permissions to the \f3rmid\fR command is: +.sp +.nf +\f3grant {\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/java/jdk1\&.7\&.0/solaris/bin/java";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecPermission\fP +.fi +.nf +\f3 "/files/apps/rmidcmds/*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.policy=/files/policies/group\&.policy";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Djava\&.security\&.debug=*";\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 permission com\&.sun\&.rmi\&.rmid\&.ExecOptionPermission\fP +.fi +.nf +\f3 "\-Dsun\&.rmi\&.*";\fP +.fi +.nf +\f3};\fP +.fi +.nf +\f3\fP +.fi +.sp + + +The first permission granted allows the \f3rmid\fR tcommand o execute the 1\&.7\&.0 release of the \f3java\fR command, specified by its explicit path name\&. By default, the version of the \f3java\fR command found in \f3java\&.home\fR is used (the same one that the \f3rmid\fR command uses), and does not need to be specified in the policy file\&. The second permission allows the \f3rmid\fR command to execute any command in the directory \f3/files/apps/rmidcmds\fR\&. + +The third permission granted, an \f3ExecOptionPermission\fR, allows the \f3rmid\fR command to start an activation group that defines the security policy file to be \f3/files/policies/group\&.policy\fR\&. The next permission allows the \f3java\&.security\&.debug property\fR to be used by an activation group\&. The last permission allows any property in the \f3sun\&.rmi property\fR name hierarchy to be used by activation groups\&. + +To start the \f3rmid\fR command with a policy file, the \f3java\&.security\&.policy\fR property needs to be specified on the \f3rmid\fR command line, for example: + +\f3rmid -J-Djava\&.security\&.policy=rmid\&.policy\fR\&. +.TP 0.2i +\(bu +<policyClassName> + +If the default behavior is not flexible enough, then an administrator can provide, when starting the \f3rmid\fR command, the name of a class whose \f3checkExecCommand\fR method is executed to check commands to be executed by the \f3rmid\fR command\&. + +The \f3policyClassName\fR specifies a public class with a public, no-argument constructor and an implementation of the following \f3checkExecCommand\fR method: +.sp +.nf +\f3 public void checkExecCommand(ActivationGroupDesc desc, String[] command)\fP +.fi +.nf +\f3 throws SecurityException;\fP +.fi +.nf +\f3\fP +.fi +.sp + + +Before starting an activation group, the \f3rmid\fR command calls the policy\&'s \f3checkExecCommand\fR method and passes to it the activation group descriptor and an array that contains the complete command to start the activation group\&. If the \f3checkExecCommand\fR throws a \f3SecurityException\fR, then the \f3rmid\fR command does not start the activation group and an \f3ActivationException\fR is thrown to the caller attempting to activate the object\&. +.TP 0.2i +\(bu +none + +If the \f3sun\&.rmi\&.activation\&.execPolicy\fR property value is \f3none\fR, then the \f3rmid\fR command does not perform any validation of commands to start activation groups\&. +.RE + +.TP +-log \fIdir\fR +.br +Specifies the name of the directory the activation system daemon uses to write its database and associated information\&. The log directory defaults to creating a log, in the directory in which the \f3rmid\fR command was executed\&. +.TP +-port \fIport\fR +.br +Specifies the port the registry uses\&. The activation system daemon binds the \f3ActivationSystem\fR, with the name \f3java\&.rmi\&.activation\&.ActivationSystem\fR, in this registry\&. The \f3ActivationSystem\fR on the local machine can be obtained using the following \f3Naming\&.lookup\fR method call: +.sp +.nf +\f3import java\&.rmi\&.*; \fP +.fi +.nf +\f3 import java\&.rmi\&.activation\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 ActivationSystem system; system = (ActivationSystem)\fP +.fi +.nf +\f3 Naming\&.lookup("//:port/java\&.rmi\&.activation\&.ActivationSystem");\fP +.fi +.nf +\f3\fP +.fi +.sp + +.TP +-stop +.br +Stops the current invocation of the \f3rmid\fR command for a port specified by the \f3-port\fR option\&. If no port is specified, then this option stops the \f3rmid\fR invocation running on port 1098\&. +.SH ENVIRONMENT\ VARIABLES +.TP +CLASSPATH +Used to provide the system a path to user-defined classes\&. Directories are separated by colons, for example: \f3\&.:/usr/local/java/classes\fR\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +Setting the Class Path +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/rmiregistry.1 b/jdk/src/solaris/doc/sun/man/man1/rmiregistry.1 index c94d270d623..a05a5176e7d 100644 --- a/jdk/src/solaris/doc/sun/man/man1/rmiregistry.1 +++ b/jdk/src/solaris/doc/sun/man/man1/rmiregistry.1 @@ -1,83 +1,99 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH rmiregistry 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: rmiregistry.1 +.\" +.if n .pl 99999 +.TH rmiregistry 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -rmiregistry \- The Java Remote Object Registry -.LP -.RS 3 -The \f3rmiregistry\fP command starts a remote object registry on the specified port on the current host. -.RE +.SH NAME +rmiregistry \- Starts a remote object registry on the specified port on the current host\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -rmiregistry [\fP\f4port\fP\f3] -.fl -\fP -.fi - -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f3rmiregistry\fP command creates and starts a remote object registry on the specified \f2port\fP on the current host. If \f2port\fP is omitted, the registry is started on port 1099. The \f3rmiregistry\fP command produces no output and is typically run in the background. For example: -.LP -.LP -\f2rmiregistry &\fP -.LP -.LP -A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names. Clients on local and remote hosts can then look up remote objects and make remote method invocations. -.LP -.LP -The registry is typically used to locate the first remote object on which an application needs to invoke methods. That object in turn will provide application\-specific support for finding other objects. -.LP -.LP -The methods of the \f2java.rmi.registry.LocateRegistry\fP class are used to get a registry operating on the local host or local host and port. -.LP -.LP -The URL\-based methods of the \f2java.rmi.Naming\fP class operate on a registry and can be used to look up a remote object on any host, and on the local host: bind a simple (string) name to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URLs bound in the registry. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-J -Used in conjunction with any \f2java\fP option, it passes the option following the \f2\-J\fP (no spaces between the \-J and the option) on to the \f2java\fP interpreter. -.RE - -.LP -.SH "SEE ALSO" -.LP -java(1), -.na -\f2java.rmi.registry.LocateRegistry\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/rmi/registry/LocateRegistry.html and -.na -\f2java.rmi.Naming\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/rmi/Naming.html +\fBrmiregistry\fR [ \fIport\fR ] +.fi +.sp +.TP +\fIport\fR +The number of a \f3port\fR on the current host at which to start the remote object registry\&. +.SH DESCRIPTION +The \f3rmiregistry\fR command creates and starts a remote object registry on the specified port on the current host\&. If the port is omitted, then the registry is started on port 1099\&. The \f3rmiregistry\fR command produces no output and is typically run in the background, for example: +.sp +.nf +\f3rmiregistry &\fP +.fi +.nf +\f3\fP +.fi +.sp +A remote object registry is a bootstrap naming service that is used by RMI servers on the same host to bind remote objects to names\&. Clients on local and remote hosts can then look up remote objects and make remote method invocations\&. +.PP +The registry is typically used to locate the first remote object on which an application needs to call methods\&. That object then provides application-specific support for finding other objects\&. +.PP +The methods of the \f3java\&.rmi\&.registry\&.LocateRegistry\fR class are used to get a registry operating on the local host or local host and port\&. +.PP +The URL-based methods of the \f3java\&.rmi\&.Naming\fR class operate on a registry and can be used to look up a remote object on any host and on the local host\&. Bind a simple name (string) to a remote object, rebind a new name to a remote object (overriding the old binding), unbind a remote object, and list the URL bound in the registry\&. +.SH OPTIONS +.TP +-J +.br +Used with any Java option to pass the option following the \f3-J\fR (no spaces between the \f3-J\fR and the option) to the Java interpreter\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +java(1) +.TP 0.2i +\(bu +\f3java\&.rmi\&.registry\&.LocateRegistry\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/registry/LocateRegistry\&.html +.TP 0.2i +\(bu +\f3java\&.rmi\&.Naming class description\fR at http://docs\&.oracle\&.com/javase/8/docs/api/java/rmi/Naming\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/schemagen.1 b/jdk/src/solaris/doc/sun/man/man1/schemagen.1 index 59c4c97ea58..7c51558ba78 100644 --- a/jdk/src/solaris/doc/sun/man/man1/schemagen.1 +++ b/jdk/src/solaris/doc/sun/man/man1/schemagen.1 @@ -1,127 +1,122 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH schemagen 1 "10 May 2011" +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: schemagen.1 +.\" +.if n .pl 99999 +.TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -schemagen \- Java(TM) Architecture for XML Binding Schema Generator -.LP -.LP -\f3Specification Version:\fP 2.1 +.SH NAME +schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIjava-files\fR +The Java class files to be processed\&. +.SH DESCRIPTION +The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.PP +Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. +.sp +.nf +\f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP +.fi +.nf +\f3Note: Writing schema1\&.xsd\fP +.fi +.nf +\f3\fP +.fi +.sp +If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. +.SH OPTIONS +.TP +-d \fIpath\fR .br -\f3Implementation Version:\fP 2.1.3 -.LP -.SH "Launching schemagen" -.LP -.LP -The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform. -.LP -.LP -The current schema generator can process either Java source files or class files. -.LP -.LP -We also provide an Ant task to run the schema generator \- see the instructions for -.na -\f2using schemagen with Ant\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. -.LP -.nf -\f3 -.fl -% schemagen.sh Foo.java Bar.java ... -.fl -Note: Writing schema1.xsd -.fl -\fP -.fi - -.LP -.LP -If your java sources/classes reference other classes, they must be accessable on your system CLASSPATH environment variable, or they need to be given to the tool by using the \f2\-classpath\fP/\f2\-cp\fP options. Otherwise you will see errors when generating your schema. -.LP -.SS -Command Line Options -.LP -.nf -\f3 -.fl -Usage: schemagen [\-options ...] <java files> -.fl - -.fl -Options: -.fl - \-d <path> : specify where to place processor and javac generated class files -.fl - \-cp <path> : specify where to find user specified files -.fl - \-classpath <path> : specify where to find user specified files -.fl - \-encoding <encoding> : specify encoding to be used for apt/javac invocation -.fl - -.fl - \-episode <file> : generate episode file for separate compilation -.fl - \-version : display version information -.fl - \-help : display this usage message -.fl -\fP -.fi - -.LP -.SH "Generated Resource Files" -.LP -.LP -The current schema generator simply creates a schema file for each namespace referenced in your Java classes. There is no way to control the name of the generated schema files at this time. For that purpose, use -.na -\f2the schema generator ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. -.LP -.SH "Name" -See Also -.LP -.RS 3 -.TP 2 -o -Running the schema generator (schemagen): [ -.na -\f2command\-line instructions\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html, -.na -\f2using the SchemaGen Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html] -.TP 2 -o -.na -\f2Java Architecture for XML Binding (JAXB)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html -.RE - -.LP - +The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. +.TP +-cp \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-classpath \fIpath\fR +.br +The location where the \f3schemagen\fR command places user-specified files\&. +.TP +-encoding \fIencoding\fR +.br +Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. +.TP +-episode \fIfile\fR +.br +Generates an episode file for separate compilation\&. +.TP +-version +.br +Displays release information\&. +.TP +-help +.br +Displays a help message\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/serialver.1 b/jdk/src/solaris/doc/sun/man/man1/serialver.1 index cb653146ba7..ba1dfcbef84 100644 --- a/jdk/src/solaris/doc/sun/man/man1/serialver.1 +++ b/jdk/src/solaris/doc/sun/man/man1/serialver.1 @@ -1,97 +1,111 @@ -." Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH serialver 1 "10 May 2011" +'\" t +.\" Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Remote Method Invocation (RMI) Tools +.\" Title: serialver.1 +.\" +.if n .pl 99999 +.TH serialver 1 "21 November 2013" "JDK 8" "Remote Method Invocation (RMI) Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -serialver \- The Serial Version Command -.LP -.LP -The \f3serialver\fP command returns the \f2serialVersionUID\fP. -.LP -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -\fP\f3serialver\fP [ options ] [ classnames ] -.fl -.fi +.SH NAME +serialver \- Returns the serial version UID for specified classes\&. +.SH SYNOPSIS +.sp +.nf -.LP -.RS 3 -.TP 3 -options -Command\-line options, as specified in this document. -.TP 3 -classnames -One or more class names -.RE - -.LP -.SH "DESCRIPTION" -.LP -.LP -\f3serialver\fP returns the \f2serialVersionUID\fP for one or more classes in a form suitable for copying into an evolving class. When invoked with no arguments it prints a usage line. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-classpath <directories and zip/jar files separated by :> -Set search path for application classes and resources. -.RE - -.LP -.RS 3 -.TP 3 -\-show -Displays a simple user interface. Enter the full class name and press either the Enter key or the Show button to display the serialVersionUID. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for the java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. -.RE - -.LP -.SH "NOTES" -.LP -.LP -The \f3serialver\fP command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager. If \f3serialver\fP is to be run with untrusted classes, a security manager can be set with the following option: -.LP -.LP -\f2\-J\-Djava.security.manager\fP -.LP -.LP -and, if necessary, a security policy can be specified with the following option: -.LP -.LP -\f2\-J\-Djava.security.policy=<policy file>\fP -.LP -.SH "SEE ALSO" -.LP -.LP -.na -\f2java.io.ObjectStreamClass\fP @ -.fi -http://download.oracle.com/javase/7/docs/api/java/io/ObjectStreamClass.html -.LP - +\fBserialver\fR [ \fIoptions\fR ] [ \fIclassnames\fR ] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIclassnames\fR +The classes for which the \f3serialVersionUID\fR is to be returned\&. +.SH DESCRIPTION +The \f3serialver\fR command returns the \f3serialVersionUID\fR for one or more classes in a form suitable for copying into an evolving class\&. When called with no arguments, the \f3serialver\fR command prints a usage line\&. +.SH OPTIONS +.TP +-classpath \fIpath-files\fR +.br +Sets the search path for application classes and resources\&. Separate classes and resources with a colon (:)\&. +.TP +-show +.br +Displays a simple user interface\&. Enter the full class name and press either the \fIEnter\fR key or the \fIShow\fR button to display the \f3serialVersionUID\fR\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +The \f3serialver\fR command loads and initializes the specified classes in its virtual machine, and by default, it does not set a security manager\&. If the \f3serialver\fR command is to be run with untrusted classes, then a security manager can be set with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.manager\fP +.fi +.nf +\f3\fP +.fi +.sp +When necessary, a security policy can be specified with the following option: +.sp +.nf +\f3\-J\-Djava\&.security\&.policy=<policy file>\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +policytool(1) +.TP 0.2i +\(bu +The \f3java\&.io\&.ObjectStream\fR class description at http://docs\&.oracle\&.com/javase/8/docs/api/java/io/ObjectStreamClass\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/servertool.1 b/jdk/src/solaris/doc/sun/man/man1/servertool.1 index fbb0829a124..b48e407c6b3 100644 --- a/jdk/src/solaris/doc/sun/man/man1/servertool.1 +++ b/jdk/src/solaris/doc/sun/man/man1/servertool.1 @@ -1,113 +1,138 @@ -." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH servertool 1 "10 May 2011" +'\" t +.\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: servertool.1 +.\" +.if n .pl 99999 +.TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -servertool \- The Java(TM) IDL Server Tool -.LP -\f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. -.SH "SYNOPSIS" -.LP -.nf -\f3 -.fl -servertool \-ORBInitialPort \fP\f4nameserverport\fP\f3 \fP\f3options\fP\f3 [ \fP\f3commands\fP\f3 ] -.fl -\fP -.fi +.SH NAME +servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. +.SH SYNOPSIS +.sp +.nf -.LP -.LP -If you did not enter a command when starting \f2servertool\fP, the command\-line tool displays with a \f2servertool >\fP prompt. Enter commands at the \f2servertool >\fP prompt. -.LP -.LP -If you enter a command when starting \f2servertool\fP, the Java IDL Server Tool starts, runs the command, and exits. -.LP -.LP -The \f2\-ORBInitialPort\fP \f2nameserverport\fP option is \f3required\fP. The value for \f2nameserverport\fP must specify the port on which \f2orbd\fP is running and listening for incoming requests. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024 for the \f2nameserverport\fP. -.LP -.SH "DESCRIPTION" -.LP -.LP -The \f2servertool\fP provides the command\-line interface for the application programmers to register, unregister, startup, and shutdown a persistent server. Other commands are provided to obtain various statistical information about the server. -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-ORBInitialHost nameserverhost -Specifies the host machine on which the name server is running and listening for incoming requests. The \f2nameserverhost\fP defaults to \f2localhost\fP if this option is not specified. If \f2orbd\fP and \f2servertool\fP are running on different machines, you must specify the name or IP address of the host on which \f2orbd\fP is running. -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.RE +\fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +commands +The command-line commands\&. See Commands\&. +.SH DESCRIPTION +The \f3servertool\fR command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server\&. Command-line commands let you obtain various statistical information about the server\&. See Commands\&. +.SH OPTIONS +.TP +-ORBInitialHost \fInameserverhost\fR +.br +This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. -.LP -.SH "COMMANDS" -.LP -.RS 3 -.TP 3 -register \-server\ <server\ class\ name> \ \-classpath\ <classpath\ to\ server> [\ \-applicationName\ <application\ name> \-args\ <args\ to\ server> \-vmargs\ <flags\ to\ be\ passed\ to\ Java\ VM> \ ] -Register a new persistent server with the Object Request Broker Daemon (ORBD). If the server is not already registered, it is registered and activated. This command causes an install method to be invoked in the main class of the server identified by the \f2\-server\fP option. The install method must be \f2public static void install(org.omg.CORBA.ORB)\fP. The install method is optional and enables the developer to provide their own server installation behavior (for example, creating database schema). -.TP 3 -unregister \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Unregister a server from the ORBD by using either its server id or its application name. This command causes an uninstall method to be invoked in the main class of the server identified by the \f2\-server\fP option. The uninstall method must be \f2public static void uninstall(org.omg.CORBA.ORB)\fP. The uninstall method is optional and enables the developer to provide their own server uninstall behavior (for example, undoing the behavior of the install method). -.TP 3 -getserverid \-applicationName\ <application\ name> -Return the server id that corresponds with an application. -.TP 3 -list -List information about all persistent servers registered with the ORBD. -.TP 3 -listappnames -List the application names for all servers currently registered with the ORBD. -.TP 3 -listactive -List information about all persistent servers that have been launched by the ORBD and are currently running. -.TP 3 -locate \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-endpointType\ <endpointType>\ ] -Locate the endpoints (ports) of a specific type for all ORBs created by a registered server. If a server is not already running, it is activated. If an endpoint type is not specified, then the plain/non\-protected endpoint associated with each ORB in a server is returned. -.TP 3 -locateperorb \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-orbid\ <ORB\ name>\ ] -Locate all the endpoints (ports) registered by a specific ORB of registered server. If a server is not already running, then it is activated. If an \f2orbid\fP is not specified, the default value of "" is assigned to the \f2orbid\fP. If any ORBs are created with an \f2orbid\fP of empty string, all ports registered by it are returned. -.TP 3 -orblist \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Lists the ORBId of the ORBs defined on a server. An ORBId is the string name for the ORB created by the server. If the server is not already running, it is activated. -.TP 3 -shutdown \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Shutdown an active server that is registered with ORBD. During execution of this command, the \f2shutdown()\fP method defined in the class specified by either the \f2\-serverid\fP or \f2\-applicationName\fP parameter is also invoked to shutdown the server process appropriately. -.TP 3 -startup \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> -Startup or activate a server that is registered with ORBD. If the server is not running, this command launches the server. If the server is already running, an error message is returned to the user. -.TP 3 -help -List all the commands available to the server through the server tool. -.TP 3 -quit -Exit the server tool. -.RE - -.LP -.SH "SEE ALSO" -.LP -orbd(1) +\fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH COMMANDS +You can start the \f3servertool\fR command with or without a command-line command\&. +.TP 0.2i +\(bu +If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. +.TP 0.2i +\(bu +If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. +.TP +.ll 180 +register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] +Registers a new persistent server with the Object Request Broker Daemon (ORBD)\&. If the server is not already registered, then it is registered and activated\&. This command causes an installation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. +.TP +.ll 180 +unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Unregisters a server from the ORBD with either its server ID or its application name\&. This command causes an uninstallation method to be called in the \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. +.TP +getserverid -applicationName \fIapplication-name\fR +Returns the server ID that corresponds to the \f3application-name\fR value\&. +.TP +list +Lists information about all persistent servers registered with the ORBD\&. +.TP +listappnames +Lists the application names for all servers currently registered with the ORBD\&. +.TP +listactive +Lists information about all persistent servers that were started by the ORBD and are currently running\&. +.TP +.ll 180 +locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] +Locates the endpoints (ports) of a specific type for all ORBs created by a registered server\&. If a server is not already running, then it is activated\&. If an \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. +.TP +.ll 180 +locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] +Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server\&. If a server is not already running, then it is activated\&. If an \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. +.TP +orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR +Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. +.TP +shutdown -serverid \fIserver-id\fR | -applicationName application-name +Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. +.TP +startup -serverid \fIserver-id\fR | -applicationName application-name +Starts up or activate a server that is registered with ORBD\&. If the server is not running, then this command starts the server\&. If the server is already running, then an error message is displayed\&. +.TP +help +Lists all the commands available to the server through the \f3servertool\fR command\&. +.TP +quit +Exits the \f3servertool\fR command\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/tnameserv.1 b/jdk/src/solaris/doc/sun/man/man1/tnameserv.1 index 2279b17520e..e883ab6008a 100644 --- a/jdk/src/solaris/doc/sun/man/man1/tnameserv.1 +++ b/jdk/src/solaris/doc/sun/man/man1/tnameserv.1 @@ -1,494 +1,489 @@ -." Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH tnameserv 1 "10 May 2011" +'\" t +.\" Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java IDL and RMI-IIOP Tools +.\" Title: tnameserv.1 +.\" +.if n .pl 99999 +.TH tnameserv 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -Java IDL: Transient Naming Service \- \f2tnameserv\fP -.LP -.LP -This document discusses using the Java IDL Transient Naming Service, \f2tnameserv\fP. Java IDL also includes the Object Request Broker Daemon (ORBD). ORBD is a daemon process containing a Bootstrap Service, a Transient Naming Service, a \f3Persistent\fP Naming Service, and a Server Manager. The Java IDL tutorials all use ORBD, however, you can substitute \f2tnameserv\fP for \f2orbd\fP in any of the examples that use a Transient Naming Service. For documentation on the \f2orbd\fP tool, link to its orbd(1) or the -.na -\f2Java IDL Naming Service Included with ORBD\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/jidlNaming.html topic. -.LP -.LP -Topics in this section include: -.LP -.RS 3 -.TP 2 -o -Java\ IDL Transient Naming Service -.TP 2 -o -Starting the Java\ IDL Transient Naming Service -.TP 2 -o -Stopping the Java\ IDL Transient Naming Service -.TP 2 -o -Sample Client: Adding Objects to the Namespace -.TP 2 -o -Sample Client: Browsing the Namespace -.RE +.SH NAME +tnameserv \- Interface Definition Language (IDL)\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "Java\ IDL Transient Naming Service" -.LP -.LP -The CORBA COS (Common Object Services) Naming Service provides a tree\-like directory for object references much like a filesystem provides a directory structure for files. The Transient Naming Service provided with Java IDL, \f2tnameserv\fP, is a simple implementation of the COS Naming Service specification. -.LP -.LP -Object references are stored in the namespace by name and each object reference\-name pair is called a name \f2binding\fP. Name bindings may be organized under \f2naming contexts\fP. Naming contexts are themselves name bindings and serve the same organizational function as a file system subdirectory. All bindings are stored under the \f2initial naming context\fP. The initial naming context is the only persistent binding in the namespace; the rest of the namespace is lost if the Java IDL naming service process halts and restarts. -.LP -.LP -For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to a stringified initial naming context for that naming service. The naming service can either be the Java\ IDL naming service or another COS\-compliant naming service. -.LP -.SH "Starting the Java\ IDL Transient Naming Service" -.LP -.LP -You must start the Java\ IDL naming service before an application or applet that uses its naming service. Installation of the Java\ IDL product creates a script (Solaris: \f2tnameserv\fP) or executable file (Windows NT: \f2tnameserv.exe\fP) that starts the Java\ IDL naming service. Start the naming service so it runs in the background. -.LP -.LP -If you do not specify otherwise, the Java\ IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f2resolve_initial_references()\fP and \f2list_initial_references()\fP methods, as follows: -.LP -.nf -\f3 -.fl - tnameserv \-ORBInitialPort \fP\f4nameserverport\fP\f3& -.fl -\fP -.fi - -.LP -.LP -If you do not specify the name server port, port 900 is used by default. When running Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: -.LP -.nf -\f3 -.fl - tnameserv \-ORBInitialPort 1050& -.fl -\fP -.fi - -.LP -.LP -From an MS\-DOS system prompt (Windows), enter: -.LP -.nf -\f3 -.fl - start tnameserv \-ORBInitialPort 1050 -.fl -\fP -.fi - -.LP -.LP -Clients of the name server must be made aware of the new port number. Do this by setting the \f2org.omg.CORBA.ORBInitialPort\fP property to the new port number when creating the ORB object. -.LP -.SS -Running the server and client on different hosts -.LP -.LP -In most of the Java IDL and RMI\-IIOP tutorials, the Naming Service, Server, and Client are all running on the development machine. In real world deployment, it is likely that the client and server will run on different host machines than the Naming Service. -.LP -.LP -For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running. Do this by setting the \f2org.omg.CORBA.ORBInitialPort\fP and \f2org.omg.CORBA.ORBInitialHost\fP properties in the client and server files to the machine name and port number on which the Naming Service is running. An example of this is shown in -.na -\f2The Hello World Example Using RMI\-IIOP\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/rmi\-iiop/rmiiiopexample.html. You could also use the command line options \f2\-ORBInitialPort\fP \f2nameserverport#\fP and \f2\-ORBInitialHost\fP \f2nameserverhostname\fP to tell the client and server where to find the Naming Service. -.na -\f2Java IDL: Running the Hello World Example on TWO Machines\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/idl/tutorial/jidl2machines.html shows one way of doing this using the command line option. -.LP -.LP -For example, suppose the Transient Naming Service, \f2tnameserv\fP is running on port 1050 on host \f2nameserverhost\fP. The client is running on host \f2clienthost\fP and the server is running on host \f2serverhost\fP. -.LP -.RS 3 -.TP 2 -o -Start \f2tnameserv\fP on the host \f2nameserverhost\fP, as follows: -.nf -\f3 -.fl - tnameserv \-ORBInitialPort 1050 -.fl - -.fl -\fP -.fi -.TP 2 -o -Start the server on the \f2serverhost\fP, as follows: -.nf -\f3 -.fl - java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost -.fl -\fP -.fi -.TP 2 -o -Start the client on the \f2clienthost\fP, as follows: -.nf -\f3 -.fl - java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost -.fl -\fP -.fi -.RE - -.LP -.SS -The \-J option -.LP -This command\-line option is available for use with \f2tnameserve\fP: -.RS 3 -.TP 3 -\-Joption -Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. -.RE - -.LP -.SH "Stopping the Java\ IDL Transient Naming Service" -.LP -.LP -To stop the Java\ IDL naming service, use the relevant operating system command, such as \f2kill\fP for a Unix process, or \f2Ctrl\-C\fP for a Windows process. The naming service will continue to wait for invocations until it is explicitly shutdown. Note that names registered with the Java\ IDL naming service disappear when the service is terminated. -.LP -.SH "Sample Client: Adding Objects to the Namespace" -.LP -.LP -The following sample program illustrates how to add names to the namespace. It is a self\-contained Transient Naming Service client that creates the following simple tree. -.LP -.RS 3 -.TP 2 -o -\f4Initial Naming Context\fP -.RS 3 -.TP 2 -* -\f3plans\fP -.TP 2 -* -\f4Personal\fP -.RS 3 -.TP 2 -- -\f3calendar\fP -.TP 2 -- -\f3schedule\fP -.RE -.RE -.RE - -.LP -.LP -In this example, \f3plans\fP is an object reference and \f3Personal\fP is a naming context that contains two object references: \f3calendar\fP and \f3schedule\fP. -.LP -.nf -\f3 -.fl -import java.util.Properties; -.fl -import org.omg.CORBA.*; -.fl -import org.omg.CosNaming.*; -.fl - -.fl -public class NameClient -.fl -{ -.fl - public static void main(String args[]) -.fl - { -.fl - try { -.fl -\fP -.fi - -.LP -In the above section, Starting the Java IDL Transient Naming Service, the nameserver was started on port 1050. The following code ensures that the client program is aware of this port number. -.nf -\f3 -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - ORB orb = ORB.init(args, props); -.fl - -.fl -\fP -.fi - -.LP -This code obtains the initial naming context and assigns it to \f3ctx\fP. The second line copies \f3ctx\fP into a dummy object reference \f3objref\fP that we'll attach to various names and add into the namespace. -.nf -\f3 -.fl - NamingContext ctx = -.fl -NamingContextHelper.narrow(orb.resolve_initial_references("NameService")); -.fl - NamingContext objref = ctx; -.fl - -.fl -\fP -.fi - -.LP -This code creates a name "plans" of type "text" and binds it to our dummy object reference. "plans" is then added under the initial naming context using \f2rebind\fP. The \f2rebind\fP method allows us to run this program over and over again without getting the exceptions we'd get from using \f2bind\fP. -.nf -\f3 -.fl - NameComponent nc1 = new NameComponent("plans", "text"); -.fl - NameComponent[] name1 = {nc1}; -.fl - ctx.rebind(name1, objref); -.fl - System.out.println("plans rebind sucessful!"); -.fl - -.fl -\fP -.fi - -.LP -This code creates a naming context called "Personal" of type "directory". The resulting object reference, \f3ctx2\fP, is bound to the name and added under the initial naming context. -.nf -\f3 -.fl - NameComponent nc2 = new NameComponent("Personal", "directory"); -.fl - NameComponent[] name2 = {nc2}; -.fl - NamingContext ctx2 = ctx.bind_new_context(name2); -.fl - System.out.println("new naming context added.."); -.fl - -.fl -\fP -.fi - -.LP -The remainder of the code binds the dummy object reference using the names "schedule" and "calendar" under the "Personal" naming context (\f3ctx2\fP). -.nf -\f3 -.fl - NameComponent nc3 = new NameComponent("schedule", "text"); -.fl - NameComponent[] name3 = {nc3}; -.fl - ctx2.rebind(name3, objref); -.fl - System.out.println("schedule rebind sucessful!"); -.fl - -.fl - NameComponent nc4 = new NameComponent("calender", "text"); -.fl - NameComponent[] name4 = {nc4}; -.fl - ctx2.rebind(name4, objref); -.fl - System.out.println("calender rebind sucessful!"); -.fl - -.fl - -.fl - } catch (Exception e) { -.fl - e.printStackTrace(System.err); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi - -.LP -.SH "Sample Client: Browsing the Namespace" -.LP -.LP -The following sample program illustrates how to browse the namespace. -.LP -.nf -\f3 -.fl -import java.util.Properties; -.fl -import org.omg.CORBA.*; -.fl -import org.omg.CosNaming.*; -.fl - -.fl -public class NameClientList -.fl -{ -.fl - public static void main(String args[]) -.fl - { -.fl - try { -.fl -\fP -.fi - -.LP -In the above section, Starting the Java IDL Transient Naming Service, the nameserver was started on port 1050. The following code ensures that the client program is aware of this port number. -.nf -\f3 -.fl - -.fl - Properties props = new Properties(); -.fl - props.put("org.omg.CORBA.ORBInitialPort", "1050"); -.fl - ORB orb = ORB.init(args, props); -.fl - -.fl - -.fl -\fP -.fi - -.LP -The following code obtains the intial naming context. -.nf -\f3 -.fl - NamingContext nc = -.fl -NamingContextHelper.narrow(orb.resolve_initial_references("NameService")); -.fl - -.fl -\fP -.fi - -.LP -The \f2list\fP method lists the bindings in the naming context. In this case, up to 1000 bindings from the initial naming context will be returned in the BindingListHolder; any remaining bindings are returned in the BindingIteratorHolder. -.nf -\f3 -.fl - BindingListHolder bl = new BindingListHolder(); -.fl - BindingIteratorHolder blIt= new BindingIteratorHolder(); -.fl - nc.list(1000, bl, blIt); -.fl - -.fl -\fP -.fi - -.LP -This code gets the array of bindings out of the returned BindingListHolder. If there are no bindings, the program ends. -.nf -\f3 -.fl - Binding bindings[] = bl.value; -.fl - if (bindings.length == 0) return; -.fl - -.fl -\fP -.fi - -.LP -The remainder of the code loops through the bindings and prints the names out. -.nf -\f3 -.fl - for (int i=0; i < bindings.length; i++) { -.fl - -.fl - // get the object reference for each binding -.fl - org.omg.CORBA.Object obj = nc.resolve(bindings[i].binding_name); -.fl - String objStr = orb.object_to_string(obj); -.fl - int lastIx = bindings[i].binding_name.length\-1; -.fl - -.fl - // check to see if this is a naming context -.fl - if (bindings[i].binding_type == BindingType.ncontext) { -.fl - System.out.println( "Context: " + -.fl -bindings[i].binding_name[lastIx].id); -.fl - } else { -.fl - System.out.println("Object: " + -.fl -bindings[i].binding_name[lastIx].id); -.fl - } -.fl - } -.fl - -.fl - } catch (Exception e) { -.fl - e.printStackTrace(System.err); -.fl - } -.fl - } -.fl -} -.fl -\fP -.fi - -.LP - +\fBtnameserve\fR \fB\-ORBInitialPort\fR [ \fInameserverport\fR ] +.fi +.sp +.TP +-ORBInitialPort \fInameserverport\fR +.br +The initial port where the naming service listens for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references\fR methods\&. +.SH DESCRIPTION +Java IDL includes the Object Request Broker Daemon (ORBD)\&. ORBD is a daemon process that contains a Bootstrap Service, a Transient Naming Service, a Persistent Naming Service, and a Server Manager\&. The Java IDL tutorials all use ORBD, but you can substitute the \f3tnameserv\fR command for the \f3orbd\fR command in any of the examples that use a Transient Naming Service\&. +.PP +See orbd(1) or Naming Service at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/jidlNaming\&.html +.PP +The CORBA Common Object Services (COS) Naming Service provides a tree-structure directory for object references similar to a file system that provides a directory structure for files\&. The Transient Naming Service provided with Java IDL, \f3tnameserv\fR, is a simple implementation of the COS Naming Service specification\&. +.PP +Object references are stored in the name space by name and each object reference-name pair is called a name binding\&. Name bindings can be organized under naming contexts\&. Naming contexts are name bindings and serve the same organizational function as a file system subdirectory\&. All bindings are stored under the initial naming context\&. The initial naming context is the only persistent binding in the name space\&. The rest of the name space is lost when the Java IDL naming service process stops and restarts\&. +.PP +For an applet or application to use COS naming, its ORB must know the port of a host running a naming service or have access to an initial naming context string for that naming service\&. The naming service can either be the Java IDL naming service or another COS-compliant naming service\&. +.SS START\ THE\ NAMING\ SERVICE +You must start the Java IDL naming service before an application or applet that uses its naming service\&. Installation of the Java IDL product creates a script (Oracle Solaris: \f3tnameserv\fR) or executable file (Windows: \f3tnameserv\&.exe\fR) that starts the Java IDL naming service\&. Start the naming service so it runs in the background\&. +.PP +If you do not specify otherwise, then the Java IDL naming service listens on port 900 for the bootstrap protocol used to implement the ORB \f3resolve_initial_references\fR and \f3list_initial_references methods\fR, as follows: +.sp +.nf +\f3tnameserv \-ORBInitialPort nameserverport&\fP +.fi +.nf +\f3\fP +.fi +.sp +If you do not specify the name server port, then port 900 is used by default\&. When running Oracle Solaris software, you must become the root user to start a process on a port below 1024\&. For this reason, it is recommended that you use a port number greater than or equal to 1024\&. To specify a different port, for example, 1050, and to run the naming service in the background, from a UNIX command shell, enter: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050&\fP +.fi +.nf +\f3\fP +.fi +.sp +From an MS-DOS system prompt (Windows), enter: +.sp +.nf +\f3start tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Clients of the name server must be made aware of the new port number\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR property to the new port number when you create the ORB object\&. +.SS RUN\ THE\ SERVER\ AND\ CLIENT\ ON\ DIFFERENT\ HOSTS +In most of the Java IDL and RMI-IIOP tutorials, the naming service, server, and client are all running on the development machine\&. In real-world deployment, the client and server probably run on different host machines from the Naming Service\&. +.PP +For the client and server to find the Naming Service, they must be made aware of the port number and host on which the naming service is running\&. Do this by setting the \f3org\&.omg\&.CORBA\&.ORBInitialPort\fR and \f3org\&.omg\&.CORBA\&.ORBInitialHost\fR properties in the client and server files to the machine name and port number on which the Naming Service is running\&. An example of this is shown in Getting Started Using RMI-IIOP at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/rmi-iiop/rmiiiopexample\&.html +.PP +You could also use the command-line options \f3-ORBInitialPort nameserverport#\fR and \f3-ORBInitialHost nameserverhostname\fR to tell the client and server where to find the naming service\&. For one example of doing this using the command-line option, see Java IDL: The Hello World Example on Two Machines at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/idl/tutorial/jidl2machines\&.html +.PP +For example, suppose the Transient Naming Service, \f3tnameserv\fR is running on port 1050 on host \f3nameserverhost\fR\&. The client is running on host \f3clienthost,\fR and the server is running on host \f3serverhost\fR\&. +.PP +Start \f3tnameserv\fR on the host \f3nameserverhost\fR: +.sp +.nf +\f3tnameserv \-ORBInitialPort 1050\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the server on the \f3serverhost\fR: +.sp +.nf +\f3java Server \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +Start the client on the \f3clienthost\fR: +.sp +.nf +\f3java Client \-ORBInitialPort 1050 \-ORBInitialHost nameserverhost\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS STOP\ THE\ NAMING\ SERVICE +To stop the Java IDL naming service, use the relevant operating system command, such as \f3kill\fR for a Unix process or \f3Ctrl+C\fR for a Windows process\&. The naming service continues to wait for invocations until it is explicitly shut down\&. Note that names registered with the Java IDL naming service disappear when the service is terminated\&. +.SH OPTIONS +.TP +-J\fIoption\fR +.br +Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH EXAMPLES +.SS ADD\ OBJECTS\ TO\ THE\ NAME\ SPACE +The following example shows how to add names to the name space\&. It is a self-contained Transient Naming Service client that creates the following simple tree\&. +.sp +.nf +\f3Initial Naming Context\fP +.fi +.nf +\f3 plans\fP +.fi +.nf +\f3 Personal\fP +.fi +.nf +\f3 calendar\fP +.fi +.nf +\f3 schedule\fP +.fi +.nf +\f3\fP +.fi +.sp +In this example, \f3plans\fR is an object reference and \f3Personal\fR is a naming context that contains two object references: \f3calendar\fR and \f3schedule\fR\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClient {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code obtains the initial naming context and assigns it to \f3ctx\fR\&. The second line copies \f3ctx\fR into a dummy object reference \f3objref\fR that is attached to various names and added into the name space\&. +.sp +.nf +\f3 NamingContext ctx =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3 NamingContext objref = ctx;\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a name \f3plans\fR of type \f3text\fR and binds it to the dummy object reference\&. \f3plans\fR is then added under the initial naming context using the \f3rebind\fR method\&. The \f3rebind\fR method enables you to run this program over and over again without getting the exceptions from using the \f3bind\fR method\&. +.sp +.nf +\f3 NameComponent nc1 = new NameComponent("plans", "text");\fP +.fi +.nf +\f3 NameComponent[] name1 = {nc1};\fP +.fi +.nf +\f3 ctx\&.rebind(name1, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("plans rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.sp +This code creates a naming context called \f3Personal\fR of type \f3directory\fR\&. The resulting object reference, \f3ctx2\fR, is bound to the \f3name\fR and added under the initial naming context\&. +.sp +.nf +\f3 NameComponent nc2 = new NameComponent("Personal", "directory");\fP +.fi +.nf +\f3 NameComponent[] name2 = {nc2};\fP +.fi +.nf +\f3 NamingContext ctx2 = ctx\&.bind_new_context(name2);\fP +.fi +.nf +\f3 System\&.out\&.println("new naming context added\&.\&.");\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code binds the dummy object reference using the names \f3schedule\fR and \f3calendar\fR under the \f3Personal\fR naming context (\f3ctx2\fR)\&. +.sp +.nf +\f3 NameComponent nc3 = new NameComponent("schedule", "text");\fP +.fi +.nf +\f3 NameComponent[] name3 = {nc3};\fP +.fi +.nf +\f3 ctx2\&.rebind(name3, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("schedule rebind successful!");\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 NameComponent nc4 = new NameComponent("calender", "text");\fP +.fi +.nf +\f3 NameComponent[] name4 = {nc4};\fP +.fi +.nf +\f3 ctx2\&.rebind(name4, objref);\fP +.fi +.nf +\f3 System\&.out\&.println("calender rebind successful!");\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SS BROWSING\ THE\ NAME\ SPACE +The following sample program shoes how to browse the name space\&. +.sp +.nf +\f3import java\&.util\&.Properties;\fP +.fi +.nf +\f3import org\&.omg\&.CORBA\&.*;\fP +.fi +.nf +\f3import org\&.omg\&.CosNaming\&.*;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3public class NameClientList {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 public static void main(String args[]) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 try {\fP +.fi +.nf +\f3\fP +.fi +.sp +In Start the Naming Service, the \f3nameserver\fR was started on port 1050\&. The following code ensures that the client program is aware of this port number\&. +.sp +.nf +\f3 Properties props = new Properties();\fP +.fi +.nf +\f3 props\&.put("org\&.omg\&.CORBA\&.ORBInitialPort", "1050");\fP +.fi +.nf +\f3 ORB orb = ORB\&.init(args, props);\fP +.fi +.nf +\f3\fP +.fi +.sp +The following code obtains the initial naming context\&. +.sp +.nf +\f3 NamingContext nc =\fP +.fi +.nf +\f3 NamingContextHelper\&.narrow(\fP +.fi +.nf +\f3 orb\&.resolve_initial_references("NameService"));\fP +.fi +.nf +\f3\fP +.fi +.sp +The \f3list\fR method lists the bindings in the naming context\&. In this case, up to 1000 bindings from the initial naming context will be returned in the \f3BindingListHolder\fR; any remaining bindings are returned in the \f3BindingIteratorHolder\fR\&. +.sp +.nf +\f3 BindingListHolder bl = new BindingListHolder();\fP +.fi +.nf +\f3 BindingIteratorHolder blIt= new BindingIteratorHolder();\fP +.fi +.nf +\f3 nc\&.list(1000, bl, blIt);\fP +.fi +.nf +\f3\fP +.fi +.sp +This code gets the array of bindings out of the returned \f3BindingListHolder\fR\&. If there are no bindings, then the program ends\&. +.sp +.nf +\f3 Binding bindings[] = bl\&.value;\fP +.fi +.nf +\f3 if (bindings\&.length == 0) return;\fP +.fi +.nf +\f3\fP +.fi +.sp +The remainder of the code loops through the bindings and prints outs the names\&. +.sp +.nf +\f3 for (int i=0; i < bindings\&.length; i++) {\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // get the object reference for each binding\fP +.fi +.nf +\f3 org\&.omg\&.CORBA\&.Object obj = nc\&.resolve(bindings[i]\&.binding_name);\fP +.fi +.nf +\f3 String objStr = orb\&.object_to_string(obj);\fP +.fi +.nf +\f3 int lastIx = bindings[i]\&.binding_name\&.length\-1;\fP +.fi +.nf +\f3\fP +.fi +.nf +\f3 // check to see if this is a naming context\fP +.fi +.nf +\f3 if (bindings[i]\&.binding_type == BindingType\&.ncontext) {\fP +.fi +.nf +\f3 System\&.out\&.println("Context: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 } else {\fP +.fi +.nf +\f3 System\&.out\&.println("Object: " +\fP +.fi +.nf +\f3 bindings[i]\&.binding_name[lastIx]\&.id);\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 } catch (Exception e) {\fP +.fi +.nf +\f3 e\&.printStackTrace(System\&.err)\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3 }\fP +.fi +.nf +\f3}\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +orbd(1) +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/unpack200.1 b/jdk/src/solaris/doc/sun/man/man1/unpack200.1 index ff6eb224090..2327bc02cac 100644 --- a/jdk/src/solaris/doc/sun/man/man1/unpack200.1 +++ b/jdk/src/solaris/doc/sun/man/man1/unpack200.1 @@ -1,156 +1,138 @@ -." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH unpack200 1 "10 May 2011" +'\" t +.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Deployment Tools +.\" Title: unpack200.1 +.\" +.if n .pl 99999 +.TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -unpack200 \- JAR Unpacking tool -.LP -.SH "SYNOPSIS" -.LP -.LP -\f4unpack200\fP\f2 [ \fP\f2options\fP ] \f2input\-file\fP \f2JAR\-file\fP -.LP -.LP -Options may be in any order. The last option on the command line supersedes all previously specified options. -.LP -.RS 3 -.TP 3 -input\-file -Name of the input file, which can be a pack200 gzip file or a pack200 file. The input could also be JAR file produced by pack200(1) with an effort of 0. In this case the contents of the input file will be copied to the output JAR file with the Pack200 marker. -.TP 3 -JAR\-file -Name of the output JAR file. -.RE +.SH NAME +unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "DESCRIPTION" -.LP -.LP -\f2unpack200\fP is a native implementation that transforms a packed file produced by \f2pack200\fP(1) into a JAR file. Typical usage: -.LP -.LP -\f2% unpack200 myarchive.pack.gz myarchive.jar\fP -.LP -.LP -In this example, the \f2myarchive.jar\fP is produced from \f2myarchive.pack.gz\fP using the default \f2unpack200\fP settings. -.LP -.SH "OPTIONS" -.LP -.LP -\f4\-Hvalue \-\-deflate\-hint=\fP\f2value\fP -.LP -.LP -Sets the deflation to be \f2true\fP, \f2false\fP, or \f2keep\fP on all entries within a JAR file. The default mode is \f2keep\fP. If \f2true\fP or \f2false\fP, overrides the default behavior and sets the deflation mode on all entries within the output JAR file. -.LP -.LP -\f4\-r \-\-remove\-pack\-file\fP -.LP -.LP -Removes the input packed file. -.LP -.LP -\f4\-v \-\-verbose\fP -.LP -.LP -Outputs minimal messages. Multiple specification of this option will output more verbose messages. -.LP -.LP -\f4\-q \-\-quiet\fP -.LP -.LP -Specifies quiet operation with no messages. -.LP -.LP -\f4\-lfilename \-\-log\-file=\fP\f2filename\fP -.LP -.LP -Specifies a log file to output messages. -.LP -.LP -\f4\-? \-h \-\-help\fP -.LP -.LP -Prints help information about this command. -.LP -.LP -\f4\-V \-\-version\fP -.LP -.LP -Prints version information about this command. -.LP -.LP -\f4\-J\fP\f2option\fP -.LP -.LP -Passes \f2option\fP to the Java launcher called by \f2unpack200\fP. -.LP -.SH "EXIT STATUS" -.LP -.LP -The following exit values are returned: -.LP -.LP -\f2\ 0\fP if successful completion; -.LP -.LP -\f2>0\fP if an error occurred. -.LP -.SH "SEE ALSO" -.LP -.RS 3 -.TP 2 -o -pack200(1) -.TP 2 -o -.na -\f2Java SE Documentation\fP @ -.fi -http://download.oracle.com/javase/7/docs/index.html -.TP 2 -o -.na -\f2Java Deployment Guide \- Pack200\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/deployment/deployment\-guide/pack200.html -.TP 2 -o -jar(1) \- Java Archive Tool -.TP 2 -o -jarsigner(1) \- JAR Signer tool -.TP 2 -o -\f2attributes(5)\fP man page -.RE - -.LP -.SH "NOTES" -.LP -.LP -This command should not be confused with \f2unpack(1)\fP. They are distinctly separate products. -.LP -.LP -The Java SE API Specification provided with the JDK is the superseding authority, in case of discrepancies. -.LP - +\fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIinput-file\fR +Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&. +.TP +\fIJAR-file\fR +Name of the output JAR file\&. +.SH DESCRIPTION +The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&. +.sp +.nf +\f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-Hvalue --deflate-hint=\fIvalue\fR +.br +Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&. +.TP +-r --remove-pack-file +.br +Removes the input pack file\&. +.TP +-v --verbose +.br +Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&. +.TP +-q --quiet +.br +Specifies quiet operation with no messages\&. +.TP +-lfilename --log-file=\fIfilename\fR +.br +Specifies a log file where output messages are logged\&. +.TP +-? -h --help +.br +Prints help information about the \f3unpack200\fR command\&. +.TP +-V --version +.br +Prints version information about the \f3unpack200\fR command\&. +.TP +-J\fIoption\fR +.br +Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. +.SH NOTES +This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&. +.PP +The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&. +.SH EXIT\ STATUS +The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +pack200(1) +.TP 0.2i +\(bu +jar(1) +.TP 0.2i +\(bu +jarsigner(1) +.TP 0.2i +\(bu +Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html +.TP 0.2i +\(bu +The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/ +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/wsgen.1 b/jdk/src/solaris/doc/sun/man/man1/wsgen.1 index 49acb9efd07..56776b59781 100644 --- a/jdk/src/solaris/doc/sun/man/man1/wsgen.1 +++ b/jdk/src/solaris/doc/sun/man/man1/wsgen.1 @@ -1,598 +1,176 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH wsgen 1 "10 May 2011" -.SH "Name" -wsgen \- Java(TM) API for XML Web Services (JAX\-WS) 2.0 -.LP -\f3Specification Version:\fP 2.1 -.br -\f3Implementation Version:\fP 2.1.1 -.LP -The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint implementation class (SEI) and generates all the required artifacts for web service deployment, and invocation -.SH "Overview" -.LP -The \f2wsgen\fP tool generates JAX\-WS portable artifacts used in JAX\-WS web services. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment, and invocation. JAXWS 2.1.1 RI also provides a wsgen ant task, see -.na -\f2Wsgen ant task\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/wsgenant.html for details. -.LP -.SH "Launching wsgen" -.RS 3 -.TP 2 -o -\f3Solaris/Linux\fP -.RS 3 -.TP 2 -* -\f2export JAXWS_HOME=/pathto/jaxws\-ri\fP -.TP 2 -* -\f2$JAXWS_HOME/bin/wsgen.sh \-help\fP -.RE -.TP 2 -o -\f3Windows\fP -.RS 3 -.TP 2 -* -\f2set JAXWS_HOME=c:\\pathto\\jaxws\-ri\fP -.TP 2 -* -\f2%JAXWS_HOME%\\bin\\wsgen.bat \-help\fP -.RE -.RE +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsgen.1 +.\" +.if n .pl 99999 +.TH wsgen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Syntax" -.nf -\f3 -.fl -wsgen [options] <SEI>\fP -.br -\f3 -.fl -\fP -.fi -.LP -The following table lists the \f2wsgen\fP options. -.br -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to find input class files -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Same as \f2\-classpath <path>\fP -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated output files -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -allow vendor extensions (functionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \-wsdl option. Specify where to place generated resource files such as WSDLs -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated source files -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Output messages about what the compiler is doing -.br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print version information. Use of this option will ONLY print version information. Normal processing will not occur. -.br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -By default \f2wsgen\fP does not generate a WSDL file. This flag is optional and will cause \f2wsgen\fP to generate a WSDL file and is usually only used so that the developer can look at the WSDL before the endpoint is deploy. The \f2protocol\fP is optional and is used to specify what protocol should be used in the \f2wsdl:binding\fP. Valid protocols include: \f2soap1.1\fP and \f2Xsoap1.2\fP. The default is \f2soap1.1\fP. \f2Xsoap1.2\fP is not standard and can only be used in conjunction with the \f2\-extension\fP option. -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particular \f2wsdl:service\fP name to be generated in the WSDL. Example, \f2\-servicename "{http://mynamespace/}MyService"\fP -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Used only in conjunction with the \f2\-wsdl\fP option. Used to specify a particular \f2wsdl:port\fP name to be generated in the WSDL. Example, \f2\-portname "{http://mynamespace/}MyPort"\fP -.br -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-classpath <path>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-cp <path>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-d <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-extension\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-help\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-keep\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-r <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-s <directory>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-verbose\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-version\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-wsdl[:protocol]\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-servicename <name>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f4\-portname <name>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wDisplay help -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wKeep generated files -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 133 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-classpath <path>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-cp <path>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-d <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-extension\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-help\fP\h'|\n(41u'Display help -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-keep\fP\h'|\n(41u'Keep generated files -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-r <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-s <directory>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(g|u+\n(.Vu -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-verbose\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-version\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-wsdl[:protocol]\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-servicename <name>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f4\-portname <name>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-53 +.SH NAME +wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "Example" -.nf -\f3 -.fl -\fP\f3wsgen \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -This will generate the wrapper classes needed for StockService annotated with @WebService annotation inside \f3stock\fPdirectory. -.nf -\f3 -.fl -\fP\f3wsgen \-wsdl \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -This will generate a SOAP 1.1 WSDL and schema for your Java class stock.StockService annotated with @WebService annotation. -.nf -\f3 -.fl -\fP\f3wsgen \-wsdl:Xsoap1.2 \-d stock \-cp myclasspath stock.StockService\fP -.fl -.fi -.LP -Will generate a SOAP 1.2 WSDL. -.LP -Note that you do not have to generate WSDL at the development time as JAXWS runtime will automatically generate a WSDL for you when you deploy your service. +\fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fISEI\fR +The web service endpoint implementation class (SEI) to be read\&. +.SH DESCRIPTION +The \f3wsgen\fR command generates JAX-WS portable artifacts used in JAX-WS web services\&. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment and invocation\&. JAXWS 2\&.1\&.1 RI also provides a \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.PP +To start the \f3wsgen\fR command, do the following: +.sp +.nf +\f3export JAXWS_HOME=/pathto/jaxws\-ri\fP +.fi +.nf +\f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-classpath \fIpath\fR +.br +The location of the input class files\&. +.TP +-cp \fIpath\fR +.br +The location of the input class files\&. +.TP +-d \fIdirectory\fR +.br +The location for where to place generated output files\&. +.TP +-extension +.br +Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help +.br +Displays a help message about the \f3wsgen\fR command\&. +.TP +-keep +.br +Keeps the generated files\&. +.TP +-r \fIdirectory\fR +.br +Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&. +.TP +-s \fIdirectory\fR +.br +The location for where to place generated source files\&. +.TP +-verbose +.br +Displays compiler messages\&. +.TP +-version +.br +Prints release information\&. +.TP +-wsdl [ :protocol ] \fI\fR +.br +An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&. + +By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&. +.TP +-servicename \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&. +.TP +-portname \fIname\fR +.br +Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&. +.SH EXAMPLES +The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&. +.sp +.nf +\f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&. +.sp +.nf +\f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP +.fi +.nf +\f3\fP +.fi +.sp +The following example generates a SOAP 1\&.2 WSDL\&. +.sp +.nf +\f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP +.fi +.nf +\f3\fP +.fi +.sp +\fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsimport(1) +.TP 0.2i +\(bu +\fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/wsimport.1 b/jdk/src/solaris/doc/sun/man/man1/wsimport.1 index 424a4cb98d9..edc3ef56d40 100644 --- a/jdk/src/solaris/doc/sun/man/man1/wsimport.1 +++ b/jdk/src/solaris/doc/sun/man/man1/wsimport.1 @@ -1,979 +1,217 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH wsimport 1 "10 May 2011" -.SH "Name" -wsimport \- Java(TM) API for XML Web Services (JAX\-WS) 2.0 -.LP -\f3Specification Version:\fP 2.1 -.br -\f3Implementation Version:\fP 2.1.1 -.br -.SH "Overview" -.LP -The \f2wsimport\fP tool generates JAX\-WS portable artifacts, such as: -.RS 3 -.TP 2 -o -Service Endpoint Interface (SEI) -.TP 2 -o -Service -.TP 2 -o -Exception class mapped from wsdl:fault (if any) -.TP 2 -o -Async Reponse Bean derived from response wsdl:message (if any) -.TP 2 -o -JAXB generated value types (mapped java classes from schema types) -.RE -.LP -These artifacts can be packaged in a WAR file with the WSDL and schema documents along with the endpoint implementation to be deployed. also provides wsimport ant task, see -.na -\f2Wsimport ant task\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/wsimportant.html. -.br +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: wsimport.1 +.\" +.if n .pl 99999 +.TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Launching wsimport" -.RS 3 -.TP 2 -o -\f3Solaris/Linux\fP -.RS 3 -.TP 2 -* -\f2/bin/wsimport.sh \-help\fP -.RE -.TP 2 -o -\f3Windows\fP -.RS 3 -.TP 2 -* -\f2\\bin\\wsimport.bat \-help\fP -.RE -.RE +.SH NAME +wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. +.SH SYNOPSIS +.sp +.nf -.LP -.SH "Syntax" -.nf -\f3 -.fl -wsimport [options] <wsdl> -.fl -\fP -.fi -.LP -The following table lists the \f2wsimport\fP options. -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 +\fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +\fIwsdl\fR +The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. +.SH DESCRIPTION +The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +Service Endpoint Interface (SEI) +.TP 0.2i +\(bu +Service +.TP 0.2i +\(bu +Exception class is mapped from \f3wsdl:fault\fR (if any) +.TP 0.2i +\(bu +Async Response Bean is derived from response \f3wsdl:message\fR (if any) +.TP 0.2i +\(bu +JAXB generated value types (mapped java classes from schema types) +.PP +To start the \f3wsgen\fR command, do the following: +.PP +\fIOracle Solaris/Linux\fR: +.sp +.nf +\f3/bin/wsimport\&.sh \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +\fIWindows\fR: +.sp +.nf +\f3\ebin\ewsimport\&.bat \-help\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH OPTIONS +.TP +-d \fIdirectory\fR .br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated output files +Specifies where to place generated output files\&. +.TP +-b \fIpath\fR .br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 +Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP +-B \fIjaxbOption\fR .br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify external JAX\-WS or JAXB binding files (Each \f2<file>\fP must have its own \f2\-b\fP) +Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. +.TP +-catalog .br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 +Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP +-extension .br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Pass this option to JAXB schema compiler +Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. +.TP +-help .br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 81 +Displays a help message for the \f3wsimport\fR command\&. +.TP +-httpproxy: \fIhost\fR:\fIport\fR .br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify catalog file to resolve external entity references, it supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the documentation of -.na -\f2catalog\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/catalog\-support.html and see \f3catalog\fP sample. +Specifies an HTTP proxy server\&. The default is 8080\&. +.TP +-keep .br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 +Keeps generated files\&. +.TP +-p \fIname\fR .br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Allow vendor extensions (functionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations +Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. +.TP +-s \fIdirectory\fR .br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 80 +Specifies where to place generated source files\&. +.TP +-verbose .br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-httpproxy:<host>:<port> \fP +Displays compiler messages\&. +.TP +-version .br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.eo -.am 81 +Prints release information\&. +.TP +-wsdllocation \fIlocation\fR .br -.di g+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify an HTTP proxy server (port defaults to 8080) +Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. +.TP +-target .br -.di -.nr g| \n(dn -.nr g- \n(dl -.. -.ec \ -.eo -.am 81 +Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. +.TP +-quiet .br -.di h+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specifying a target package via this command\-line option, overrides any wsdl and schema binding customization for package name and the default package name algorithm defined in the specification +Suppresses the \f3wsimport\fR command output\&. +.PP +Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html +.SH NONSTANDARD\ OPTIONS +.TP +-XadditionalHeaders .br -.di -.nr h| \n(dn -.nr h- \n(dl -.. -.ec \ -.eo -.am 81 +Maps headers not bound to a request or response message to Java method parameters\&. +.TP +-Xauthfile \fIfile\fR .br -.di i+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Specify where to place generated source files -.br -.di -.nr i| \n(dn -.nr i- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di j+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Output messages about what the compiler is doing -.br -.di -.nr j| \n(dn -.nr j- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di k+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print version information -.br -.di -.nr k| \n(dn -.nr k- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di l+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-wsdllocation <location>\fP -.br -.di -.nr l| \n(dn -.nr l- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di m+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -\f2@WebServiceClient.wsdlLocation\fP value -.br -.di -.nr m| \n(dn -.nr m- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di n+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Generate code as per the given JAX\-WS specification version. version 2.0 will generate compliant code for JAX\-WS 2.0 spec. -.br -.di -.nr n| \n(dn -.nr n- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-d <directory> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-b <path> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-B <jaxbOption>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-catalog\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-extension \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-help \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-keep \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-p \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-s <directory> \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-verbose \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-version \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-target \fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-quiet \fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(f- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \n(l- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wDisplay help -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wKeep generated files -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \wSuppress wsimport output -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(d- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(g- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(h- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(i- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(j- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(k- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(m- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(n- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 157 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-d <directory> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-b <path> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-B <jaxbOption>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-catalog\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(e|u+\n(.Vu -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-extension \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-help \fP\h'|\n(41u'Display help -.ne \n(f|u+\n(.Vu -.ne \n(g|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.g+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-keep \fP\h'|\n(41u'Keep generated files -.ne \n(h|u+\n(.Vu -.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-p \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.h+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(i|u+\n(.Vu -.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-s <directory> \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.i+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(j|u+\n(.Vu -.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-verbose \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.j+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(k|u+\n(.Vu -.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-version \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.k+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(l|u+\n(.Vu -.ne \n(m|u+\n(.Vu -.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v) -.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.l+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.m+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(n|u+\n(.Vu -.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-target \fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.n+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-quiet \fP\h'|\n(41u'Suppress wsimport output -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.rm g+ -.rm h+ -.rm i+ -.rm j+ -.rm k+ -.rm l+ -.rm m+ -.rm n+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-66 -.LP -Multiple JAX\-WS and JAXB binding files can be specified using \f2\-b\fP option and they can be used to customize various things like package names, bean names, etc. More information on JAX\-WS and JAXB binding files can be found in the -.na -\f2customization documentation\fP @ -.fi -https://jax\-ws.dev.java.net/nonav/2.1.1/docs/customizations.html. -.LP -The following table lists \f2wsimport\fP non\-standard options: -.LP -.TS -.if \n+(b.=1 .nr d. \n(.c-\n(c.-1 -.de 35 -.ps \n(.s -.vs \n(.vu -.in \n(.iu -.if \n(.u .fi -.if \n(.j .ad -.if \n(.j=0 .na -.. -.nf -.nr #~ 0 -.if n .nr #~ 0.6n -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.fc -.nr 33 \n(.s -.rm 80 81 -.nr 34 \n(.lu -.eo -.am 81 -.br -.di a+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Map headers not bound to request or response message to Java method parameters. -.br -.di -.nr a| \n(dn -.nr a- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di b+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -WSDL URI that specifies the file that contains authorization information; this URI is in the following format: http://\f2<user name>\fP:\f2<password>\fP@\f2<host name>\fP/\f2<Web service name>\fP?wsdl -.br -.di -.nr b| \n(dn -.nr b- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di c+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Print debugging information. -.br -.di -.nr c| \n(dn -.nr c- \n(dl -.. -.ec \ -.eo -.am 80 -.br -.di d+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(80 .ll \n(80u -.in 0 -\f3\-Xno\-addressing\-databinding\fP -.br -.di -.nr d| \n(dn -.nr d- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di e+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Enable binding of W3C \f2EndpointReferenceType\fP to Java. -.br -.di -.nr e| \n(dn -.nr e- \n(dl -.. -.ec \ -.eo -.am 81 -.br -.di f+ -.35 -.ft \n(.f -.ll \n(34u*1u/3u -.if \n(.l<\n(81 .ll \n(81u -.in 0 -Do not compile generated Java files. -.br -.di -.nr f| \n(dn -.nr f- \n(dl -.. -.ec \ -.35 -.nf -.ll \n(34u -.nr 80 0 -.nr 38 \w\f3Option\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-XadditionalHeaders\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xauthfile <file>\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xdebug\fP -.if \n(80<\n(38 .nr 80 \n(38 -.nr 38 \w\f3\-Xnocompile\fP -.if \n(80<\n(38 .nr 80 \n(38 -.80 -.rm 80 -.nr 38 \n(d- -.if \n(80<\n(38 .nr 80 \n(38 -.nr 81 0 -.nr 38 \w\f3Description\fP -.if \n(81<\n(38 .nr 81 \n(38 -.81 -.rm 81 -.nr 38 \n(a- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(b- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(c- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(e- -.if \n(81<\n(38 .nr 81 \n(38 -.nr 38 \n(f- -.if \n(81<\n(38 .nr 81 \n(38 -.35 -.nf -.ll \n(34u -.nr 38 1n -.nr 79 0 -.nr 40 \n(79+(0*\n(38) -.nr 80 +\n(40 -.nr 41 \n(80+(3*\n(38) -.nr 81 +\n(41 -.nr TW \n(81 -.if t .if \n(TW>\n(.li .tm Table at line 193 file Input is too wide - \n(TW units -.fc   -.nr #T 0-1 -.nr #a 0-1 -.eo -.de T# -.ds #d .d -.if \(ts\n(.z\(ts\(ts .ds #d nl -.mk ## -.nr ## -1v -.ls 1 -.ls -.. -.ec -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP -.ne \n(a|u+\n(.Vu -.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-XadditionalHeaders\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.a+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(b|u+\n(.Vu -.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xauthfile <file>\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.b+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(c|u+\n(.Vu -.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xdebug\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.c+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(d|u+\n(.Vu -.ne \n(e|u+\n(.Vu -.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) -.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(40u -.in +\n(37u -.d+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.e+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.ne \n(f|u+\n(.Vu -.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) -.ta \n(80u \n(81u -.nr 31 \n(.f -.nr 35 1m -\&\h'|\n(40u'\f3\-Xnocompile\fP\h'|\n(41u' -.mk ## -.nr 31 \n(## -.sp |\n(##u-1v -.nr 37 \n(41u -.in +\n(37u -.f+ -.in -\n(37u -.mk 32 -.if \n(32>\n(31 .nr 31 \n(32 -.sp |\n(31u -.fc -.nr T. 1 -.T# 1 -.35 -.rm a+ -.rm b+ -.rm c+ -.rm d+ -.rm e+ -.rm f+ -.TE -.if \n-(b.=0 .nr c. \n(.c-\n(d.-26 +The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: -.LP -.SH "Example" -.nf -\f3 -.fl -\fP\f3wsimport \-p stockquote http://stockquote.example.com/quote?wsdl\fP -.fl -.fi -.LP -This will generate the Java artifacts and compile them by importing the \f2http://stockquote.example.com/quote?wsdl\fP. +http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. +.TP +-Xdebug .br - +Prints debugging information\&. +.TP +-Xno-addressing-databinding +.br +Enables binding of W3C EndpointReferenceType to Java\&. +.TP +-Xnocompile +.br +Does not compile the generated Java files\&. +.SH EXAMPLE +The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR +.sp +.nf +\f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP +.fi +.nf +\f3\fP +.fi +.sp +.SH SEE\ ALSO +.TP 0.2i +\(bu +wsgen(1) +.TP 0.2i +\(bu +The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html +.TP 0.2i +\(bu +The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/doc/sun/man/man1/xjc.1 b/jdk/src/solaris/doc/sun/man/man1/xjc.1 index 0425ba6480c..3956ce8e8a6 100644 --- a/jdk/src/solaris/doc/sun/man/man1/xjc.1 +++ b/jdk/src/solaris/doc/sun/man/man1/xjc.1 @@ -1,297 +1,233 @@ -." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. -." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. -." -." This code is free software; you can redistribute it and/or modify it -." under the terms of the GNU General Public License version 2 only, as -." published by the Free Software Foundation. -." -." This code is distributed in the hope that it will be useful, but WITHOUT -." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -." version 2 for more details (a copy is included in the LICENSE file that -." accompanied this code). -." -." You should have received a copy of the GNU General Public License version -." 2 along with this work; if not, write to the Free Software Foundation, -." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. -." -." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA -." or visit www.oracle.com if you need additional information or have any -." questions. -." -.TH xjc 1 "10 May 2011" +'\" t +.\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. +.\" +.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +.\" +.\" This code is free software; you can redistribute it and/or modify it +.\" under the terms of the GNU General Public License version 2 only, as +.\" published by the Free Software Foundation. +.\" +.\" This code is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" version 2 for more details (a copy is included in the LICENSE file that +.\" accompanied this code). +.\" +.\" You should have received a copy of the GNU General Public License version +.\" 2 along with this work; if not, write to the Free Software Foundation, +.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. +.\" +.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA +.\" or visit www.oracle.com if you need additional information or have any +.\" questions. +.\" +.\" Arch: generic +.\" Software: JDK 8 +.\" Date: 21 November 2013 +.\" SectDesc: Java Web Services Tools +.\" Title: xjc.1 +.\" +.if n .pl 99999 +.TH xjc 1 "21 November 2013" "JDK 8" "Java Web Services Tools" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- -.LP -.SH "Name" -xjc \- Java(TM) Architecture for XML Binding +.SH NAME +xjc \- Compiles an XML schema file into fully annotated Java classes\&. +.SH SYNOPSIS +.sp +.nf + +\fBxjc\fR [ \fIoptions\fR ] \fBschema\fR \fIfile/URL/dir/jar\fR \&.\&.\&. [\fB\-b\fR \fIbindinfo\fR ] \&.\&.\&. +.fi +.sp +.TP +\fIoptions\fR +The command-line options\&. See Options\&. +.TP +schema \fIfile/URL/dir/jar \&.\&.\&.\fR +The location of the XML schema file\&. If \f3dir\fR is specified, then all schema files in it are compiled\&. If \f3jar\fR is specified, then the \f3/META-INF/sun-jaxb\&.episode\fR binding file is compiled\&. +.TP +-b \fIbindinfo\fR .br -Binding Compiler -.LP -.LP -\f3Specification Version:\fP 2.1 +The location of the bindings files\&. +.SH DESCRIPTION +Start the binding compiler with the appropriate \f3xjc\fR shell script in the bin directory for your platform\&. There is also an Ant task to run the binding complier\&. See Using the XJC with Ant at http://jaxb\&.java\&.net/nonav/2\&.1\&.3/docs/xjcTask\&.html +.SH OPTIONS +.TP 0.2i +\(bu +See also Nonstandard Options +.TP 0.2i +\(bu +See also Deprecated and Removed Options +.TP +-nv .br -\f3Reference Implementation (RI) Version:\fP 2.1.3 -.LP -.SH "Launching xjc" -.LP -.LP -The binding compiler can be launched using the appropriate \f2xjc\fP shell script in the \f2bin\fP directory for your platform. We also provide an Ant task to run the binding complier \- see the instructions for -.na -\f2using the XJC Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html. -.LP -.LP -\f2% xjc \-help\fP -.LP -.SS -Output -.LP -.nf -\f3 -.fl -Usage: xjc [\-options ...] <schema file/URL/dir/jar> ... [\-b <bindinfo>] ... -.fl -If dir is specified, all schema files in it will be compiled. -.fl -If jar is specified, /META\-INF/sun\-jaxb.episode binding file will be compiled. -.fl -Options: -.fl - \-nv : do not perform strict validation of the input schema(s) -.fl - \-extension : allow vendor extensions \- do not strictly follow the Compatibility Rules and App E.2 from the JAXB Spec -.fl - \-b <file/dir> : specify external bindings files (each <file> must have its own \-b); if a directory is given, **/*.xjb is searched -.fl - \-d <dir> : generated files will go into this directory -.fl - \-p <pkg> : specifies the target package -.fl - \-httpproxy <proxy> : set HTTP/HTTPS proxy; format is [user[:password]@]proxyHost:proxyPort -.fl - \-httpproxyfile <f> : works like \-httpproxy but takes the argument in a file to protect password -.fl - \-classpath <arg> : specify where to find user class files -.fl - \-catalog <file> : specify catalog files to resolve external entity references; support TR9401, XCatalog, and OASIS XML Catalog format -.fl - \-readOnly : generated files will be in read\-only mode -.fl - \-npa : suppress generation of package level annotations (**/package\-info.java) -.fl - \-no\-header : suppress generation of a file header with timestamp -.fl - \-target 2.0 : behave like XJC 2.0 and generate code that doesnt use any 2.1 features -.fl - \-xmlschema : treat input as W3C XML Schema (default) -.fl - \-relaxng : treat input as RELAX NG (experimental,unsupported) -.fl - \-relaxng\-compact : treat input as RELAX NG compact syntax (experimental,unsupported) -.fl - \-dtd : treat input as XML DTD (experimental,unsupported) -.fl - \-wsdl : treat input as WSDL and compile schemas inside it (experimental,unsupported) -.fl - \-verbose : be extra verbose -.fl - \-quiet : suppress compiler output -.fl - \-help : display this help message -.fl - \-version : display version information -.fl - -.fl - -.fl -Extensions: -.fl - \-Xlocator : enable source location support for generated code -.fl - \-Xsync\-methods : generate accessor methods with the 'synchronized' keyword -.fl - \-mark\-generated : mark the generated code as @javax.annotation.Generated -.fl - \-episode <FILE> : generate the episode file for separate compilation -.fl -\fP -.fi - -.LP -.SH "OPTIONS" -.LP -.RS 3 -.TP 3 -\-nv -By default, the XJC binding compiler performs strict validation of the source schema before processing it. Use this option to disable strict schema validation. This does not mean that the binding compiler will not perform any validation, it simply means that it will perform less\-strict validation. -.TP 3 -\-extension -By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification. Appendix E.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1.0. In some cases, you may be allowed to use them in the "\-extension" mode enabled by this switch. In the default (strict) mode, you are also limited to using only the binding customizations defined in the specification. By using the "\-extension" switch, you will be allowed to use the JAXB Vendor Extensions -.TP 3 -\-b <file> -Specify one or more external binding files to process. (Each binding file must have its own \f2"\-b"\fP switch.) The syntax of the external binding files is extremely flexible. You may have a single binding file that contains customizations for multiple schemas or you can break the customizations into multiple bindings files: \f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings123.xjb\fP +By default, the XJC binding compiler performs strict validation of the source schema before processing it\&. Use this option to disable strict schema validation\&. This does not mean that the binding compiler will not perform any validation, but means that it will perform a less-strict validation\&. +.TP +-extension .br -\f2xjc schema1.xsd schema2.xsd schema3.xsd \-b bindings1.xjb \-b bindings2.xjb \-b bindings3.xjb\fP In addition, the ordering of the schema files and binding files on the command line does not matter. -.TP 3 -\-d <dir> -By default, the XJC binding compiler will generate the Java content classes in the current directory. Use this option to specify an alternate output directory. The output directory must already exist, the XJC binding compiler will not create it for you. -.TP 3 -\-p <pkg> -Specifying a target package via this command\-line option overrides any binding customization for package name and the default package name algorithm defined in the specification. -.TP 3 -\-httpproxy <proxy> -Specify the HTTP/HTTPS proxy. The format is [user[:password]@]proxyHost[:proxyPort]. The old \f2\-host\fP and \f2\-port\fP are still supported by the RI for backwards compatibility, but they have been deprecated. Note that the password specified with this option is an argument that is visible to other users who use the \f2top\fP command, for example. For greater security, use \f2\-httpproxyfile\fP, below. -.TP 3 -\-httpproxyfile <file> -Specify the HTTP/HTTPS proxy using a file. Same format as above, but the password specified in the file is not visible to other users. -.TP 3 -\-classpath <arg> -Specify where to find client application class files used by the \f2<jxb:javaType>\fP and \f2<xjc:superClass>\fP customizations. -.TP 3 -\-catalog <file> -Specify catalog files to resolve external entity references. Supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the XML Entity and URI Resolvers document or the \f2catalog\-resolver\fP sample application. -.TP 3 -\-readOnly -By default, the XJC binding compiler does not write\-protect the Java source files it generates. Use this option to force the XJC binding compiler to mark the generated Java sources read\-only. -.TP 3 -\-npa -Supress the generation of package level annotations into **/package\-info.java. Using this switch causes the generated code to internalize those annotations into the other generated classes. -.TP 3 -\-no\-header -Supress the generation of a file header comment that includes some note and timestamp. Using this makes the generated code more diff\-friendly. -.TP 3 -\-target 2.0 -Avoid generating code that relies on any JAXB 2.1 features. This will allow the generated code to run with JAXB 2.0 runtime (such as JavaSE 6.) -.TP 3 -\-xmlschema -Treat input schemas as W3C XML Schema (default). If you do not specify this switch, your input schemas will be treated as W3C XML Schema. -.TP 3 -\-relaxng -Treat input schemas as RELAX NG (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-relaxng\-compact -Treat input schemas as RELAX NG compact syntax(experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-dtd -Treat input schemas as XML DTD (experimental, unsupported). Support for RELAX NG schemas is provided as a JAXB Vendor Extension. -.TP 3 -\-wsdl -Treat input as WSDL and compile schemas inside it (experimental,unsupported). -.TP 3 -\-quiet -Suppress compiler output, such as progress information and warnings. -.TP 3 -\-verbose -Be extra verbose, such as printing informational messages or displaying stack traces upon some errors. -.TP 3 -\-help -Display a brief summary of the compiler switches. -.TP 3 -\-version -Display the compiler version information. -.TP 3 -<schema file/URL/dir> -Specify one or more schema files to compile. If you specify a directory, then xjc will scan it for all schema files and compile them. -.RE - -.LP -.SS -Non\-Standard Command Line Options -.LP -.RS 3 -.TP 3 -\-Xlocator -Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling. -.TP 3 -\-Xsync\-methods -Causes all of the generated method signatures to include the \f2synchronized\fP keyword. -.TP 3 -\-mark\-generated -Mark the generated code with the annotation \f2@javax.annotation.Generated\fP. -.TP 3 -\-episode <file> -Generate the specified episode file for separate compilation. -.RE - -.LP -.SS -Deprecated and Removed Command Line Options -.LP -.RS 3 -.TP 3 -\-host & \-port -These options have been deprecated and replaced with the \f3\-httpproxy\fP option. For backwards compatibility, we will continue to support these options, but they will no longer be documented and may be removed from future releases. -.TP 3 -\-use\-runtime -Since the JAXB 2.0 specification has defined a portable runtime, it is no longer necessary for the JAXB RI to generate **/impl/runtime packages. Therefore, this switch is obsolete and has been removed. -.TP 3 -\-source -The \-source compatibility switch was introduced in the first JAXB 2.0 Early Access release. We have decided to remove this switch from future releases of JAXB 2.0. If you need to generate 1.0.x code, please use an installation of the 1.0.x codebase. -.RE - -.LP -.SS -Compiler Restrictions -.LP -.LP -In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches. -.LP -.LP -Please keep the following list of restrictions in mind when running xjc. Most of these issues only apply when compiling multiple schemas with multiple invocations of xjc. -.LP -.RS 3 -.TP 2 -o -To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: -.RS 3 -.TP 3 -1. -The "\f2\-p\fP" command line option takes the highest precedence. -.TP 3 -2. -<\f2jaxb:package\fP> customization -.TP 3 -3. -If \f2targetNamespace\fP is declared, apply \f2targetNamespace\fP \-> Java package name algorithm defined in the specification. -.TP 3 -4. -If no \f2targetNamespace\fP is declared, use a hardcoded package named "generated". -.RE -.TP 2 -o -It is not legal to have more than one <\f2jaxb:schemaBindings\fP> per namespace, so it is impossible to have two schemas in the same target namespace compiled into different Java packages. -.TP 2 -o -All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time \- they cannot be compiled independently and work as expected. -.TP 2 -o -Element substitution groups spread across multiple schema files must be compiled at the same time. -.RE - -.LP -.SH "See Also" -.LP -.RS 3 -.TP 2 -o -Running the binding compiler (XJC): [ -.na -\f2command\-line instructions\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjc.html, -.na -\f2using the XJC Ant task\fP @ -.fi -https://jaxb.dev.java.net/nonav/2.1.3/docs/xjcTask.html] -.TP 2 -o -.na -\f2Java Architecture for XML Binding (JAXB)\fP @ -.fi -http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html -.RE - -.LP - +By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification\&. Appendix E\&.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1\&.0\&. In some cases, you may be allowed to use them in the \f3-extension\fR mode enabled by this switch\&. In the default (strict) mode, you are also limited to using only the binding customization defined in the specification\&. By using the \f3-extension\fR switch, you will be allowed to use the JAXB Vendor Extensions\&. +.TP +-b \fIfile\fR +.br +Specifies one or more external binding files to process\&. Each binding file must have its own \f3-b\fR switch\&. The syntax of the external binding files is flexible\&. You can have a single binding file that contains customization for multiple schemas or you can break the customization into multiple bindings files: \f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings123\&.xjb\fR\f3xjc schema1\&.xsd schema2\&.xsd schema3\&.xsd -b bindings1\&.xjb -b bindings2\&.xjb -b bindings3\&.xjb\fR\&. In addition, the ordering of the schema files and binding files on the command line does not matter\&. +.TP +-d \fIdir\fR +.br +By default, the XJC binding compiler generates the Java content classes in the current directory\&. Use this option to specify an alternate output directory\&. The output directory must already exist\&. The XJC binding compiler does not create it for you\&. +.TP +-p \fIpkg\fR +.br +When you specify a target package with this command-line option, it overrides any binding customization for the package name and the default package name algorithm defined in the specification\&. +.TP +-httpproxy \fIproxy\fR +.br +Specifies the HTTP or HTTPS proxy in the format \fI[user[:password]@]proxyHost[:proxyPort]\fR\&. The old \f3-host\fR and \f3-port\fR options are still supported by the RI for backward compatibility, but they were deprecated\&. The password specified with this option is an argument that is visible to other users who use the top command\&. For greater security, use the \f3-httpproxyfile\fR option\&. +.TP +-httpproxyfile file +.br +Specifies the HTTP or HTTPS proxy with a file\&. The same format as the \f3-httpproxy\fR option, but the password specified in the file is not visible to other users\&. +.TP +-classpath arg +.br +Specifies where to find client application class files used by the \fIjxb:javaType\fR and xjc:\fIsuperClass\fR customization\&. +.TP +-catalog file +.br +Specifies catalog files to resolve external entity references\&. Supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See XML Entity and URI Resolvers at http://xerces\&.apache\&.org/xml-commons/components/resolver/resolver-article\&.html +.TP +-readOnly +.br +By default, the XJC binding compiler does not write-protect the Java source files it generates\&. Use this option to force the XJC binding compiler to mark the generated Java sources as read-only\&. +.TP +-npa +.br +Suppresses the generation of package level annotations into \f3**/package-info\&.java\fR\&. Using this switch causes the generated code to internalize those annotations into the other generated classes\&. +.TP +-no-header +.br +Suppresses the generation of a file header comment that includes some note and time stamp\&. Using this makes the generated code more compatible with the \f3diff\fR command\&. +.TP +-target 2\&.0 +.br +Avoids generating code that relies on any JAXB 2\&.1 features\&. This will allow the generated code to run with JAXB 2\&.0 runtime environment (such as Java SE 6)\&. +.TP +-xmlschema +.br +Treats input schemas as W3C XML Schema (default)\&. If you do not specify this switch, then your input schemas are treated as though they are W3C XML Schemas\&. +.TP +-relaxing +.br +Treats input schemas as RELAX NG (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-relaxing-compact +.br +Treat input schemas as RELAX NG compact syntax (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-dtd +.br +Treats input schemas as XML DTD (experimental and unsupported)\&. Support for RELAX NG schemas is provided as a JAXB Vendor Extension\&. +.TP +-wsdl +.br +Treats input as WSDL and compiles schemas inside it (experimental and unsupported)\&. +.TP +-quiet +.br +Suppress compiler output, such as progress information and warnings\&. +.TP +-verbose +.br +Be extra verbose, such as printing informational messages or displaying stack traces upon some errors\&. +.TP +-help +.br +Displays a brief summary of the compiler switches\&. +.TP +-version +.br +Displays the compiler version information\&. +.TP +\fIschema file/URL/dir\fR +Specifies one or more schema files to compile\&. If you specify a directory, then the \f3xjc\fR command scans it for all schema files and compiles them\&. +.SS NONSTANDARD\ OPTIONS +.TP +-XLocator +.br +Causes the generated code to expose SAX Locator information about the source XML in the Java bean instances after unmarshalling\&. +.TP +-Xsync-methods +.br +Causes all of the generated method signatures to include the \f3synchronized\fR keyword\&. +.TP +-mark-generated +.br +Marks the generated code with the annotation \f3@javax\&.annotation\&.Generated\fR\&. +.TP +-episode file +.br +Generates the specified episode file for separate compilation\&. +.SS DEPRECATED\ AND\ REMOVED\ OPTIONS +.TP +-host & -port +.br +These options are replaced with the \f3-httpproxy\fR option\&. For backward compatibility, these options are supported, but will not be documented and might be removed from future releases\&. +.TP +-use-runtime +.br +Because the JAXB 2\&.0 specification has defined a portable runtime environment, it is no longer necessary for the JAXB RI to generate \f3**/impl/runtime\fRpackages\&. Therefore, this switch is obsolete and was removed\&. +.TP +-source +.br +The \f3-source\fR compatibility switch was introduced in the first JAXB 2\&.0 Early Access release\&. This switch is removed from future releases of JAXB 2\&.0\&. If you need to generate 1\&.0\&.x code, then use an installation of the 1\&.0\&.x code base\&. +.SH COMPILER\ RESTRICTIONS +In general, it is safest to compile all related schemas as a single unit with the same binding compiler switches\&. Keep the following list of restrictions in mind when running the \f3xjc\fR command\&. Most of these issues only apply when you compile multiple schemas with multiple invocations of the \f3xjc\fR command\&. +.PP +To compile multiple schemas at the same time, keep the following precedence rules for the target Java package name in mind: +.TP 0.4i +1\&. +The \f3-p\fR option has the highest precedence\&. +.TP 0.4i +2\&. +\fIjaxb:package\fR customization\&. +.TP 0.4i +3\&. +If \f3targetNamespace\fR is declared, then apply the \f3t\fR\f3argetNamespace\fR to the Java package name algorithm defined in the specification\&. +.TP 0.4i +4\&. +If no \f3targetNamespace\fR is declared, then use a hard coded package named \f3generated\fR\&. +.PP +You cannot have more than one \fIjaxb:schemaBindings\fR per name space, so it is impossible to have two schemas in the same target name space compiled into different Java packages\&. +.PP +All schemas being compiled into the same Java package must be submitted to the XJC binding compiler at the same time\&. They cannot be compiled independently and work as expected\&. +.PP +Element substitution groups that are spread across multiple schema files must be compiled at the same time\&. +.SH SEE\ ALSO +.TP 0.2i +\(bu +Binding Compiler (xjc) at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/xjc\&.html +.TP 0.2i +\(bu +Java Architecture for XML Binding (JAXB) at http://www\&.oracle\&.com/technetwork/articles/javase/index-140168\&.html +.RE +.br +'pl 8.5i +'bp diff --git a/jdk/src/solaris/native/java/net/Inet4AddressImpl.c b/jdk/src/solaris/native/java/net/Inet4AddressImpl.c index 6ef0aca4946..ea67245f0fe 100644 --- a/jdk/src/solaris/native/java/net/Inet4AddressImpl.c +++ b/jdk/src/solaris/native/java/net/Inet4AddressImpl.c @@ -55,17 +55,23 @@ static jclass ni_iacls; static jclass ni_ia4cls; static jmethodID ni_ia4ctrID; -static void initializeInetClasses(JNIEnv *env) +static jboolean initializeInetClasses(JNIEnv *env) { static int initialized = 0; if (!initialized) { ni_iacls = (*env)->FindClass(env, "java/net/InetAddress"); + CHECK_NULL_RETURN(ni_iacls, JNI_FALSE); ni_iacls = (*env)->NewGlobalRef(env, ni_iacls); + CHECK_NULL_RETURN(ni_iacls, JNI_FALSE); ni_ia4cls = (*env)->FindClass(env, "java/net/Inet4Address"); + CHECK_NULL_RETURN(ni_ia4cls, JNI_FALSE); ni_ia4cls = (*env)->NewGlobalRef(env, ni_ia4cls); + CHECK_NULL_RETURN(ni_ia4cls, JNI_FALSE); ni_ia4ctrID = (*env)->GetMethodID(env, ni_ia4cls, "<init>", "()V"); + CHECK_NULL_RETURN(ni_ia4ctrID, JNI_FALSE); initialized = 1; } + return JNI_TRUE; } @@ -141,7 +147,8 @@ Java_java_net_Inet4AddressImpl_lookupAllHostAddr(JNIEnv *env, jobject this, int error=0; struct addrinfo hints, *res, *resNew = NULL; - initializeInetClasses(env); + if (!initializeInetClasses(env)) + return NULL; if (IS_NULL(host)) { JNU_ThrowNullPointerException(env, "host is null"); @@ -400,7 +407,8 @@ Java_java_net_Inet4AddressImpl_lookupAllHostAddr(JNIEnv *env, jobject this, int error = 0; struct addrinfo hints, *res, *resNew = NULL; - initializeInetClasses(env); + if (!initializeInetClasses(env)) + return NULL; if (IS_NULL(host)) { JNU_ThrowNullPointerException(env, "host is null"); diff --git a/jdk/src/solaris/native/java/net/Inet6AddressImpl.c b/jdk/src/solaris/native/java/net/Inet6AddressImpl.c index d83db702286..7ac26c0cbb6 100644 --- a/jdk/src/solaris/native/java/net/Inet6AddressImpl.c +++ b/jdk/src/solaris/native/java/net/Inet6AddressImpl.c @@ -124,25 +124,35 @@ static jmethodID ni_ia4ctrID; static jmethodID ni_ia6ctrID; static jboolean preferIPv6Address; -static void initializeInetClasses(JNIEnv *env) +static jboolean initializeInetClasses(JNIEnv *env) { jfieldID ni_preferIPv6AddressID; static int initialized = 0; if (!initialized) { ni_iacls = (*env)->FindClass(env, "java/net/InetAddress"); + CHECK_NULL_RETURN(ni_iacls, JNI_FALSE); ni_iacls = (*env)->NewGlobalRef(env, ni_iacls); + CHECK_NULL_RETURN(ni_iacls, JNI_FALSE); ni_ia4cls = (*env)->FindClass(env, "java/net/Inet4Address"); + CHECK_NULL_RETURN(ni_ia4cls, JNI_FALSE); ni_ia4cls = (*env)->NewGlobalRef(env, ni_ia4cls); + CHECK_NULL_RETURN(ni_ia4cls, JNI_FALSE); ni_ia6cls = (*env)->FindClass(env, "java/net/Inet6Address"); + CHECK_NULL_RETURN(ni_ia6cls, JNI_FALSE); ni_ia6cls = (*env)->NewGlobalRef(env, ni_ia6cls); + CHECK_NULL_RETURN(ni_ia6cls, JNI_FALSE); ni_ia4ctrID = (*env)->GetMethodID(env, ni_ia4cls, "<init>", "()V"); + CHECK_NULL_RETURN(ni_ia4ctrID, JNI_FALSE); ni_ia6ctrID = (*env)->GetMethodID(env, ni_ia6cls, "<init>", "()V"); + CHECK_NULL_RETURN(ni_ia6ctrID, JNI_FALSE); ni_preferIPv6AddressID = (*env)->GetStaticFieldID(env, ni_iacls, "preferIPv6Address", "Z"); + CHECK_NULL_RETURN(ni_preferIPv6AddressID, JNI_FALSE); preferIPv6Address = (*env)->GetStaticBooleanField(env, ia_class, ia_preferIPv6AddressID); initialized = 1; } + return JNI_TRUE; } #ifdef MACOSX @@ -160,7 +170,8 @@ lookupIfLocalhost(JNIEnv *env, const char *hostname, jboolean includeV6) jobject name; // Make sure static variables we need are set. - initializeInetClasses(env); + if (!initializeInetClasses(env)) + return NULL; /* If the requested name matches this host's hostname, return IP addresses * from all attached interfaces. (#2844683 et al) This prevents undesired @@ -286,7 +297,8 @@ Java_java_net_Inet6AddressImpl_lookupAllHostAddr(JNIEnv *env, jobject this, struct addrinfo hints, *res, *resNew = NULL; #endif /* AF_INET6 */ - initializeInetClasses(env); + if (!initializeInetClasses(env)) + return NULL; if (IS_NULL(host)) { JNU_ThrowNullPointerException(env, "host is null"); diff --git a/jdk/src/solaris/native/com/sun/management/LinuxOperatingSystem.c b/jdk/src/solaris/native/sun/management/LinuxOperatingSystem.c similarity index 98% rename from jdk/src/solaris/native/com/sun/management/LinuxOperatingSystem.c rename to jdk/src/solaris/native/sun/management/LinuxOperatingSystem.c index 19d84fe0f84..c8bd739ebef 100644 --- a/jdk/src/solaris/native/com/sun/management/LinuxOperatingSystem.c +++ b/jdk/src/solaris/native/sun/management/LinuxOperatingSystem.c @@ -35,7 +35,7 @@ #include <stdlib.h> #include <dlfcn.h> #include <pthread.h> -#include "com_sun_management_UnixOperatingSystem.h" +#include "sun_management_OperatingSystemImpl.h" struct ticks { uint64_t used; @@ -310,7 +310,7 @@ double get_process_load() { } JNIEXPORT jdouble JNICALL -Java_com_sun_management_UnixOperatingSystem_getSystemCpuLoad +Java_sun_management_OperatingSystemImpl_getSystemCpuLoad (JNIEnv *env, jobject dummy) { if(perfInit() == 0) { @@ -321,7 +321,7 @@ Java_com_sun_management_UnixOperatingSystem_getSystemCpuLoad } JNIEXPORT jdouble JNICALL -Java_com_sun_management_UnixOperatingSystem_getProcessCpuLoad +Java_sun_management_OperatingSystemImpl_getProcessCpuLoad (JNIEnv *env, jobject dummy) { if(perfInit() == 0) { diff --git a/jdk/src/solaris/native/com/sun/management/MacosxOperatingSystem.c b/jdk/src/solaris/native/sun/management/MacosxOperatingSystem.c similarity index 96% rename from jdk/src/solaris/native/com/sun/management/MacosxOperatingSystem.c rename to jdk/src/solaris/native/sun/management/MacosxOperatingSystem.c index 7f8c1e97f13..8fb39786fe1 100644 --- a/jdk/src/solaris/native/com/sun/management/MacosxOperatingSystem.c +++ b/jdk/src/solaris/native/sun/management/MacosxOperatingSystem.c @@ -23,7 +23,7 @@ * questions. */ -#include "com_sun_management_UnixOperatingSystem.h" +#include "sun_management_OperatingSystemImpl.h" #include <sys/time.h> #include <mach/mach.h> @@ -31,7 +31,7 @@ JNIEXPORT jdouble JNICALL -Java_com_sun_management_UnixOperatingSystem_getSystemCpuLoad +Java_sun_management_OperatingSystemImpl_getSystemCpuLoad (JNIEnv *env, jobject dummy) { // This code is influenced by the darwin top source @@ -83,7 +83,7 @@ Java_com_sun_management_UnixOperatingSystem_getSystemCpuLoad JNIEXPORT jdouble JNICALL -Java_com_sun_management_UnixOperatingSystem_getProcessCpuLoad +Java_sun_management_OperatingSystemImpl_getProcessCpuLoad (JNIEnv *env, jobject dummy) { // This code is influenced by the darwin top source diff --git a/jdk/src/solaris/native/com/sun/management/UnixOperatingSystem_md.c b/jdk/src/solaris/native/sun/management/OperatingSystemImpl.c similarity index 94% rename from jdk/src/solaris/native/com/sun/management/UnixOperatingSystem_md.c rename to jdk/src/solaris/native/sun/management/OperatingSystemImpl.c index e2574e4d496..f1322ebd90b 100644 --- a/jdk/src/solaris/native/com/sun/management/UnixOperatingSystem_md.c +++ b/jdk/src/solaris/native/sun/management/OperatingSystemImpl.c @@ -28,7 +28,7 @@ #include "jlong.h" #include "jvm.h" #include "management.h" -#include "com_sun_management_UnixOperatingSystem.h" +#include "sun_management_OperatingSystemImpl.h" #include <sys/types.h> #include <sys/stat.h> @@ -175,14 +175,14 @@ static jlong get_total_or_available_swap_space_size(JNIEnv* env, jboolean availa } JNIEXPORT void JNICALL -Java_com_sun_management_UnixOperatingSystem_initialize +Java_sun_management_OperatingSystemImpl_initialize (JNIEnv *env, jclass cls) { page_size = sysconf(_SC_PAGESIZE); } JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getCommittedVirtualMemorySize +Java_sun_management_OperatingSystemImpl_getCommittedVirtualMemorySize (JNIEnv *env, jobject mbean) { #ifdef __solaris__ @@ -249,21 +249,21 @@ Java_com_sun_management_UnixOperatingSystem_getCommittedVirtualMemorySize } JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getTotalSwapSpaceSize +Java_sun_management_OperatingSystemImpl_getTotalSwapSpaceSize (JNIEnv *env, jobject mbean) { return get_total_or_available_swap_space_size(env, JNI_FALSE); } JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getFreeSwapSpaceSize +Java_sun_management_OperatingSystemImpl_getFreeSwapSpaceSize (JNIEnv *env, jobject mbean) { return get_total_or_available_swap_space_size(env, JNI_TRUE); } JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getProcessCpuTime +Java_sun_management_OperatingSystemImpl_getProcessCpuTime (JNIEnv *env, jobject mbean) { #ifdef __APPLE__ @@ -305,7 +305,7 @@ Java_com_sun_management_UnixOperatingSystem_getProcessCpuTime } JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getFreePhysicalMemorySize +Java_sun_management_OperatingSystemImpl_getFreePhysicalMemorySize (JNIEnv *env, jobject mbean) { #ifdef __APPLE__ @@ -333,7 +333,7 @@ Java_com_sun_management_UnixOperatingSystem_getFreePhysicalMemorySize } JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getTotalPhysicalMemorySize +Java_sun_management_OperatingSystemImpl_getTotalPhysicalMemorySize (JNIEnv *env, jobject mbean) { #ifdef _ALLBSD_SOURCE @@ -358,7 +358,7 @@ Java_com_sun_management_UnixOperatingSystem_getTotalPhysicalMemorySize JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getOpenFileDescriptorCount +Java_sun_management_OperatingSystemImpl_getOpenFileDescriptorCount (JNIEnv *env, jobject mbean) { #ifdef __APPLE__ @@ -438,7 +438,7 @@ Java_com_sun_management_UnixOperatingSystem_getOpenFileDescriptorCount } JNIEXPORT jlong JNICALL -Java_com_sun_management_UnixOperatingSystem_getMaxFileDescriptorCount +Java_sun_management_OperatingSystemImpl_getMaxFileDescriptorCount (JNIEnv *env, jobject mbean) { struct rlimit rlp; diff --git a/jdk/src/solaris/native/com/sun/management/SolarisOperatingSystem.c b/jdk/src/solaris/native/sun/management/SolarisOperatingSystem.c similarity index 97% rename from jdk/src/solaris/native/com/sun/management/SolarisOperatingSystem.c rename to jdk/src/solaris/native/sun/management/SolarisOperatingSystem.c index c5ebb975ef2..a8136f1ac63 100644 --- a/jdk/src/solaris/native/com/sun/management/SolarisOperatingSystem.c +++ b/jdk/src/solaris/native/sun/management/SolarisOperatingSystem.c @@ -38,7 +38,7 @@ #include <sys/loadavg.h> #include <jni.h> #include "jvm.h" -#include "com_sun_management_UnixOperatingSystem.h" +#include "sun_management_OperatingSystemImpl.h" typedef struct { kstat_t *kstat; @@ -226,14 +226,14 @@ double get_process_load(void) { } JNIEXPORT jdouble JNICALL -Java_com_sun_management_UnixOperatingSystem_getSystemCpuLoad +Java_sun_management_OperatingSystemImpl_getSystemCpuLoad (JNIEnv *env, jobject dummy) { return get_cpu_load(-1); } JNIEXPORT jdouble JNICALL -Java_com_sun_management_UnixOperatingSystem_getProcessCpuLoad +Java_sun_management_OperatingSystemImpl_getProcessCpuLoad (JNIEnv *env, jobject dummy) { return get_process_load(); diff --git a/jdk/src/windows/classes/com/sun/management/OSMBeanFactory.java b/jdk/src/windows/classes/com/sun/management/OSMBeanFactory.java deleted file mode 100644 index d341f13d0f5..00000000000 --- a/jdk/src/windows/classes/com/sun/management/OSMBeanFactory.java +++ /dev/null @@ -1,52 +0,0 @@ -/* - * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved. - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * This code is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. - * - * This code is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - * version 2 for more details (a copy is included in the LICENSE file that - * accompanied this code). - * - * You should have received a copy of the GNU General Public License version - * 2 along with this work; if not, write to the Free Software Foundation, - * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. - * - * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA - * or visit www.oracle.com if you need additional information or have any - * questions. - */ - -package com.sun.management; - -import java.lang.management.OperatingSystemMXBean; -import sun.management.VMManagement; - -/** - * Operating system dependent MBean factory. - * <p> - * <b>WARNING:</b> While this class is public, it should not be treated as - * public API and its API may change in incompatable ways between dot dot - * releases and even patch releases. You should not rely on this class. - */ -public class OSMBeanFactory { - /* static factory class */ - private OSMBeanFactory() {}; - - private static OperatingSystem osMBean = null; - - public static synchronized OperatingSystemMXBean - getOperatingSystemMXBean(VMManagement jvm) { - - if (osMBean == null) { - osMBean = new OperatingSystem(jvm); - } - return (OperatingSystemMXBean) osMBean; - } -} diff --git a/jdk/src/windows/classes/com/sun/management/OperatingSystem.java b/jdk/src/windows/classes/sun/management/OperatingSystemImpl.java similarity index 92% rename from jdk/src/windows/classes/com/sun/management/OperatingSystem.java rename to jdk/src/windows/classes/sun/management/OperatingSystemImpl.java index 0c5bf9bab73..ca766448177 100644 --- a/jdk/src/windows/classes/com/sun/management/OperatingSystem.java +++ b/jdk/src/windows/classes/sun/management/OperatingSystemImpl.java @@ -23,9 +23,9 @@ * questions. */ -package com.sun.management; +package sun.management; -import sun.management.VMManagement; +import com.sun.management.OperatingSystemMXBean; /** * Implementation class for the operating system. @@ -34,15 +34,14 @@ import sun.management.VMManagement; * ManagementFactory.getOperatingSystemMXBean() returns an instance * of this class. */ -class OperatingSystem - extends sun.management.OperatingSystemImpl +class OperatingSystemImpl extends BaseOperatingSystemImpl implements OperatingSystemMXBean { // psapiLock is a lock to make sure only one thread loading // PSAPI DLL. private static Object psapiLock = new Object(); - OperatingSystem(VMManagement vm) { + OperatingSystemImpl(VMManagement vm) { super(vm); } diff --git a/jdk/src/windows/classes/sun/nio/ch/WindowsAsynchronousFileChannelImpl.java b/jdk/src/windows/classes/sun/nio/ch/WindowsAsynchronousFileChannelImpl.java index fd3fa538c13..d747e0f2938 100644 --- a/jdk/src/windows/classes/sun/nio/ch/WindowsAsynchronousFileChannelImpl.java +++ b/jdk/src/windows/classes/sun/nio/ch/WindowsAsynchronousFileChannelImpl.java @@ -228,6 +228,7 @@ public class WindowsAsynchronousFileChannelImpl @Override public void run() { long overlapped = 0L; + boolean pending = false; try { begin(); @@ -241,6 +242,7 @@ public class WindowsAsynchronousFileChannelImpl overlapped); if (n == IOStatus.UNAVAILABLE) { // I/O is pending + pending = true; return; } // acquired lock immediately @@ -250,10 +252,10 @@ public class WindowsAsynchronousFileChannelImpl } catch (Throwable x) { // lock failed or channel closed removeFromFileLockTable(fli); - if (overlapped != 0L) - ioCache.remove(overlapped); result.setFailure(toIOException(x)); } finally { + if (!pending && overlapped != 0L) + ioCache.remove(overlapped); end(); } diff --git a/jdk/src/windows/classes/sun/nio/ch/WindowsSelectorImpl.java b/jdk/src/windows/classes/sun/nio/ch/WindowsSelectorImpl.java index 725e66f8bec..d84712ba97c 100644 --- a/jdk/src/windows/classes/sun/nio/ch/WindowsSelectorImpl.java +++ b/jdk/src/windows/classes/sun/nio/ch/WindowsSelectorImpl.java @@ -266,7 +266,7 @@ final class WindowsSelectorImpl extends SelectorImpl { private void checkForException() throws IOException { if (exception == null) return; - StringBuffer message = new StringBuffer("An exception occured" + + StringBuffer message = new StringBuffer("An exception occurred" + " during the execution of select(): \n"); message.append(exception); message.append('\n'); diff --git a/jdk/src/windows/classes/sun/nio/fs/WindowsFileSystemProvider.java b/jdk/src/windows/classes/sun/nio/fs/WindowsFileSystemProvider.java index 31b7c0f3674..1f2f22e326d 100644 --- a/jdk/src/windows/classes/sun/nio/fs/WindowsFileSystemProvider.java +++ b/jdk/src/windows/classes/sun/nio/fs/WindowsFileSystemProvider.java @@ -614,7 +614,7 @@ public class WindowsFileSystemProvider if (sm != null) { FilePermission perm = new FilePermission(link.getPathForPermissionCheck(), SecurityConstants.FILE_READLINK_ACTION); - AccessController.checkPermission(perm); + sm.checkPermission(perm); } String target = WindowsLinkSupport.readLink(link); diff --git a/jdk/src/windows/classes/sun/security/krb5/internal/tools/Klist.java b/jdk/src/windows/classes/sun/security/krb5/internal/tools/Klist.java index ce0e3e7fb5d..566b0bee12c 100644 --- a/jdk/src/windows/classes/sun/security/krb5/internal/tools/Klist.java +++ b/jdk/src/windows/classes/sun/security/krb5/internal/tools/Klist.java @@ -336,7 +336,7 @@ public class Klist { System.out.println(" name\t name of credentials cache or " + " keytab with the prefix. File-based cache or " + "keytab's prefix is FILE:."); - System.out.println(" -c specifes that credential cache is to be " + + System.out.println(" -c specifies that credential cache is to be " + "listed"); System.out.println(" -k specifies that key tab is to be listed"); System.out.println(" options for credentials caches:"); diff --git a/jdk/src/windows/classes/sun/security/krb5/internal/tools/Ktab.java b/jdk/src/windows/classes/sun/security/krb5/internal/tools/Ktab.java index eeeb848e6e5..bf09016136f 100644 --- a/jdk/src/windows/classes/sun/security/krb5/internal/tools/Ktab.java +++ b/jdk/src/windows/classes/sun/security/krb5/internal/tools/Ktab.java @@ -381,12 +381,12 @@ public class Ktab { } } } catch (KrbException e) { - System.err.println("Error occured while deleting the entry. "+ + System.err.println("Error occurred while deleting the entry. "+ "Deletion failed."); e.printStackTrace(); System.exit(-1); } catch (IOException e) { - System.err.println("Error occured while deleting the entry. "+ + System.err.println("Error occurred while deleting the entry. "+ " Deletion failed."); e.printStackTrace(); System.exit(-1); diff --git a/jdk/src/windows/native/java/net/Inet4AddressImpl.c b/jdk/src/windows/native/java/net/Inet4AddressImpl.c index 97aab6f9c14..f34b5e12431 100644 --- a/jdk/src/windows/native/java/net/Inet4AddressImpl.c +++ b/jdk/src/windows/native/java/net/Inet4AddressImpl.c @@ -142,10 +142,15 @@ Java_java_net_Inet4AddressImpl_lookupAllHostAddr(JNIEnv *env, jobject this, if (!initialized) { ni_iacls = (*env)->FindClass(env, "java/net/InetAddress"); + CHECK_NULL_RETURN(ni_iacls, NULL); ni_iacls = (*env)->NewGlobalRef(env, ni_iacls); + CHECK_NULL_RETURN(ni_iacls, NULL); ni_ia4cls = (*env)->FindClass(env, "java/net/Inet4Address"); + CHECK_NULL_RETURN(ni_ia4cls, NULL); ni_ia4cls = (*env)->NewGlobalRef(env, ni_ia4cls); + CHECK_NULL_RETURN(ni_ia4cls, NULL); ni_ia4ctrID = (*env)->GetMethodID(env, ni_ia4cls, "<init>", "()V"); + CHECK_NULL_RETURN(ni_ia4ctrID, NULL); initialized = 1; } diff --git a/jdk/src/windows/native/java/net/Inet6AddressImpl.c b/jdk/src/windows/native/java/net/Inet6AddressImpl.c index 4531402bb43..f77d5ab79c7 100644 --- a/jdk/src/windows/native/java/net/Inet6AddressImpl.c +++ b/jdk/src/windows/native/java/net/Inet6AddressImpl.c @@ -93,13 +93,21 @@ Java_java_net_Inet6AddressImpl_lookupAllHostAddr(JNIEnv *env, jobject this, if (!initialized) { ni_iacls = (*env)->FindClass(env, "java/net/InetAddress"); + CHECK_NULL_RETURN(ni_iacls, NULL); ni_iacls = (*env)->NewGlobalRef(env, ni_iacls); + CHECK_NULL_RETURN(ni_iacls, NULL); ni_ia4cls = (*env)->FindClass(env, "java/net/Inet4Address"); + CHECK_NULL_RETURN(ni_ia4cls, NULL); ni_ia4cls = (*env)->NewGlobalRef(env, ni_ia4cls); + CHECK_NULL_RETURN(ni_ia4cls, NULL); ni_ia6cls = (*env)->FindClass(env, "java/net/Inet6Address"); + CHECK_NULL_RETURN(ni_ia6cls, NULL); ni_ia6cls = (*env)->NewGlobalRef(env, ni_ia6cls); + CHECK_NULL_RETURN(ni_ia6cls, NULL); ni_ia4ctrID = (*env)->GetMethodID(env, ni_ia4cls, "<init>", "()V"); + CHECK_NULL_RETURN(ni_ia4ctrID, NULL); ni_ia6ctrID = (*env)->GetMethodID(env, ni_ia6cls, "<init>", "()V"); + CHECK_NULL_RETURN(ni_ia6ctrID, NULL); initialized = 1; } if (IS_NULL(host)) { diff --git a/jdk/src/windows/native/com/sun/management/OperatingSystem_md.c b/jdk/src/windows/native/sun/management/OperatingSystemImpl.c similarity index 98% rename from jdk/src/windows/native/com/sun/management/OperatingSystem_md.c rename to jdk/src/windows/native/sun/management/OperatingSystemImpl.c index 62e5615c80a..c684e2bd81c 100644 --- a/jdk/src/windows/native/com/sun/management/OperatingSystem_md.c +++ b/jdk/src/windows/native/sun/management/OperatingSystemImpl.c @@ -28,7 +28,7 @@ #include "jlong.h" #include "jvm.h" #include "management.h" -#include "com_sun_management_OperatingSystem.h" +#include "sun_management_OperatingSystemImpl.h" #include <psapi.h> #include <errno.h> @@ -77,7 +77,7 @@ static HANDLE main_process; int perfiInit(void); JNIEXPORT void JNICALL -Java_com_sun_management_OperatingSystem_initialize +Java_sun_management_OperatingSystemImpl_initialize (JNIEnv *env, jclass cls) { main_process = GetCurrentProcess(); @@ -85,7 +85,7 @@ Java_com_sun_management_OperatingSystem_initialize } JNIEXPORT jlong JNICALL -Java_com_sun_management_OperatingSystem_getCommittedVirtualMemorySize0 +Java_sun_management_OperatingSystemImpl_getCommittedVirtualMemorySize0 (JNIEnv *env, jobject mbean) { PROCESS_MEMORY_COUNTERS pmc; @@ -97,7 +97,7 @@ Java_com_sun_management_OperatingSystem_getCommittedVirtualMemorySize0 } JNIEXPORT jlong JNICALL -Java_com_sun_management_OperatingSystem_getTotalSwapSpaceSize +Java_sun_management_OperatingSystemImpl_getTotalSwapSpaceSize (JNIEnv *env, jobject mbean) { MEMORYSTATUSEX ms; @@ -107,7 +107,7 @@ Java_com_sun_management_OperatingSystem_getTotalSwapSpaceSize } JNIEXPORT jlong JNICALL -Java_com_sun_management_OperatingSystem_getFreeSwapSpaceSize +Java_sun_management_OperatingSystemImpl_getFreeSwapSpaceSize (JNIEnv *env, jobject mbean) { MEMORYSTATUSEX ms; @@ -117,7 +117,7 @@ Java_com_sun_management_OperatingSystem_getFreeSwapSpaceSize } JNIEXPORT jlong JNICALL -Java_com_sun_management_OperatingSystem_getProcessCpuTime +Java_sun_management_OperatingSystemImpl_getProcessCpuTime (JNIEnv *env, jobject mbean) { @@ -136,7 +136,7 @@ Java_com_sun_management_OperatingSystem_getProcessCpuTime } JNIEXPORT jlong JNICALL -Java_com_sun_management_OperatingSystem_getFreePhysicalMemorySize +Java_sun_management_OperatingSystemImpl_getFreePhysicalMemorySize (JNIEnv *env, jobject mbean) { MEMORYSTATUSEX ms; @@ -146,7 +146,7 @@ Java_com_sun_management_OperatingSystem_getFreePhysicalMemorySize } JNIEXPORT jlong JNICALL -Java_com_sun_management_OperatingSystem_getTotalPhysicalMemorySize +Java_sun_management_OperatingSystemImpl_getTotalPhysicalMemorySize (JNIEnv *env, jobject mbean) { MEMORYSTATUSEX ms; @@ -927,14 +927,14 @@ perfInit(void) { } JNIEXPORT jdouble JNICALL -Java_com_sun_management_OperatingSystem_getSystemCpuLoad +Java_sun_management_OperatingSystemImpl_getSystemCpuLoad (JNIEnv *env, jobject dummy) { return perfGetCPULoad(-1); } JNIEXPORT jdouble JNICALL -Java_com_sun_management_OperatingSystem_getProcessCpuLoad +Java_sun_management_OperatingSystemImpl_getProcessCpuLoad (JNIEnv *env, jobject dummy) { return perfGetProcessLoad(); diff --git a/jdk/test/Makefile b/jdk/test/Makefile index c4a9b93bec6..d8e7dd86ab9 100644 --- a/jdk/test/Makefile +++ b/jdk/test/Makefile @@ -27,6 +27,8 @@ # Makefile to run various jdk tests # +.DEFAULT : all + # Empty these to get rid of some default rules .SUFFIXES: .SUFFIXES: .java @@ -55,150 +57,19 @@ UNIQ = uniq WC = wc ZIP = zip -# Get OS name from uname -UNAME_S := $(shell $(UNAME) -s) +# Get OS name from uname (Cygwin inexplicably adds _NT-5.1) +UNAME_S := $(shell $(UNAME) -s | $(CUT) -f1 -d_) # Commands to run on paths to make mixed paths for java on windows -GETMIXEDPATH=$(ECHO) - -# Location of developer shared files -SLASH_JAVA = /java - -# Platform specific settings -ifeq ($(UNAME_S), SunOS) - OS_NAME = solaris - OS_ARCH := $(shell $(UNAME) -p) - OS_VERSION := $(shell $(UNAME) -r) -endif -ifeq ($(UNAME_S), Linux) - OS_NAME = linux - OS_ARCH := $(shell $(UNAME) -m) - # Check for unknown arch, try uname -p if uname -m says unknown - ifeq ($(OS_ARCH),unknown) - OS_ARCH := $(shell $(UNAME) -p) - endif - OS_VERSION := $(shell $(UNAME) -r) -endif -ifeq ($(UNAME_S), Darwin) - OS_NAME = macosx - OS_ARCH := $(shell $(UNAME) -m) - # Check for unknown arch, try uname -p if uname -m says unknown - ifeq ($(OS_ARCH),unknown) - OS_ARCH := $(shell $(UNAME) -p) - endif - OS_VERSION := $(shell $(UNAME) -r) -endif -ifeq ($(OS_NAME),) - OS_NAME = windows - # GNU Make or MKS overrides $(PROCESSOR_ARCHITECTURE) to always - # return "x86". Use the first word of $(PROCESSOR_IDENTIFIER) instead. - ifeq ($(PROCESSOR_IDENTIFIER),) - PROC_ARCH:=$(shell $(UNAME) -m) - else - PROC_ARCH:=$(word 1, $(PROCESSOR_IDENTIFIER)) - endif - OS_ARCH:=$(PROC_ARCH) +ifeq ($(UNAME_S), CYGWIN) + # Location of developer shared files SLASH_JAVA = J: - EXESUFFIX = .exe - # These need to be different depending on MKS or CYGWIN - ifeq ($(findstring cygdrive,$(shell ($(CD) C:/ && $(PWD)))), ) - GETMIXEDPATH = dosname -s - OS_VERSION := $(shell $(UNAME) -r) - else - GETMIXEDPATH = cygpath -m -s - OS_VERSION := $(shell $(UNAME) -s | $(CUT) -d'-' -f2) - endif -endif - -# Only want major and minor numbers from os version -OS_VERSION := $(shell $(ECHO) "$(OS_VERSION)" | $(CUT) -d'.' -f1,2) - -# Name to use for x86_64 arch (historically amd64, but should change someday) -OS_ARCH_X64_NAME:=amd64 -#OS_ARCH_X64_NAME:=x64 - -# Alternate arch names (in case this arch is known by a second name) -# PROBLEM_LISTS may use either name. -OS_ARCH2-amd64:=x64 -#OS_ARCH2-x64:=amd64 - -# Try and use the arch names consistently -OS_ARCH:=$(patsubst x64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst X64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst AMD64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst amd64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst x86_64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst 8664,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst EM64T,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst em64t,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst intel64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst Intel64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst INTEL64,$(OS_ARCH_X64_NAME),$(OS_ARCH)) -OS_ARCH:=$(patsubst IA64,ia64,$(OS_ARCH)) -OS_ARCH:=$(patsubst X86,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst x86,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst i386,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst i486,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst i686,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst 386,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst 486,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst 586,i586,$(OS_ARCH)) -OS_ARCH:=$(patsubst 686,i586,$(OS_ARCH)) - -# Default ARCH_DATA_MODEL settings -ARCH_DATA_MODEL-i586 = 32 -ARCH_DATA_MODEL-$(OS_ARCH_X64_NAME) = 64 -ARCH_DATA_MODEL-ia64 = 64 -ARCH_DATA_MODEL-sparc = 32 -ARCH_DATA_MODEL-sparcv9 = 64 - -# If ARCH_DATA_MODEL is not defined, try and pick a reasonable default -ifndef ARCH_DATA_MODEL - ARCH_DATA_MODEL:=$(ARCH_DATA_MODEL-$(OS_ARCH)) -endif -ifndef ARCH_DATA_MODEL - ARCH_DATA_MODEL=32 -endif - -# Platform directory name -PLATFORM_OS = $(OS_NAME)-$(OS_ARCH) - -# Check ARCH_DATA_MODEL, adjust OS_ARCH accordingly on solaris -ARCH_DATA_MODEL_ERROR= \ - ARCH_DATA_MODEL=$(ARCH_DATA_MODEL) cannot be used with $(PLATFORM_OS) -ifeq ($(ARCH_DATA_MODEL),64) - ifeq ($(PLATFORM_OS),solaris-i586) - OS_ARCH=$(OS_ARCH_X64_NAME) - endif - ifeq ($(PLATFORM_OS),solaris-sparc) - OS_ARCH=sparcv9 - endif - ifeq ($(OS_ARCH),i586) - x:=$(warning "WARNING: $(ARCH_DATA_MODEL_ERROR)") - endif - ifeq ($(OS_ARCH),sparc) - x:=$(warning "WARNING: $(ARCH_DATA_MODEL_ERROR)") - endif + GETMIXEDPATH = cygpath -m else - ifeq ($(ARCH_DATA_MODEL),32) - ifeq ($(OS_ARCH),$(OS_ARCH_X64_NAME)) - x:=$(warning "WARNING: $(ARCH_DATA_MODEL_ERROR)") - endif - ifeq ($(OS_ARCH),ia64) - x:=$(warning "WARNING: $(ARCH_DATA_MODEL_ERROR)") - endif - ifeq ($(OS_ARCH),sparcv9) - x:=$(warning "WARNING: $(ARCH_DATA_MODEL_ERROR)") - endif - else - x:=$(warning "WARNING: $(ARCH_DATA_MODEL_ERROR)") - endif -endif + # Location of developer shared files + SLASH_JAVA = /java -# Alternate OS_ARCH name (defaults to OS_ARCH) -OS_ARCH2:=$(OS_ARCH2-$(OS_ARCH)) -ifeq ($(OS_ARCH2),) - OS_ARCH2:=$(OS_ARCH) + GETMIXEDPATH=$(ECHO) endif # Root of this test area (important to use full paths in some places) @@ -206,17 +77,18 @@ TEST_ROOT := $(shell $(PWD)) # Root of all test results ifdef ALT_OUTPUTDIR - ABS_OUTPUTDIR = $(ALT_OUTPUTDIR) + ABS_OUTPUTDIR = $(shell $(CD) $(ALT_OUTPUTDIR) && $(PWD)) else - ABS_OUTPUTDIR = $(TEST_ROOT)/../build/$(PLATFORM_OS) + ABS_OUTPUTDIR = $(shell $(CD) $(TEST_ROOT)/.. && $(PWD)) endif + ABS_PLATFORM_BUILD_ROOT = $(ABS_OUTPUTDIR) ABS_TEST_OUTPUT_DIR := $(ABS_PLATFORM_BUILD_ROOT)/testoutput/$(UNIQUE_DIR) # Expect JPRT to set PRODUCT_HOME (the product or jdk in this case to test) ifndef PRODUCT_HOME # Try to use j2sdk-image if it exists - ABS_JDK_IMAGE = $(ABS_PLATFORM_BUILD_ROOT)/j2sdk-image + ABS_JDK_IMAGE = $(ABS_PLATFORM_BUILD_ROOT)/images/j2sdk-image PRODUCT_HOME := \ $(shell \ if [ -d $(ABS_JDK_IMAGE) ] ; then \ @@ -240,30 +112,11 @@ ifdef JPRT_PRODUCT_VM_ARGS JAVA_VM_ARGS = $(JPRT_PRODUCT_VM_ARGS) endif -# Check JAVA_ARGS arguments based on ARCH_DATA_MODEL etc. -ifeq ($(OS_NAME),solaris) - D64_ERROR_MESSAGE=Mismatch between ARCH_DATA_MODEL=$(ARCH_DATA_MODEL) and use of -d64 in JAVA_ARGS=$(JAVA_ARGS) - ifeq ($(ARCH_DATA_MODEL),32) - ifneq ($(findstring -d64,$(JAVA_ARGS)),) - x:=$(warning "WARNING: $(D64_ERROR_MESSAGE)") - endif - endif - ifeq ($(ARCH_DATA_MODEL),64) - ifeq ($(findstring -d64,$(JAVA_ARGS)),) - x:=$(warning "WARNING: $(D64_ERROR_MESSAGE)") - endif - endif -endif - -# Macro to run make and set the shared library permissions -define SharedLibraryPermissions -$(MAKE) SHARED_LIBRARY_DIR=$1 UNIQUE_DIR=$@ shared_library_permissions -endef - # Expect JPRT to set JPRT_ARCHIVE_BUNDLE (path to zip bundle for results) -ARCHIVE_BUNDLE = $(ABS_TEST_OUTPUT_DIR)/ARCHIVE_BUNDLE.zip ifdef JPRT_ARCHIVE_BUNDLE ARCHIVE_BUNDLE = $(JPRT_ARCHIVE_BUNDLE) +else + ARCHIVE_BUNDLE = $(ABS_TEST_OUTPUT_DIR)/ARCHIVE_BUNDLE.zip endif # How to create the test bundle (pass or fail, we want to create this) @@ -272,13 +125,15 @@ ZIP_UP_RESULTS = ( $(MKDIR) -p `$(DIRNAME) $(ARCHIVE_BUNDLE)` \ && $(CD) $(ABS_TEST_OUTPUT_DIR) \ && $(CHMOD) -R a+r . \ && $(ZIP) -q -r $(ARCHIVE_BUNDLE) . ) -SUMMARY_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/JTreport/text/summary.txt + +# important results files +SUMMARY_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTreport/text/summary.txt") STATS_TXT_NAME = Stats.txt -STATS_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/$(STATS_TXT_NAME) -RUNLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/runlist.txt -PASSLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/passlist.txt -FAILLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/faillist.txt -EXITCODE = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/exitcode.txt +STATS_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/$(STATS_TXT_NAME)") +RUNLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/runlist.txt") +PASSLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/passlist.txt") +FAILLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/faillist.txt") +EXITCODE = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/exitcode.txt") TESTEXIT = \ if [ ! -s $(EXITCODE) ] ; then \ @@ -316,8 +171,8 @@ BUNDLE_UP_AND_EXIT = \ runc="`$(CAT) $(RUNLIST) | $(WC) -l | $(AWK) '{print $$1;}'`"; \ passc="`$(CAT) $(PASSLIST) | $(WC) -l | $(AWK) '{print $$1;}'`"; \ failc="`$(CAT) $(FAILLIST) | $(WC) -l | $(AWK) '{print $$1;}'`"; \ - exclc="`$(CAT) $(EXCLUDELIST) | $(WC) -l | $(AWK) '{print $$1;}'`"; \ - $(ECHO) "TEST STATS: name=$(UNIQUE_DIR) run=$${runc} pass=$${passc} fail=$${failc} excluded=$${exclc}" \ + exclc="FIXME CODETOOLS-7900176"; \ + $(ECHO) "TEST STATS: name=$(UNIQUE_DIR) run=$${runc} pass=$${passc} fail=$${failc}" \ >> $(STATS_TXT); \ else \ $(ECHO) "Missing file: $${_summary}" >> $(STATS_TXT); \ @@ -336,9 +191,24 @@ all: jdk_default @$(ECHO) "Testing completed successfully" # Prep for output +# Change execute permissions on shared library files. +# Files in repositories should never have execute permissions, but +# there are some tests that have pre-built shared libraries, and these +# windows dll files must have execute permission. Adding execute +# permission may happen automatically on windows when using certain +# versions of mercurial but it cannot be guaranteed. And blindly +# adding execute permission might be seen as a mercurial 'change', so +# we avoid adding execute permission to repository files. But testing +# from a plain source tree needs the chmod a+rx. Applying the chmod to +# all shared libraries not just dll files. And with CYGWIN and sshd +# service, you may need CYGWIN=ntsec for this to work. prep: @$(MKDIR) -p $(ABS_TEST_OUTPUT_DIR) @$(MKDIR) -p `$(DIRNAME) $(ARCHIVE_BUNDLE)` + @if [ ! -d $(TEST_ROOT)/../.hg ] ; then \ + $(FIND) $(TEST_ROOT) \( -name \*.dll -o -name \*.DLL -o -name \*.so \) \ + -exec $(CHMOD) a+rx {} \; ; \ + fi # Cleanup clean: @@ -357,50 +227,21 @@ ifndef JT_HOME endif endif -# Expect JPRT to set TESTDIRS to the jtreg test dirs -ifndef TESTDIRS - TESTDIRS = demo -endif - -# Some tests annoy me and fail frequently -PROBLEM_LIST=ProblemList.txt -PROBLEM_LISTS=$(PROBLEM_LIST) $(wildcard closed/$(PROBLEM_LIST)) -EXCLUDELIST=$(ABS_TEST_OUTPUT_DIR)/excludelist.txt +# Problematic tests to be excluded +PROBLEM_LISTS=$(call MixedDirs,$(wildcard ProblemList.txt closed/ProblemList.txt)) # Create exclude list for this platform and arch ifdef NO_EXCLUDES -$(EXCLUDELIST): $(PROBLEM_LISTS) $(TEST_DEPENDENCIES) - @$(ECHO) "NOTHING_EXCLUDED" > $@ + JTREG_EXCLUSIONS = else -$(EXCLUDELIST): $(PROBLEM_LISTS) $(TEST_DEPENDENCIES) - @$(RM) $@ $@.temp1 $@.temp2 - @(($(CAT) $(PROBLEM_LISTS) | $(EGREP) -- '$(OS_NAME)-all' ) ;\ - ($(CAT) $(PROBLEM_LISTS) | $(EGREP) -- '$(PLATFORM_OS)' ) ;\ - ($(CAT) $(PROBLEM_LISTS) | $(EGREP) -- '$(OS_NAME)-$(OS_ARCH2)' ) ;\ - ($(CAT) $(PROBLEM_LISTS) | $(EGREP) -- '$(OS_NAME)-$(OS_VERSION)') ;\ - ($(CAT) $(PROBLEM_LISTS) | $(EGREP) -- 'generic-$(OS_ARCH)' ) ;\ - ($(CAT) $(PROBLEM_LISTS) | $(EGREP) -- 'generic-$(OS_ARCH2)' ) ;\ - ($(CAT) $(PROBLEM_LISTS) | $(EGREP) -- 'generic-all' ) ;\ - ($(ECHO) "#") ;\ - ) | $(SED) -e 's@^[\ ]*@@' \ - | $(EGREP) -v '^#' > $@.temp1 - @for tdir in $(TESTDIRS) SOLARIS_10_SH_BUG_NO_EMPTY_FORS ; do \ - ( ( $(CAT) $@.temp1 | $(EGREP) "^$${tdir}" ) ; $(ECHO) "#" ) >> $@.temp2 ; \ - done - @$(ECHO) "# at least one line" >> $@.temp2 - @( $(EGREP) -v '^#' $@.temp2 ; true ) > $@ - @$(ECHO) "Excluding list contains `$(EXPAND) $@ | $(WC) -l` items" + JTREG_EXCLUSIONS = $(PROBLEM_LISTS:%=-exclude:%) endif -# Select list of directories that exist -define TestDirs -$(foreach i,$1,$(wildcard ${i})) $(foreach i,$1,$(wildcard closed/${i})) -endef -# Running batches of tests with or without agentvm -define RunBatch -$(ECHO) "Running tests: $?" -$(MAKE) TEST_DEPENDENCIES="$?" TESTDIRS="$?" UNIQUE_DIR=$@ jtreg_tests +# convert list of directories to dos paths +define MixedDirs +$(foreach i,$1,$(shell $(GETMIXEDPATH) "${i}")) endef + define SummaryInfo $(ECHO) "########################################################" $(CAT) $(?:%=$(ABS_TEST_OUTPUT_DIR)/%/$(STATS_TXT_NAME)) @@ -409,178 +250,11 @@ endef # ------------------------------------------------------------------ -# Batches of tests (somewhat arbitrary assigments to jdk_* targets) -# NOTE: These *do not* run the same tests as make/jprt.properties -JDK_DEFAULT_TARGETS = -JDK_ALL_TARGETS = - -JDK_ALL_TARGETS += jdk_awt -jdk_awt: $(call TestDirs, com/sun/awt java/awt sun/awt \ - javax/imageio javax/print sun/pisces) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_beans1 -JDK_DEFAULT_TARGETS += jdk_beans1 -jdk_beans1: $(call TestDirs, \ - java/beans/beancontext java/beans/PropertyChangeSupport \ - java/beans/Introspector java/beans/Performance \ - java/beans/VetoableChangeSupport java/beans/Statement) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_beans2 -jdk_beans2: $(call TestDirs, \ - java/beans/Beans java/beans/EventHandler java/beans/XMLDecoder \ - java/beans/PropertyEditor) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_beans3 -jdk_beans3: $(call TestDirs, java/beans/XMLEncoder) - $(call RunBatch) - -# All beans tests -jdk_beans: jdk_beans1 jdk_beans2 jdk_beans3 - @$(SummaryInfo) - -JDK_ALL_TARGETS += jdk_io -JDK_DEFAULT_TARGETS += jdk_io -jdk_io: $(call TestDirs, java/io) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_lang -JDK_DEFAULT_TARGETS += jdk_lang -jdk_lang: $(call TestDirs, java/lang sun/invoke sun/misc sun/reflect vm) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_jmx -jdk_jmx: $(call TestDirs, javax/management com/sun/jmx) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_management -jdk_management: $(call TestDirs, com/sun/management sun/management) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_math -JDK_DEFAULT_TARGETS += jdk_math -jdk_math: $(call TestDirs, java/math) - $(call RunBatch) - -JDK_DEFAULT_TARGETS += jdk_time -jdk_time: $(call TestDirs, java/time) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_other -JDK_DEFAULT_TARGETS += jdk_other -jdk_other: $(call TestDirs, \ - demo/jvmti demo/zipfs sample \ - javax/naming com/sun/jndi \ - javax/script \ - java/sql javax/sql \ - javax/smartcardio \ - javax/xml/jaxp \ - javax/xml/soap \ - javax/xml/ws com/sun/internal/ws com/sun/org/glassfish \ - jdk/asm \ - jdk/lambda \ - com/sun/org/apache/xerces \ - com/sun/corba \ - com/sun/tracing \ - sun/usagetracker \ - misc) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_net -JDK_DEFAULT_TARGETS += jdk_net -jdk_net: $(call TestDirs, com/sun/net java/net sun/net com/oracle/net) - $(call RunBatch) - -jdk_nio: $(call TestDirs, java/nio sun/nio com/oracle/nio) - $(call SharedLibraryPermissions,java/nio/channels) - $(call RunBatch) - -jdk_sctp: $(call TestDirs, com/sun/nio/sctp) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_rmi -jdk_rmi: $(call TestDirs, java/rmi sun/rmi javax/rmi/ssl) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_security1 -JDK_DEFAULT_TARGETS += jdk_security1 -jdk_security1: $(call TestDirs, java/security) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_security2 -jdk_security2: $(call TestDirs, javax/crypto javax/xml/crypto com/sun/crypto) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_security3 -jdk_security3: $(call TestDirs, com/sun/security lib/security javax/security \ - sun/security com/sun/org/apache/xml/internal/security \ - com/oracle/security) - $(call SharedLibraryPermissions,sun/security) - $(call RunBatch) - -# All security tests -jdk_security: jdk_security1 jdk_security2 jdk_security3 - @$(SummaryInfo) - -JDK_ALL_TARGETS += jdk_sound -jdk_sound: $(call TestDirs, javax/sound) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_swing -jdk_swing: $(call TestDirs, javax/swing sun/java2d \ - demo/jfc com/sun/java/swing) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_text -JDK_DEFAULT_TARGETS += jdk_text -jdk_text: $(call TestDirs, java/text sun/text) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_jdi -jdk_jdi: $(call TestDirs, com/sun/jdi) - $(call RunBatch) - -JDK_ALL_TARGETS += jdk_tools -jdk_tools: $(call TestDirs, com/sun/tools sun/jvmstat sun/tools tools) - $(call SharedLibraryPermissions,tools/launcher) - $(call RunBatch) - -ifdef OPENJDK -jdk_jfr: -else -JDK_ALL_TARGETS += jdk_jfr -jdk_jfr: $(call TestDirs, com/oracle/jfr) - $(call RunBatch) -endif - -JDK_ALL_TARGETS += jdk_util -JDK_DEFAULT_TARGETS += jdk_util -jdk_util: $(call TestDirs, java/util sun/util) - $(call RunBatch) - -# ------------------------------------------------------------------ - -# Run default tests -# note that this *does not* have the same meaning as jprt.properties :: jprt.make.rule.default.test.targets -jdk_default: $(JDK_DEFAULT_TARGETS) - @$(SummaryInfo) - -# Run core tests -# please keep this in sync with jdk/make/jprt.properties :: jprt.make.rule.core.test.targets -jdk_core: jdk_lang jdk_math jdk_util jdk_io jdk_net jdk_nio \ - jdk_security1 jdk_security2 jdk_security3 jdk_rmi \ - jdk_management jdk_jmx jdk_text jdk_tools jdk_jfr jdk_other - @$(SummaryInfo) - -# Run all tests -# note that this *does not* have the same meaning as jprt.properties :: jprt.make.rule.all.test.targets -jdk_all: $(JDK_ALL_TARGETS) - @$(SummaryInfo) - -# These are all phony targets -PHONY_LIST += $(JDK_ALL_TARGETS) jdk_default jdk_core jdk_all +jdk_%: + $(ECHO) "Running tests: $@" + for each in $@; do \ + $(MAKE) -j 1 TEST_SELECTION=":$$each" UNIQUE_DIR=$$each jtreg_tests; \ + done # ------------------------------------------------------------------ @@ -625,44 +299,23 @@ JTREG_TEST_OPTIONS += $(JTREG_TESTVM_MEMORY_OPTION) $(JTREG): $(JT_HOME) # Run jtreg -jtreg_tests: prep $(PRODUCT_HOME) $(JTREG) $(EXCLUDELIST) - @$(EXPAND) $(EXCLUDELIST) \ - | $(CUT) -d' ' -f1 \ - | $(SED) -e 's@^@Excluding: @' +jtreg_tests: prep $(PRODUCT_HOME) $(JTREG) ( \ ( JT_HOME=$(shell $(GETMIXEDPATH) "$(JT_HOME)"); \ export JT_HOME; \ $(shell $(GETMIXEDPATH) "$(JTREG)") \ $(JTREG_BASIC_OPTIONS) \ - -r:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/JTreport \ - -w:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)")/JTwork \ + -r:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTreport") \ + -w:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTwork") \ -jdk:$(shell $(GETMIXEDPATH) "$(PRODUCT_HOME)") \ - -exclude:$(shell $(GETMIXEDPATH) "$(EXCLUDELIST)") \ + $(JTREG_EXCLUSIONS) \ $(JTREG_TEST_OPTIONS) \ - $(TESTDIRS) \ - ) ; $(BUNDLE_UP_AND_EXIT) \ + $(TEST_SELECTION) \ + ) ; \ + $(BUNDLE_UP_AND_EXIT) \ ) 2>&1 | $(TEE) $(ABS_TEST_OUTPUT_DIR)/output.txt ; $(TESTEXIT) -# Rule that may change execute permissions on shared library files. -# Files in repositories should never have execute permissions, but there -# are some tests that have pre-built shared libraries, and these windows -# dll files must have execute permission. Adding execute permission -# may happen automatically on windows when using certain versions of mercurial -# but it cannot be guaranteed. And blindly adding execute permission might -# be seen as a mercurial 'change', so we avoid adding execute permission to -# repository files. But testing from a plain source tree needs the chmod a+rx. -# Used on select directories and applying the chmod to all shared libraries -# not just dll files. On windows, this may not work with MKS if the files -# were installed with CYGWIN unzip or untar (MKS chmod may not do anything). -# And with CYGWIN and sshd service, you may need CYGWIN=ntsec for this to work. -# -shared_library_permissions: $(SHARED_LIBRARY_DIR) - if [ ! -d $(TEST_ROOT)/../.hg ] ; then \ - $(FIND) $< \( -name \*.dll -o -name \*.DLL -o -name \*.so \) \ - -exec $(CHMOD) a+rx {} \; ; \ - fi - -PHONY_LIST += jtreg_tests shared_library_permissions +PHONY_LIST += jtreg_tests ################################################################ diff --git a/jdk/test/ProblemList.txt b/jdk/test/ProblemList.txt index ea99549a0f7..6cb3ce73488 100644 --- a/jdk/test/ProblemList.txt +++ b/jdk/test/ProblemList.txt @@ -5,9 +5,7 @@ # # This code is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License version 2 only, as -# published by the Free Software Foundation. Oracle designates this -# particular file as subject to the "Classpath" exception as provided -# by Oracle in the LICENSE file that accompanied this code. +# published by the Free Software Foundation. # # This code is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or @@ -128,15 +126,6 @@ java/lang/management/ThreadMXBean/ThreadStateTest.java generic-all # 7067973 java/lang/management/MemoryMXBean/CollectionUsageThreshold.java generic-all -# 7196801 -java/lang/management/MemoryMXBean/LowMemoryTest2.sh generic-all - -# 8021230 -java/lang/ThreadLocal/ThreadLocalSupplierTest.java generic-all - -# 8026502 -java/lang/invoke/MethodHandleConstants.java generic-all - ############################################################################ # jdk_management @@ -144,13 +133,13 @@ java/lang/invoke/MethodHandleConstants.java generic-all # 8010897 sun/management/HotspotRuntimeMBean/GetSafepointSyncTime.java macosx-all +# 8028150 +sun/management/jmxremote/bootstrap/RmiSslBootstrapTest.sh windows-all + ############################################################################ # jdk_jmx -# 6959636 -javax/management/loading/LibraryLoader/LibraryLoaderTest.java windows-all - ############################################################################ # jdk_math @@ -165,13 +154,16 @@ demo/jvmti/compiledMethodLoad/CompiledMethodLoadTest.java generic-all # 7027502 demo/jvmti/hprof/MonitorTest.java generic-all -# 8024423 - JVMTI: GetLoadedClasses doesn't enumerate anonymous classes +# 8024423 - JVMTI: GetLoadedClasses doesn't enumerate anonymous classes demo/jvmti/hprof/HeapAllTest.java generic-all demo/jvmti/hprof/HeapBinaryFormatTest.java generic-all demo/jvmti/hprof/HeapDumpTest.java generic-all demo/jvmti/hprof/OptionsTest.java generic-all demo/jvmti/hprof/StackMapTableTest.java generic-all +# 8027973 +javax/xml/jaxp/transform/jdk8004476/XSLTExFuncTest.java windows-all + ############################################################################ # jdk_net @@ -203,9 +195,6 @@ java/net/MulticastSocket/Test.java macosx-all # 7143960 java/net/DatagramSocket/SendDatagramToBadAddress.java macosx-all -# 8014719 -sun/net/www/http/HttpClient/ProxyTest.java generic-all - ############################################################################ # jdk_nio @@ -213,9 +202,6 @@ sun/net/www/http/HttpClient/ProxyTest.java generic-all # 6963118 java/nio/channels/Selector/Wakeup.java windows-all -# 7052549 -java/nio/channels/FileChannel/ReleaseOnCloseDeadlock.java windows-all - # 7133499, 7133497 java/nio/channels/AsyncCloseAndInterrupt.java macosx-all java/nio/channels/AsynchronousFileChannel/Lock.java macosx-all @@ -227,6 +213,10 @@ java/nio/channels/DatagramChannel/ChangingAddress.java macosx-all # 7132677 java/nio/channels/Selector/OutOfBand.java macosx-all +# 7158947, Solaris 11 +java/nio/file/WatchService/Basic.java solaris-all +java/nio/file/WatchService/LotsOfEvents.java solaris-all + ############################################################################ # jdk_rmi @@ -262,10 +252,6 @@ sun/security/pkcs11/ec/ReadCertificates.java solaris-all sun/security/pkcs11/ec/ReadPKCS12.java solaris-all sun/security/pkcs11/sslecc/ClientJSSEServerJSSE.java solaris-all -# 8009438 -sun/security/pkcs11/Secmod/AddPrivateKey.java linux-all -sun/security/pkcs11/Secmod/TrustAnchors.java linux-all - # 7041639, Solaris DSA keypair generation bug java/security/KeyPairGenerator/SolarisShortDSA.java solaris-all sun/security/tools/keytool/standard.sh solaris-all @@ -335,7 +321,4 @@ java/util/concurrent/ThreadPoolExecutor/CoreThreadTimeOut.java generic-all # Filed 6772009 java/util/concurrent/locks/ReentrantLock/CancelledLockLoops.java generic-all -# 8026772: test/sun/util/resources/TimeZone/Bug6317929.java failing -sun/util/resources/TimeZone/Bug6317929.java generic-all - ############################################################################ diff --git a/jdk/test/com/sun/awt/SecurityWarning/CustomSecurityManager.java b/jdk/test/com/sun/awt/SecurityWarning/CustomSecurityManager.java new file mode 100644 index 00000000000..3885f168de3 --- /dev/null +++ b/jdk/test/com/sun/awt/SecurityWarning/CustomSecurityManager.java @@ -0,0 +1,11 @@ +import sun.security.util.SecurityConstants; +import java.security.Permission; + +public class CustomSecurityManager extends SecurityManager { + @Override + public void checkPermission(Permission perm) { + if (perm.implies(SecurityConstants.AWT.TOPLEVEL_WINDOW_PERMISSION)) { + throw new SecurityException(); + } + } +} diff --git a/jdk/test/com/sun/awt/SecurityWarning/GetSizeShouldNotReturnZero.java b/jdk/test/com/sun/awt/SecurityWarning/GetSizeShouldNotReturnZero.java index f66366c9121..bf4cdc5bb3a 100644 --- a/jdk/test/com/sun/awt/SecurityWarning/GetSizeShouldNotReturnZero.java +++ b/jdk/test/com/sun/awt/SecurityWarning/GetSizeShouldNotReturnZero.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -27,8 +27,9 @@ @summary The size returned by SecurityWarning.getSize() should not be zero @author anthony.petrov@sun.com: area=awt.toplevel @library ../../../../java/awt/regtesthelpers - @build Util - @run main GetSizeShouldNotReturnZero + @build Util CustomSecurityManager CopyClassFile + @run main CopyClassFile CustomSecurityManager bootcp/ + @run main/othervm/secure=CustomSecurityManager -Xbootclasspath/a:bootcp GetSizeShouldNotReturnZero */ /** @@ -37,11 +38,10 @@ * summary: The size returned by SecurityWarning.getSize() should not be zero */ -import java.awt.*; -import java.awt.event.*; -import java.security.Permission; -import test.java.awt.regtesthelpers.Util; import com.sun.awt.SecurityWarning; +import test.java.awt.regtesthelpers.Util; + +import java.awt.*; public class GetSizeShouldNotReturnZero { @@ -56,21 +56,6 @@ public class GetSizeShouldNotReturnZero Sysout.createDialog( ); Sysout.printInstructions( instructions ); - - // Install the security manager so that all subsequently created - // windows display the security warning. - System.setSecurityManager(new SecurityManager() { - - @Override - public void checkPermission(Permission perm) { - } - - @Override - public boolean checkTopLevelWindow(Object window) { - return false; - } - }); - Frame f = new Frame(); f.setSize(100, 100); f.setVisible(true); @@ -87,7 +72,6 @@ public class GetSizeShouldNotReturnZero }//End init() - /***************************************************** * Standard Test Machinery Section * DO NOT modify anything in this section -- it's a diff --git a/jdk/test/com/sun/crypto/provider/KeyFactory/TestProviderLeak.java b/jdk/test/com/sun/crypto/provider/KeyFactory/TestProviderLeak.java index 04fa96a9813..83b2c690410 100644 --- a/jdk/test/com/sun/crypto/provider/KeyFactory/TestProviderLeak.java +++ b/jdk/test/com/sun/crypto/provider/KeyFactory/TestProviderLeak.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -23,7 +23,7 @@ /* * @test - * @bug 6578538 + * @bug 6578538 8027624 * @summary com.sun.crypto.provider.SunJCE instance leak using KRB5 and * LoginContext * @author Brad Wetmore @@ -89,10 +89,6 @@ public class TestProviderLeak { } public static void main(String [] args) throws Exception { - // Eat up memory - Deque<byte []> dummyData = eatupMemory(); - assert (dummyData != null); - // Prepare the test final SecretKeyFactory skf = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1", "SunJCE"); @@ -107,6 +103,10 @@ public class TestProviderLeak { } }; + // Eat up memory + Deque<byte []> dummyData = eatupMemory(); + assert (dummyData != null); + // Start testing iteration try { for (int i = 0; i <= 1000; i++) { diff --git a/jdk/test/com/sun/jdi/BadHandshakeTest.java b/jdk/test/com/sun/jdi/BadHandshakeTest.java index 73f13fe253e..8e35442ebb3 100644 --- a/jdk/test/com/sun/jdi/BadHandshakeTest.java +++ b/jdk/test/com/sun/jdi/BadHandshakeTest.java @@ -24,16 +24,12 @@ /* @test * @bug 6306165 6432567 * @summary Check that a bad handshake doesn't cause a debuggee to abort + * @library /lib/testlibrary * * @build VMConnection BadHandshakeTest Exit0 * @run main BadHandshakeTest * */ -import java.io.InputStream; -import java.io.IOException; -import java.io.File; -import java.io.BufferedInputStream; -import java.net.ServerSocket; import java.net.Socket; import java.net.InetAddress; import com.sun.jdi.Bootstrap; @@ -44,50 +40,13 @@ import com.sun.jdi.connect.AttachingConnector; import java.util.Map; import java.util.List; import java.util.Iterator; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; + +import jdk.testlibrary.Utils; +import jdk.testlibrary.ProcessTools; public class BadHandshakeTest { - - static volatile boolean ready = false; - - /* - * Helper class to redirect process output/error - */ - static class IOHandler implements Runnable { - InputStream in; - - IOHandler(InputStream in) { - this.in = in; - } - - static void handle(InputStream in) { - IOHandler handler = new IOHandler(in); - Thread thr = new Thread(handler); - thr.setDaemon(true); - thr.start(); - } - - public void run() { - try { - byte b[] = new byte[100]; - for (;;) { - int n = in.read(b, 0, 100); - // The first thing that will get read is - // Listening for transport dt_socket at address: xxxxx - // which shows the debuggee is ready to accept connections. - ready = true; - if (n < 0) { - break; - } - String s = new String(b, 0, n, "UTF-8"); - System.out.print(s); - } - } catch (IOException ioe) { - ioe.printStackTrace(); - } - } - - } - /* * Find a connector by name */ @@ -106,22 +65,31 @@ public class BadHandshakeTest { /* * Launch a server debuggee with the given address */ - private static Process launch(String address, String class_name) throws IOException { - String exe = System.getProperty("java.home") - + File.separator + "bin" + File.separator + "java"; - String cmd = exe + " " + VMConnection.getDebuggeeVMOptions() + - " -agentlib:jdwp=transport=dt_socket" + - ",server=y" + ",suspend=y" + ",address=" + address + - " " + class_name; + private static Process launch(String address, String class_name) throws Exception { + String[] args = VMConnection.insertDebuggeeVMOptions(new String[] { + "-agentlib:jdwp=transport=dt_socket" + + ",server=y" + ",suspend=y" + ",address=" + address, + class_name + }); - System.out.println("Starting: " + cmd); + ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(args); - Process p = Runtime.getRuntime().exec(cmd); + final AtomicBoolean success = new AtomicBoolean(); + Process p = ProcessTools.startProcess( + class_name, + pb, + (line) -> { + // The first thing that will get read is + // Listening for transport dt_socket at address: xxxxx + // which shows the debuggee is ready to accept connections. + success.set(line.contains("Listening for transport dt_socket at address:")); + return true; + }, + 1500, + TimeUnit.MILLISECONDS + ); - IOHandler.handle(p.getInputStream()); - IOHandler.handle(p.getErrorStream()); - - return p; + return success.get() ? p : null; } /* @@ -131,23 +99,14 @@ public class BadHandshakeTest { * - verify we saw no error */ public static void main(String args[]) throws Exception { - // find a free port - ServerSocket ss = new ServerSocket(0); - int port = ss.getLocalPort(); - ss.close(); + int port = Utils.getFreePort(); String address = String.valueOf(port); // launch the server debuggee Process process = launch(address, "Exit0"); - - // wait for the debugge to be ready - while (!ready) { - try { - Thread.sleep(1000); - } catch(Exception ee) { - throw ee; - } + if (process == null) { + throw new RuntimeException("Unable to start debugee"); } // Connect to the debuggee and handshake with garbage diff --git a/jdk/test/com/sun/jdi/BreakpointWithFullGC.sh b/jdk/test/com/sun/jdi/BreakpointWithFullGC.sh index 590fda3b156..ef0da8804a2 100644 --- a/jdk/test/com/sun/jdi/BreakpointWithFullGC.sh +++ b/jdk/test/com/sun/jdi/BreakpointWithFullGC.sh @@ -1,7 +1,7 @@ #!/bin/sh # -# Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2009, 2013 Oracle and/or its affiliates. All rights reserved. # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. # # This code is free software; you can redistribute it and/or modify it @@ -62,6 +62,7 @@ public class $1 { System.out.println("top of loop"); // @1 breakpoint init(1000000); objList.clear(); + System.gc(); System.out.println("bottom of loop"); // @1 breakpoint } System.out.println("end of test"); // @1 breakpoint diff --git a/jdk/test/com/sun/jdi/JdbMethodExitTest.sh b/jdk/test/com/sun/jdi/JdbMethodExitTest.sh index 52c0fe7becf..ab00816ca6e 100644 --- a/jdk/test/com/sun/jdi/JdbMethodExitTest.sh +++ b/jdk/test/com/sun/jdi/JdbMethodExitTest.sh @@ -156,7 +156,7 @@ class $classname { // a resume. $classname xx = new $classname(); - + System.out.println("threadid="+Thread.currentThread().getId()); bkpt(); // test all possible return types @@ -197,6 +197,8 @@ dojdbCmds() # test all possible return types runToBkpt @1 + debuggeeMatchRegexp "s/threadid=\(.*\)/\1/g" + threadid=$? cmd untrace cmd trace methods @@ -226,7 +228,7 @@ dojdbCmds() # trace exit of methods with all the return values # (but just check a couple of them) - cmd trace go exits + cmd trace go method exits $threadid cmd cont jdbFailIfNotPresent "instance of JdbMethodExitTest" jdbFailIfNotPresent "return value = 8" @@ -235,7 +237,7 @@ dojdbCmds() cmd step up - cmd trace methods + cmd trace methods $threadid cmd cont jdbFailIfNotPresent "Method entered:" cmd cont @@ -243,7 +245,9 @@ dojdbCmds() cmd step up - cmd trace go methods + cmd trace go methods $threadid + cmd cont + cmd cont cmd cont jdbFailIfNotPresent "Method entered: \"thread=main\", JdbMethodExitTest.traceMethods1" jdbFailIfNotPresent 'Method exited: .* JdbMethodExitTest.traceMethods1' @@ -251,14 +255,14 @@ dojdbCmds() cmd step up - cmd trace method exits + cmd trace method exits $threadid cmd cont jdbFailIfNotPresent "Method exited: return value = \"traceExits\"" cmd untrace cmd step up - cmd trace go method exits + cmd trace go method exits $threadid cmd cont jdbFailIfNotPresent 'Method exited: .* JdbMethodExitTest.traceExits1' cmd untrace @@ -266,7 +270,7 @@ dojdbCmds() cmd step # step into traceExit() - cmd trace method exit + cmd trace method exit $threadid cmd cont jdbFailIfNotPresent "Method exited: return value = \"traceExit\"" cmd untrace @@ -275,7 +279,7 @@ dojdbCmds() cmd step cmd step # skip over setting return value in caller :-( - cmd trace go method exit + cmd trace go method exit $threadid cmd cont jdbFailIfNotPresent 'Method exited: .*JdbMethodExitTest.traceExit1' cmd quit diff --git a/jdk/test/com/sun/jdi/ShellScaffold.sh b/jdk/test/com/sun/jdi/ShellScaffold.sh index d8635e3dda9..6ed55c1ae91 100644 --- a/jdk/test/com/sun/jdi/ShellScaffold.sh +++ b/jdk/test/com/sun/jdi/ShellScaffold.sh @@ -1004,6 +1004,50 @@ grepForString() return $stat } +# $1 is the filename, $2 is the regexp to match and return, +# $3 is the number of lines to search (from the end) +matchRegexp() +{ + if [ -z "$3" ] ; then + theCmd=cat + else + theCmd="tail -$3" + fi + + case "$2" in + *\>*) + # Target string contains a '>' so we better not ignore it + res=`$theCmd $1 | sed -e "$2"` + ;; + *) + # Target string does not contain a '>'. + # NOTE: if $1 does not end with a new line, piping it to sed + # doesn't include the chars on the last line. Detect this + # case, and add a new line. + theFile="$1" + if [ `tail -1 "$theFile" | wc -l | sed -e 's@ @@g'` = 0 ] ; then + # The target file doesn't end with a new line so we have + # add one to a copy of the target file so the sed command + # below can filter that last line. + cp "$theFile" "$theFile.tmp" + theFile="$theFile.tmp" + echo >> "$theFile" + fi + + # See bug 6220903. Sometimes the jdb prompt chars ('> ') can + # get interleaved in the target file which can keep us from + # matching the target string. + res=`$theCmd "$theFile" | sed -e 's@> @@g' -e 's@>@@g' \ + | sed -e "$2"` + if [ "$theFile" != "$1" ]; then + # remove the copy of the target file + rm -f "$theFile" + fi + unset theFile + esac + return $res +} + # $1 is the filename, $2 is the string to look for, # $3 is the number of lines to search (from the end) failIfPresent() @@ -1058,6 +1102,14 @@ debuggeeFailIfPresent() failIfPresent $debuggeeOutFile "$1" $2 } +# match and return the output from the regexp $1 in the debuggee output +# $2 is the number of lines to search (from the end) +debuggeeMatchRegexp() +{ + matchRegexp $debuggeeOutFile "$1" $2 +} + + # This should really be named 'done' instead of pass. pass() { diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/Client.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/Client.java index b5eb847fc55..384a08d1772 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/Client.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/Client.java @@ -1,3 +1,25 @@ +/* + * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ import java.util.Collections; import java.util.HashSet; diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/ConfigKey.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/ConfigKey.java index 0739065744e..37adae0f72d 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/ConfigKey.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/ConfigKey.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + public enum ConfigKey { CONSTANT3, CONSTANT2; } \ No newline at end of file diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/TestNotification.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/TestNotification.java index aaa31a49129..f9f2832b3d7 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/TestNotification.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Client/TestNotification.java @@ -1,11 +1,28 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ import javax.management.Notification; -/* - * To change this template, choose Tools | Templates - * and open the template in the editor. - */ - /** * * @author Jaroslav Bachorik <jaroslav.bachorik at oracle.com> diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/ConfigKey.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/ConfigKey.java index c79fafbba4b..3b1d1d29257 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/ConfigKey.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/ConfigKey.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + public enum ConfigKey { CONSTANT1, CONSTANT2; } \ No newline at end of file diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Server.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Server.java index a9254214265..c02f2f23f6d 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Server.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Server.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + import java.io.File; import java.lang.management.ManagementFactory; import java.net.BindException; diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Ste.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Ste.java index 91ecd00ae50..00cc1d505de 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Ste.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/Ste.java @@ -1,3 +1,25 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ import javax.management.NotificationBroadcasterSupport; diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/SteMBean.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/SteMBean.java index b106bc11da7..9b2c0b1bca9 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/SteMBean.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/SteMBean.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + public interface SteMBean { public void foo(); } \ No newline at end of file diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/TestNotification.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/TestNotification.java index 6ffdb7f4421..6a9efd44955 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/TestNotification.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/Server/TestNotification.java @@ -1,11 +1,28 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ import javax.management.Notification; -/* - * To change this template, choose Tools | Templates - * and open the template in the editor. - */ - /** * * @author Jaroslav Bachorik <jaroslav.bachorik at oracle.com> diff --git a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/TestSerializationMismatch.java b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/TestSerializationMismatch.java index f62a6437d51..ad8009a4b07 100644 --- a/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/TestSerializationMismatch.java +++ b/jdk/test/com/sun/jmx/remote/NotificationMarshalVersions/TestSerializationMismatch.java @@ -1,3 +1,25 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ import java.io.File; import java.lang.reflect.Method; diff --git a/jdk/test/com/sun/jndi/cosnaming/CNNameParser.java b/jdk/test/com/sun/jndi/cosnaming/CNNameParser.java index 954cc1b3fbc..fac3f77fe86 100644 --- a/jdk/test/com/sun/jndi/cosnaming/CNNameParser.java +++ b/jdk/test/com/sun/jndi/cosnaming/CNNameParser.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test * @bug 4238914 * @summary Tests that JNDI/COS naming parser supports the syntax diff --git a/jdk/test/com/sun/jndi/cosnaming/IiopUrlIPv6.java b/jdk/test/com/sun/jndi/cosnaming/IiopUrlIPv6.java index 0fe573c0ea3..30cb39289b2 100644 --- a/jdk/test/com/sun/jndi/cosnaming/IiopUrlIPv6.java +++ b/jdk/test/com/sun/jndi/cosnaming/IiopUrlIPv6.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test * @bug 5042453 * @summary Ipv6 address throws Non-numeric port number error diff --git a/jdk/test/com/sun/net/httpserver/bugs/B6433018.java b/jdk/test/com/sun/net/httpserver/bugs/B6433018.java index 7b4aa43c512..3193530aebc 100644 --- a/jdk/test/com/sun/net/httpserver/bugs/B6433018.java +++ b/jdk/test/com/sun/net/httpserver/bugs/B6433018.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2006, 2013 Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -29,20 +29,19 @@ import com.sun.net.httpserver.*; -import java.util.*; import java.util.concurrent.*; import java.io.*; import java.net.*; public class B6433018 { - static String CRLF = "\r\n"; + static final String CRLF = "\r\n"; /* invalid HTTP POST with extra CRLF at end */ /* This checks that the server is able to handle it * and recognise the second request */ - static String cmd = + static final String cmd = "POST /test/item HTTP/1.1"+CRLF+ "Keep-Alive: 300"+CRLF+ "Proxy-Connection: keep-alive"+CRLF+ @@ -61,45 +60,47 @@ public class B6433018 { "Pragma: no-cache"+CRLF+ "Cache-Control: no-cache"+CRLF+CRLF; - public static void main (String[] args) throws Exception { - Handler handler = new Handler(); - InetSocketAddress addr = new InetSocketAddress (0); - HttpServer server = HttpServer.create (addr, 0); - HttpContext ctx = server.createContext ("/test", handler); + public static void main(String[] args) throws Exception { + CountDownLatch finished = new CountDownLatch(2); + Handler handler = new Handler(finished); + InetSocketAddress addr = new InetSocketAddress(0); + HttpServer server = HttpServer.create(addr, 0); + HttpContext ctx = server.createContext("/test", handler); - server.start (); - - Socket s = new Socket ("localhost", server.getAddress().getPort()); - - try { - OutputStream os = s.getOutputStream(); - os.write (cmd.getBytes()); - Thread.sleep (3000); - s.close(); - } catch (IOException e) { } - server.stop(2); - if (requests != 2) { - throw new RuntimeException ("did not receive the 2 requests"); + server.start(); + int port = server.getAddress().getPort(); + try (Socket s = new Socket("localhost", port); + OutputStream os = s.getOutputStream()) { + os.write(cmd.getBytes()); + finished.await(30, TimeUnit.SECONDS); + } finally { + server.stop(2); } - System.out.println ("OK"); + + if (finished.getCount() != 0) + throw new RuntimeException("did not receive the 2 requests"); + + System.out.println("OK"); } - public static boolean error = false; - static int requests = 0; - static class Handler implements HttpHandler { - int invocation = 1; - public void handle (HttpExchange t) - throws IOException - { - InputStream is = t.getRequestBody(); - Headers map = t.getRequestHeaders(); - Headers rmap = t.getResponseHeaders(); - while (is.read () != -1) ; - is.close(); - t.sendResponseHeaders (200, -1); + private final CountDownLatch finished; + + Handler(CountDownLatch finished) { + this.finished = finished; + } + + @Override + public void handle(HttpExchange t) throws IOException { + try (InputStream is = t.getRequestBody()) { + Headers map = t.getRequestHeaders(); + Headers rmap = t.getResponseHeaders(); + while (is.read() != -1); + } + t.sendResponseHeaders(200, -1); t.close(); - requests ++; + finished.countDown(); } } } + diff --git a/jdk/test/demo/zipfs/ZipFSTester.java b/jdk/test/demo/zipfs/ZipFSTester.java index c6bd389c941..6153a66032c 100644 --- a/jdk/test/demo/zipfs/ZipFSTester.java +++ b/jdk/test/demo/zipfs/ZipFSTester.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it diff --git a/jdk/test/java/awt/AlphaComposite/TestAlphaCompositeForNaN.java b/jdk/test/java/awt/AlphaComposite/TestAlphaCompositeForNaN.java index 2b9fb6e2f2e..77f0ba32b12 100644 --- a/jdk/test/java/awt/AlphaComposite/TestAlphaCompositeForNaN.java +++ b/jdk/test/java/awt/AlphaComposite/TestAlphaCompositeForNaN.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* * @test * @bug 6918065 diff --git a/jdk/test/java/awt/Choice/ChoiceKeyEventReaction/ChoiceKeyEventReaction.html b/jdk/test/java/awt/Choice/ChoiceKeyEventReaction/ChoiceKeyEventReaction.html index fca08218211..7c566760233 100644 --- a/jdk/test/java/awt/Choice/ChoiceKeyEventReaction/ChoiceKeyEventReaction.html +++ b/jdk/test/java/awt/Choice/ChoiceKeyEventReaction/ChoiceKeyEventReaction.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Choice/NonFocusablePopupMenuTest/NonFocusablePopupMenuTest.html b/jdk/test/java/awt/Choice/NonFocusablePopupMenuTest/NonFocusablePopupMenuTest.html index a2f0271077b..bb03fafcfbc 100644 --- a/jdk/test/java/awt/Choice/NonFocusablePopupMenuTest/NonFocusablePopupMenuTest.html +++ b/jdk/test/java/awt/Choice/NonFocusablePopupMenuTest/NonFocusablePopupMenuTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Component/F10TopToplevel/F10TopToplevel.html b/jdk/test/java/awt/Component/F10TopToplevel/F10TopToplevel.html index 7bea0ea8b17..84f5e96ac18 100644 --- a/jdk/test/java/awt/Component/F10TopToplevel/F10TopToplevel.html +++ b/jdk/test/java/awt/Component/F10TopToplevel/F10TopToplevel.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Component/UpdatingBootTime/UpdatingBootTime.html b/jdk/test/java/awt/Component/UpdatingBootTime/UpdatingBootTime.html index c310b053601..2a407963eb5 100644 --- a/jdk/test/java/awt/Component/UpdatingBootTime/UpdatingBootTime.html +++ b/jdk/test/java/awt/Component/UpdatingBootTime/UpdatingBootTime.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/MissedHtmlAndRtfBug.html b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/MissedHtmlAndRtfBug.html index 21396353d7c..af168b4669f 100644 --- a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/MissedHtmlAndRtfBug.html +++ b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/MissedHtmlAndRtfBug.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/NextFramePositionCalculator.java b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/NextFramePositionCalculator.java index c97ea671ee2..ab36c527d8f 100644 --- a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/NextFramePositionCalculator.java +++ b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/NextFramePositionCalculator.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + import java.awt.*; diff --git a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/SourcePanel.java b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/SourcePanel.java index 5985df5c722..3e6269a153a 100644 --- a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/SourcePanel.java +++ b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/SourcePanel.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + import java.awt.dnd.DragSource; import java.awt.dnd.DnDConstants; import java.awt.dnd.DragGestureEvent; diff --git a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/TargetPanel.java b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/TargetPanel.java index 2e569618c3c..a7619006622 100644 --- a/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/TargetPanel.java +++ b/jdk/test/java/awt/DataFlavor/MissedHtmlAndRtfBug/TargetPanel.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + import java.awt.datatransfer.Transferable; import java.awt.dnd.*; import java.awt.*; diff --git a/jdk/test/java/awt/EventDispatchThread/LoopRobustness/LoopRobustness.html b/jdk/test/java/awt/EventDispatchThread/LoopRobustness/LoopRobustness.html index 6d71d8c9e77..70f1b596e37 100644 --- a/jdk/test/java/awt/EventDispatchThread/LoopRobustness/LoopRobustness.html +++ b/jdk/test/java/awt/EventDispatchThread/LoopRobustness/LoopRobustness.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 1998, 2009, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <HTML> <!-- @test @bug 4023283 diff --git a/jdk/test/java/awt/EventQueue/MainAppContext/MainAppContext.java b/jdk/test/java/awt/EventQueue/MainAppContext/MainAppContext.java index 2a203208366..d7ae2595bd5 100644 --- a/jdk/test/java/awt/EventQueue/MainAppContext/MainAppContext.java +++ b/jdk/test/java/awt/EventQueue/MainAppContext/MainAppContext.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* * @test * @bug 7122796 diff --git a/jdk/test/java/awt/EventQueue/PostEventOrderingTest/PostEventOrderingTest.java b/jdk/test/java/awt/EventQueue/PostEventOrderingTest/PostEventOrderingTest.java index d6d9ec7e1a0..c3685370892 100644 --- a/jdk/test/java/awt/EventQueue/PostEventOrderingTest/PostEventOrderingTest.java +++ b/jdk/test/java/awt/EventQueue/PostEventOrderingTest/PostEventOrderingTest.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/FileDialog/FileDialogReturnTest/FileDialogReturnTest.html b/jdk/test/java/awt/FileDialog/FileDialogReturnTest/FileDialogReturnTest.html index 6c6452521a9..a13ecf7e1c1 100644 --- a/jdk/test/java/awt/FileDialog/FileDialogReturnTest/FileDialogReturnTest.html +++ b/jdk/test/java/awt/FileDialog/FileDialogReturnTest/FileDialogReturnTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.html b/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.html index 56e616362be..c75f816fa8d 100644 --- a/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.html +++ b/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.java b/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.java index 38fbbccca90..5d54d9aa119 100644 --- a/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.java +++ b/jdk/test/java/awt/FileDialog/FileNameOverrideTest/FileNameOverrideTest.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* test @bug 6260659 diff --git a/jdk/test/java/awt/FileDialog/FilenameFilterTest/FilenameFilterTest.html b/jdk/test/java/awt/FileDialog/FilenameFilterTest/FilenameFilterTest.html index 89c13fc573b..6182d5b8b33 100644 --- a/jdk/test/java/awt/FileDialog/FilenameFilterTest/FilenameFilterTest.html +++ b/jdk/test/java/awt/FileDialog/FilenameFilterTest/FilenameFilterTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2006, 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/FileDialog/MultipleMode/MultipleMode.html b/jdk/test/java/awt/FileDialog/MultipleMode/MultipleMode.html index a52ee581eba..af650115c1a 100644 --- a/jdk/test/java/awt/FileDialog/MultipleMode/MultipleMode.html +++ b/jdk/test/java/awt/FileDialog/MultipleMode/MultipleMode.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/FileDialog/RegexpFilterTest/RegexpFilterTest.html b/jdk/test/java/awt/FileDialog/RegexpFilterTest/RegexpFilterTest.html index 37fc680ff05..59135576ea6 100644 --- a/jdk/test/java/awt/FileDialog/RegexpFilterTest/RegexpFilterTest.html +++ b/jdk/test/java/awt/FileDialog/RegexpFilterTest/RegexpFilterTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2007 Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.html b/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.html index 561e780969a..4e514d4a608 100644 --- a/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.html +++ b/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.java b/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.java index 19c2feb4e69..731121439c6 100644 --- a/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.java +++ b/jdk/test/java/awt/FileDialog/SaveFileNameOverrideTest/SaveFileNameOverrideTest.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* test @bug 6998877 diff --git a/jdk/test/java/awt/Focus/6981400/Test1.java b/jdk/test/java/awt/Focus/6981400/Test1.java index 67020639742..ff92c3211b3 100644 --- a/jdk/test/java/awt/Focus/6981400/Test1.java +++ b/jdk/test/java/awt/Focus/6981400/Test1.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/Focus/6981400/Test2.java b/jdk/test/java/awt/Focus/6981400/Test2.java index fc14db23370..db16b601eef 100644 --- a/jdk/test/java/awt/Focus/6981400/Test2.java +++ b/jdk/test/java/awt/Focus/6981400/Test2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/Focus/6981400/Test3.java b/jdk/test/java/awt/Focus/6981400/Test3.java index a4a37b16be7..daf9c9c0888 100644 --- a/jdk/test/java/awt/Focus/6981400/Test3.java +++ b/jdk/test/java/awt/Focus/6981400/Test3.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest.html b/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest.html index bb07d59a736..09199a78f39 100644 --- a/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest.html +++ b/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.html b/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.html index dc094e1a556..24d72f9b4cb 100644 --- a/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.html +++ b/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.java b/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.java index 2f7e8f92304..0cfb6268ec8 100644 --- a/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.java +++ b/jdk/test/java/awt/Focus/AppletInitialFocusTest/AppletInitialFocusTest1.java @@ -1,11 +1,25 @@ /* - test %W% %E% - @bug 4411534 4517274 - @summary ensures that user's requestFocus() during applet initialization - is not ignored. - @author prs@sparc.spb.su area=appletviewer - @run shell AppletInitialFocusTest1.sh -*/ + * Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ import java.applet.Applet; import java.awt.*; diff --git a/jdk/test/java/awt/Focus/DeiconifiedFrameLoosesFocus/DeiconifiedFrameLoosesFocus.html b/jdk/test/java/awt/Focus/DeiconifiedFrameLoosesFocus/DeiconifiedFrameLoosesFocus.html index 18a7444ae0a..12c419f73be 100644 --- a/jdk/test/java/awt/Focus/DeiconifiedFrameLoosesFocus/DeiconifiedFrameLoosesFocus.html +++ b/jdk/test/java/awt/Focus/DeiconifiedFrameLoosesFocus/DeiconifiedFrameLoosesFocus.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2006, 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Focus/FocusOwnerFrameOnClick/FocusOwnerFrameOnClick.java b/jdk/test/java/awt/Focus/FocusOwnerFrameOnClick/FocusOwnerFrameOnClick.java index 6c13b37aa0d..3cb18d6e68d 100644 --- a/jdk/test/java/awt/Focus/FocusOwnerFrameOnClick/FocusOwnerFrameOnClick.java +++ b/jdk/test/java/awt/Focus/FocusOwnerFrameOnClick/FocusOwnerFrameOnClick.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP.java b/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP.java index 44cf627ba51..ff921a7c05c 100644 --- a/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP.java +++ b/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test @bug 7125044 diff --git a/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_AWT.java b/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_AWT.java index b22117a1dec..98e6cb3739a 100644 --- a/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_AWT.java +++ b/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_AWT.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @bug 7125044 @summary Tests default focus traversal policy in AWT toplevel windows. diff --git a/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_Swing.java b/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_Swing.java index ab756220b6b..f3a3b4fdd7d 100644 --- a/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_Swing.java +++ b/jdk/test/java/awt/Focus/FocusTraversalPolicy/InitialFTP_Swing.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @bug 7125044 @summary Tests default focus traversal policy in Swing toplevel windows. diff --git a/jdk/test/java/awt/Focus/ModalBlockedStealsFocusTest/ModalBlockedStealsFocusTest.html b/jdk/test/java/awt/Focus/ModalBlockedStealsFocusTest/ModalBlockedStealsFocusTest.html index 2fda942a85c..9b152c9cb72 100644 --- a/jdk/test/java/awt/Focus/ModalBlockedStealsFocusTest/ModalBlockedStealsFocusTest.html +++ b/jdk/test/java/awt/Focus/ModalBlockedStealsFocusTest/ModalBlockedStealsFocusTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2006, 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Focus/ToFrontFocusTest/ToFrontFocus.html b/jdk/test/java/awt/Focus/ToFrontFocusTest/ToFrontFocus.html index cb8b06329ac..51b9daef323 100644 --- a/jdk/test/java/awt/Focus/ToFrontFocusTest/ToFrontFocus.html +++ b/jdk/test/java/awt/Focus/ToFrontFocusTest/ToFrontFocus.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2002, 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Focus/WindowInitialFocusTest/WindowInitialFocusTest.html b/jdk/test/java/awt/Focus/WindowInitialFocusTest/WindowInitialFocusTest.html index e8efd0c4e93..dc9aab74628 100644 --- a/jdk/test/java/awt/Focus/WindowInitialFocusTest/WindowInitialFocusTest.html +++ b/jdk/test/java/awt/Focus/WindowInitialFocusTest/WindowInitialFocusTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2006, 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Frame/FrameSetSizeStressTest/FrameSetSizeStressTest.java b/jdk/test/java/awt/Frame/FrameSetSizeStressTest/FrameSetSizeStressTest.java index 9a3b2f06f5e..2f8169e31af 100644 --- a/jdk/test/java/awt/Frame/FrameSetSizeStressTest/FrameSetSizeStressTest.java +++ b/jdk/test/java/awt/Frame/FrameSetSizeStressTest/FrameSetSizeStressTest.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/Frame/InitialMaximizedTest/InitialMaximizedTest.html b/jdk/test/java/awt/Frame/InitialMaximizedTest/InitialMaximizedTest.html index 08a41f0e4f9..4aab27754d4 100644 --- a/jdk/test/java/awt/Frame/InitialMaximizedTest/InitialMaximizedTest.html +++ b/jdk/test/java/awt/Frame/InitialMaximizedTest/InitialMaximizedTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2003, 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Frame/ShownOnPack/ShownOnPack.html b/jdk/test/java/awt/Frame/ShownOnPack/ShownOnPack.html index f6e330d0cc0..f406898c84a 100644 --- a/jdk/test/java/awt/Frame/ShownOnPack/ShownOnPack.html +++ b/jdk/test/java/awt/Frame/ShownOnPack/ShownOnPack.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <!-- @test diff --git a/jdk/test/java/awt/Graphics/DrawImageBG/SystemBgColorTest.java b/jdk/test/java/awt/Graphics/DrawImageBG/SystemBgColorTest.java index 0883b298089..2d042eaff43 100644 --- a/jdk/test/java/awt/Graphics/DrawImageBG/SystemBgColorTest.java +++ b/jdk/test/java/awt/Graphics/DrawImageBG/SystemBgColorTest.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2007, 2009, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* * @test * @bug 4614845 diff --git a/jdk/test/java/awt/Graphics2D/FillTexturePaint/FillTexturePaint.java b/jdk/test/java/awt/Graphics2D/FillTexturePaint/FillTexturePaint.java index 2bcf35d5ba9..78cd398c12f 100644 --- a/jdk/test/java/awt/Graphics2D/FillTexturePaint/FillTexturePaint.java +++ b/jdk/test/java/awt/Graphics2D/FillTexturePaint/FillTexturePaint.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/InputMethods/InputMethodsTest/InputMethodsTest.html b/jdk/test/java/awt/InputMethods/InputMethodsTest/InputMethodsTest.html index b92e6c738c0..1d24a3523b5 100644 --- a/jdk/test/java/awt/InputMethods/InputMethodsTest/InputMethodsTest.html +++ b/jdk/test/java/awt/InputMethods/InputMethodsTest/InputMethodsTest.html @@ -1,3 +1,26 @@ +<!-- + Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + + This code is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License version 2 only, as + published by the Free Software Foundation. + + This code is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + version 2 for more details (a copy is included in the LICENSE file that + accompanied this code). + + You should have received a copy of the GNU General Public License version + 2 along with this work; if not, write to the Free Software Foundation, + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + or visit www.oracle.com if you need additional information or have any + questions. +--> + <html> <head> <title> InputMethodsTest diff --git a/jdk/test/java/awt/JAWT/JAWT.sh b/jdk/test/java/awt/JAWT/JAWT.sh index 70ff02b8fe9..48182d437b7 100644 --- a/jdk/test/java/awt/JAWT/JAWT.sh +++ b/jdk/test/java/awt/JAWT/JAWT.sh @@ -5,9 +5,7 @@ # # This code is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License version 2 only, as -# published by the Free Software Foundation. Oracle designates this -# particular file as subject to the "Classpath" exception as provided -# by Oracle in the LICENSE file that accompanied this code. +# published by the Free Software Foundation. # # This code is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/JAWT/Makefile.cygwin b/jdk/test/java/awt/JAWT/Makefile.cygwin index 326d58179fb..1ca22849c4e 100644 --- a/jdk/test/java/awt/JAWT/Makefile.cygwin +++ b/jdk/test/java/awt/JAWT/Makefile.cygwin @@ -3,9 +3,7 @@ # # This code is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License version 2 only, as -# published by the Free Software Foundation. Oracle designates this -# particular file as subject to the "Classpath" exception as provided -# by Oracle in the LICENSE file that accompanied this code. +# published by the Free Software Foundation. # # This code is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/JAWT/Makefile.unix b/jdk/test/java/awt/JAWT/Makefile.unix index 2b3f47cb60f..00cf78e49f1 100644 --- a/jdk/test/java/awt/JAWT/Makefile.unix +++ b/jdk/test/java/awt/JAWT/Makefile.unix @@ -3,9 +3,7 @@ # # This code is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License version 2 only, as -# published by the Free Software Foundation. Oracle designates this -# particular file as subject to the "Classpath" exception as provided -# by Oracle in the LICENSE file that accompanied this code. +# published by the Free Software Foundation. # # This code is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/JAWT/Makefile.win b/jdk/test/java/awt/JAWT/Makefile.win index 327fb250183..909f4f57361 100644 --- a/jdk/test/java/awt/JAWT/Makefile.win +++ b/jdk/test/java/awt/JAWT/Makefile.win @@ -3,9 +3,7 @@ # # This code is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License version 2 only, as -# published by the Free Software Foundation. Oracle designates this -# particular file as subject to the "Classpath" exception as provided -# by Oracle in the LICENSE file that accompanied this code. +# published by the Free Software Foundation. # # This code is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/JAWT/MyCanvas.java b/jdk/test/java/awt/JAWT/MyCanvas.java index 4bf0741cb94..424e3f10c16 100644 --- a/jdk/test/java/awt/JAWT/MyCanvas.java +++ b/jdk/test/java/awt/JAWT/MyCanvas.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/JAWT/myfile.c b/jdk/test/java/awt/JAWT/myfile.c index 1a1028965b1..890a4b5eb53 100644 --- a/jdk/test/java/awt/JAWT/myfile.c +++ b/jdk/test/java/awt/JAWT/myfile.c @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/JAWT/myfile.cpp b/jdk/test/java/awt/JAWT/myfile.cpp index fc5b278abb4..eb8b0a777ef 100644 --- a/jdk/test/java/awt/JAWT/myfile.cpp +++ b/jdk/test/java/awt/JAWT/myfile.cpp @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_AWT.java b/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_AWT.java index 34b52f0bea0..eef8f3cdb18 100644 --- a/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_AWT.java +++ b/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_AWT.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test @bug 6741526 diff --git a/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_Swing.java b/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_Swing.java index f0680433644..adbafb1178b 100644 --- a/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_Swing.java +++ b/jdk/test/java/awt/KeyboardFocusmanager/DefaultPolicyChange/DefaultPolicyChange_Swing.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test @bug 6741526 diff --git a/jdk/test/java/awt/KeyboardFocusmanager/TypeAhead/ButtonActionKeyTest/ButtonActionKeyTest.html b/jdk/test/java/awt/KeyboardFocusmanager/TypeAhead/ButtonActionKeyTest/ButtonActionKeyTest.html index c1326d3b297..f6adef40ded 100644 --- a/jdk/test/java/awt/KeyboardFocusmanager/TypeAhead/ButtonActionKeyTest/ButtonActionKeyTest.html +++ b/jdk/test/java/awt/KeyboardFocusmanager/TypeAhead/ButtonActionKeyTest/ButtonActionKeyTest.html @@ -1,3 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Please run this test case under Solaris cjk locale with inputmethod support, if you could input Chinese/Japanese/Korean in the swing diff --git a/jdk/test/java/awt/image/BufferedImage/TinyScale.java b/jdk/test/java/awt/image/BufferedImage/TinyScale.java index 83a5dbcccae..e4c913e04fa 100644 --- a/jdk/test/java/awt/image/BufferedImage/TinyScale.java +++ b/jdk/test/java/awt/image/BufferedImage/TinyScale.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* * @test %W% %E% * @bug 7016495 diff --git a/jdk/test/java/awt/image/DrawImage/EABlitTest.java b/jdk/test/java/awt/image/DrawImage/EABlitTest.java index 6240ce716d6..023a2e79ec6 100644 --- a/jdk/test/java/awt/image/DrawImage/EABlitTest.java +++ b/jdk/test/java/awt/image/DrawImage/EABlitTest.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/print/PrinterJob/CustomPrintService/PrintServiceStub.java b/jdk/test/java/awt/print/PrinterJob/CustomPrintService/PrintServiceStub.java index c430959c42b..de409b0d121 100644 --- a/jdk/test/java/awt/print/PrinterJob/CustomPrintService/PrintServiceStub.java +++ b/jdk/test/java/awt/print/PrinterJob/CustomPrintService/PrintServiceStub.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/print/PrinterJob/CustomPrintService/SetPrintServiceTest.java b/jdk/test/java/awt/print/PrinterJob/CustomPrintService/SetPrintServiceTest.java index a6bc7ff9877..9c3ebe7d921 100644 --- a/jdk/test/java/awt/print/PrinterJob/CustomPrintService/SetPrintServiceTest.java +++ b/jdk/test/java/awt/print/PrinterJob/CustomPrintService/SetPrintServiceTest.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/java/awt/print/bug8023392/bug8023392.html b/jdk/test/java/awt/print/bug8023392/bug8023392.html index d796a21c660..af6951249c5 100644 --- a/jdk/test/java/awt/print/bug8023392/bug8023392.html +++ b/jdk/test/java/awt/print/bug8023392/bug8023392.html @@ -1,3 +1,26 @@ + + + APL diff --git a/jdk/test/javax/sound/midi/File/SMPTESequence.java b/jdk/test/javax/sound/midi/File/SMPTESequence.java index 729c7ec0618..90e92c272e0 100644 --- a/jdk/test/javax/sound/midi/File/SMPTESequence.java +++ b/jdk/test/javax/sound/midi/File/SMPTESequence.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /** * @test * @bug 6835393 diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/GetFormat.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/GetFormat.java index dd447bd0326..295936dece0 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/GetFormat.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/GetFormat.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/ToFloatArray.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/ToFloatArray.java index 62bf3677ded..ce252319ab1 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/ToFloatArray.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatConverter/ToFloatArray.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatFormatConverter/SkipTest.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatFormatConverter/SkipTest.java index 43fc8566d74..8a893c025f5 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatFormatConverter/SkipTest.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatFormatConverter/SkipTest.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Available.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Available.java index 6b1e0ab620d..961f61424be 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Available.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Available.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Close.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Close.java index a7b0fd12436..bc16d204013 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Close.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Close.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFormat.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFormat.java index 72f56563671..2e4e8023fdd 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFormat.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFormat.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFrameLength.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFrameLength.java index 4eed7f55dcc..48b2958c806 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFrameLength.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/GetFrameLength.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/MarkSupported.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/MarkSupported.java index 107d06e0887..9107be30f5d 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/MarkSupported.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/MarkSupported.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Read.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Read.java index 0fdcfae167f..5d12feef3f2 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Read.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Read.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArray.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArray.java index 941660d76dd..7f7e4fd5a67 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArray.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArray.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArrayIntInt.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArrayIntInt.java index bc43606bcd2..44c45f3428f 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArrayIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/ReadFloatArrayIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Reset.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Reset.java index 877a9b35279..549046648a4 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Reset.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Reset.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Skip.java b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Skip.java index f0b7c0d0068..c57994abfb9 100644 --- a/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Skip.java +++ b/jdk/test/javax/sound/midi/Gervill/AudioFloatInputStream/Skip.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankFile.java b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankFile.java index 25cd53f121a..35986db0cee 100644 --- a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankFile.java +++ b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankFile.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream.java b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream.java index 56edf7a72f5..1e9dc8f0b72 100644 --- a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream.java +++ b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream2.java b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream2.java index e2429a6a3a2..29c8a6a4d8c 100644 --- a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream2.java +++ b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankInputStream2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankUrl.java b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankUrl.java index 0ab06c93495..5e256adf5b1 100644 --- a/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankUrl.java +++ b/jdk/test/javax/sound/midi/Gervill/DLSSoundbankReader/TestGetSoundbankUrl.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/EmergencySoundbank/TestCreateSoundbank.java b/jdk/test/javax/sound/midi/Gervill/EmergencySoundbank/TestCreateSoundbank.java index a87989f1264..47ed64b2180 100644 --- a/jdk/test/javax/sound/midi/Gervill/EmergencySoundbank/TestCreateSoundbank.java +++ b/jdk/test/javax/sound/midi/Gervill/EmergencySoundbank/TestCreateSoundbank.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetInputStream.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetInputStream.java index 8351d26e1e1..be4460e8742 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetInputStream.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetInputStream.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetRoot.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetRoot.java index 8411d1e530f..59c98d8c76a 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetRoot.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/GetRoot.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Load.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Load.java index 6021b046c52..4616a6c7ae8 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Load.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Load.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/LoadAll.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/LoadAll.java index 0b960654071..bc9f1054f9b 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/LoadAll.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/LoadAll.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArray.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArray.java index 6ebcfec2c3c..f738e11c3fc 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArray.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArray.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArrayIntInt.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArrayIntInt.java index 012a683cb5e..b28fd187e43 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArrayIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferByteArrayIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFile.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFile.java index ec231f26ddc..a97790a4970 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFile.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFile.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFileLongLong.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFileLongLong.java index 5b70b259790..622e52b2480 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFileLongLong.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/NewModelByteBufferFileLongLong.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Available.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Available.java index c396c242554..e205fafbd68 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Available.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Available.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Close.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Close.java index 1b660190552..a736c36f2b6 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Close.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Close.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkReset.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkReset.java index 6174ef7b817..a0db7a539c8 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkReset.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkReset.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkSupported.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkSupported.java index 489f4697def..22c87622dce 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkSupported.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/MarkSupported.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Read.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Read.java index 3ccb38ba546..b8552dbd5e6 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Read.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Read.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByte.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByte.java index 45354d1925f..4c6cbfaa52a 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByte.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByte.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByteIntInt.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByteIntInt.java index d35ab30e576..ffcad72d048 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByteIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/ReadByteIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Skip.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Skip.java index 111139eaf8d..241dc2eab07 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Skip.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/RandomFileInputStream/Skip.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLong.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLong.java index 3bdcb6b0597..f9953702a58 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLong.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLong.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLong.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLong.java index 1f2e2408be9..810f7381469 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLong.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLong.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLongBoolean.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLongBoolean.java index e4e4d248602..81d5943a060 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLongBoolean.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/SubbufferLongLongBoolean.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Unload.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Unload.java index 0920536ae1b..c84ac8f7df6 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Unload.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/Unload.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/WriteTo.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/WriteTo.java index 8322e3ce871..b7f21de66d6 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/WriteTo.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBuffer/WriteTo.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetAttenuation.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetAttenuation.java index bd15592c690..291d056b89a 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetAttenuation.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetAttenuation.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetChannels.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetChannels.java index 3d80c81e639..8040209d8e7 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetChannels.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetChannels.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopLength.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopLength.java index c5cbab478b0..7b112f65f85 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopLength.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopLength.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopStart.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopStart.java index 6396a86d3b2..b7f8b7b8949 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopStart.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetLoopStart.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetPitchCorrection.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetPitchCorrection.java index 5c894d234d1..9a341f672ec 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetPitchCorrection.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/GetPitchCorrection.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBuffer.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBuffer.java index 778c65fad28..61ab944d978 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBuffer.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBuffer.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormat.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormat.java index c10f1ce7fbd..6bc66d25675 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormat.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormat.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormatFloat.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormatFloat.java index c514574d210..93954caa535 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormatFloat.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferAudioFormatFloat.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferFloat.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferFloat.java index 058386e7fa2..ca296af7596 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferFloat.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/NewModelByteBufferWavetableModelByteBufferFloat.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Open.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Open.java index cae0499ab7e..7cc92068ac8 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Open.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Open.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/OpenStream.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/OpenStream.java index d339c4c6140..1b20e5d2fcc 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/OpenStream.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/OpenStream.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Set8BitExtensionBuffer.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Set8BitExtensionBuffer.java index f2bbf7f18bf..6b7bf361582 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Set8BitExtensionBuffer.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/Set8BitExtensionBuffer.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/SetLoopType.java b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/SetLoopType.java index d3cd04dded5..496b4093983 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/SetLoopType.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelByteBufferWavetable/SetLoopType.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestination.java b/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestination.java index 034f9a61efe..e541233367d 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestination.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestination.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestinationModelIdentifier.java b/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestinationModelIdentifier.java index 3de59e91332..3a0af9fc956 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestinationModelIdentifier.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelDestination/NewModelDestinationModelIdentifier.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetIdentifier.java b/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetIdentifier.java index 49330cc6dbd..30172c2d2ee 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetIdentifier.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetIdentifier.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetTransform.java b/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetTransform.java index d85f2b5db25..8105dd4457c 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetTransform.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelDestination/SetTransform.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/EqualsObject.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/EqualsObject.java index 8c4496b2a48..81b9eff7e77 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/EqualsObject.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/EqualsObject.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierString.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierString.java index bc0564b6872..33765d347a5 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierString.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierString.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringInt.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringInt.java index 713ebc768c0..152c46dfa12 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringInt.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringString.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringString.java index 848da91e275..d297b6034f6 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringString.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringString.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringStringInt.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringStringInt.java index 49c2cc90237..5400be64265 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringStringInt.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/NewModelIdentifierStringStringInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetInstance.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetInstance.java index eb15aa21b31..a9c893723c3 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetInstance.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetInstance.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetObject.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetObject.java index 7d88fef4f04..e06c2794860 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetObject.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetObject.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetVariable.java b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetVariable.java index f120aa6c157..0871a2af304 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetVariable.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelIdentifier/SetVariable.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/GetOscillators.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/GetOscillators.java index 6aeb50ddd19..2923a540052 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/GetOscillators.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/GetOscillators.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetConnectionBlocks.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetConnectionBlocks.java index b27baa40d1d..d3936b967fe 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetConnectionBlocks.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetConnectionBlocks.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetDefaultConnectionsEnabled.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetDefaultConnectionsEnabled.java index 23b45434880..901ba98a246 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetDefaultConnectionsEnabled.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetDefaultConnectionsEnabled.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetExclusiveClass.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetExclusiveClass.java index c00229a555d..85d95cbc37d 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetExclusiveClass.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetExclusiveClass.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyFrom.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyFrom.java index edd56350f09..7c5e7a3d4e7 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyFrom.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyFrom.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyTo.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyTo.java index ff58b5adc96..ab3b052fb89 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyTo.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetKeyTo.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetName.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetName.java index ed9c4513c73..012e8dfcefa 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetName.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetName.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetSelfNonExclusive.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetSelfNonExclusive.java index 590af2e54ff..bb045a85eca 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetSelfNonExclusive.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetSelfNonExclusive.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelFrom.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelFrom.java index a5ed10b62ed..9c865724c31 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelFrom.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelFrom.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelTo.java b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelTo.java index 5e60899af2f..234c23d42a5 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelTo.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelPerformer/SetVelTo.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSource.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSource.java index da92d88a463..6c2f3b68b82 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSource.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSource.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifier.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifier.java index db44773e2b0..3287a690ca5 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifier.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifier.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBoolean.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBoolean.java index dfa21f7a5d7..88e9c70c85c 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBoolean.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBoolean.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBoolean.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBoolean.java index 6307a9b8af5..628e0a4a35e 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBoolean.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBoolean.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBooleanInt.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBooleanInt.java index b75bab51b36..9742d87d5cc 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBooleanInt.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierBooleanBooleanInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierModelTransform.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierModelTransform.java index 3bece3264fd..f8c33db9e8e 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierModelTransform.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/NewModelSourceModelIdentifierModelTransform.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/SetIdentifier.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/SetIdentifier.java index a4202387340..5f1095af1a6 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/SetIdentifier.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/SetIdentifier.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelSource/SetTransform.java b/jdk/test/javax/sound/midi/Gervill/ModelSource/SetTransform.java index 6def6a5ae5c..878ad895d8c 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelSource/SetTransform.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelSource/SetTransform.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardIndexedDirector/ModelStandardIndexedDirectorTest.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardIndexedDirector/ModelStandardIndexedDirectorTest.java index f48b1eac2c3..ff058a11bbc 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardIndexedDirector/ModelStandardIndexedDirectorTest.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardIndexedDirector/ModelStandardIndexedDirectorTest.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransform.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransform.java index 69e03f055ae..16a410ea984 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransform.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransform.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBoolean.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBoolean.java index e44c49b2428..e77e12ca75a 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBoolean.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBoolean.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBoolean.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBoolean.java index 5b1139e40a2..e162c3bcf1f 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBoolean.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBoolean.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBooleanInt.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBooleanInt.java index 2cd0e95892c..e1ff002bc17 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBooleanInt.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/NewModelStandardTransformBooleanBooleanInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetDirection.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetDirection.java index b66ca79e2a5..d3d1ca1df63 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetDirection.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetDirection.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetPolarity.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetPolarity.java index d7c5ec0c0a3..d711d984d3d 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetPolarity.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetPolarity.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetTransform.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetTransform.java index 9cc7d8a29cc..bb7272f7656 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetTransform.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/SetTransform.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformAbsolute.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformAbsolute.java index 96edd8f304e..165dccf83f4 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformAbsolute.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformAbsolute.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConcave.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConcave.java index a631ed73b9e..5a4026f2b57 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConcave.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConcave.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConvex.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConvex.java index 85fab737bab..84da289158f 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConvex.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformConvex.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformLinear.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformLinear.java index 44e6c9fb875..3f82bdee5c1 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformLinear.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformLinear.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformSwitch.java b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformSwitch.java index fe990558a25..4a249783c21 100644 --- a/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformSwitch.java +++ b/jdk/test/javax/sound/midi/Gervill/ModelStandardTransform/TransformSwitch.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Available.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Available.java index 96b041602ef..d304baf39b1 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Available.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Available.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Close.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Close.java index 2d0ff96184e..dff191d66a5 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Close.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Close.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetFilePointer.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetFilePointer.java index bd1d3c81e45..11e27c17392 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetFilePointer.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetFilePointer.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetSize.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetSize.java index 2b962916957..117e00da8b0 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetSize.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/GetSize.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/HasNextChunk.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/HasNextChunk.java index be40f516b1e..d2738d05d7a 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/HasNextChunk.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/HasNextChunk.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Read.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Read.java index 7901f21b752..f69b9e753d4 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Read.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Read.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByte.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByte.java index ad539885a21..542d2d21751 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByte.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByte.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByteArrayIntInt.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByteArrayIntInt.java index 51a8e19c96c..1b8600dfb22 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByteArrayIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadByteArrayIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadInt.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadInt.java index 05f9baee918..c03c8a6accd 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadInt.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadLong.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadLong.java index a772b4812f6..d428726cfb6 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadLong.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadLong.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadShort.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadShort.java index 4be89cbaef5..8c7977d57d3 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadShort.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadShort.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadString.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadString.java index 851b31570c2..16fcf7d26b8 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadString.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadString.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedByte.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedByte.java index 0c678b647e6..220ac748fff 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedByte.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedByte.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedInt.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedInt.java index 55ac91dd87b..253b32a7eca 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedInt.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedShort.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedShort.java index 5197957bec9..aadd38855a3 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedShort.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/ReadUnsignedShort.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Skip.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Skip.java index 48847a1cdb1..ef8997788bc 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Skip.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/Skip.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/WriteOutputStream.java b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/WriteOutputStream.java index 647b7bc8321..800190a2adc 100644 --- a/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/WriteOutputStream.java +++ b/jdk/test/javax/sound/midi/Gervill/RiffReaderWriter/WriteOutputStream.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankFile.java b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankFile.java index 87f95e2d8c9..12a64e659ae 100644 --- a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankFile.java +++ b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankFile.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream.java b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream.java index ebd16c737e8..ae56ddf7ade 100644 --- a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream.java +++ b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream2.java b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream2.java index b8862451147..d7852a16c5d 100644 --- a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream2.java +++ b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankInputStream2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankUrl.java b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankUrl.java index 28c602c938c..e8bfb7a8a79 100644 --- a/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankUrl.java +++ b/jdk/test/javax/sound/midi/Gervill/SF2SoundbankReader/TestGetSoundbankUrl.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrument.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrument.java index d96afe354a7..cbe5723bbcc 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrument.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrument.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntInt.java index 36968a8bec3..61194cd3405 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntInt.java index aec0638d024..0cc88daa696 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntIntInt.java index 1c7cd0986f6..53a852e0ac0 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelInstrumentIntIntIntIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformer.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformer.java index ccb94aa6733..e06f1cac147 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformer.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformer.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArray.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArray.java index a3b6c45670c..b2661eb101b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArray.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArray.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntInt.java index 11c146d510e..3ca515538dc 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntInt.java index a71f95c7449..7f824b407e8 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntIntInt.java index fd3154e31a7..5dbe2aa9585 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerArrayIntIntIntIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntInt.java index 2c18e9cdb3d..e4e0e79eafd 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntInt.java index 5b3aa6b1f05..6e5dc09d295 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntIntInt.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntIntInt.java index 4b7de7566fe..ebbf8d7b0d8 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntIntInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/AddModelPerformerIntIntIntIntInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/Clear.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/Clear.java index 1cf77dd9e59..9d02439985a 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/Clear.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/Clear.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetName.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetName.java index f3b516b7305..46065f902a5 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetName.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetName.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetPatch.java b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetPatch.java index 03698924451..4ccd828734a 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetPatch.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleInstrument/SetPatch.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddInstrument.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddInstrument.java index a775bbc2781..8609e0bf0ad 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddInstrument.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddInstrument.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddResource.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddResource.java index f6dfcea56b4..f704eba49c5 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddResource.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/AddResource.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/GetInstrument.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/GetInstrument.java index c5e6b2efcd0..56058a7bca5 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/GetInstrument.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/GetInstrument.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/RemoveInstrument.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/RemoveInstrument.java index 4a6644f8d9b..1f7bdef622e 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/RemoveInstrument.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/RemoveInstrument.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetDescription.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetDescription.java index 2ad359f3fac..cad358e1f9c 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetDescription.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetDescription.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetName.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetName.java index b1ddb8cb8ed..7179f49c526 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetName.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetName.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVendor.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVendor.java index 3a4a18ce48b..f703f2e1683 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVendor.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVendor.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVersion.java b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVersion.java index 11c9613d062..dac2e3366dd 100644 --- a/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVersion.java +++ b/jdk/test/javax/sound/midi/Gervill/SimpleSoundbank/SetVersion.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Array.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Array.java index 5cd7a5cdcdb..254b09c88b4 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Array.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Array.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Clear.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Clear.java index 44107589ae8..fea3a484aa4 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Clear.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Clear.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Get.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Get.java index 0f4482a52b2..fc5cc5ec490 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Get.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/Get.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/NewSoftAudioBuffer.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/NewSoftAudioBuffer.java index e0b63344d01..085ed077e7a 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/NewSoftAudioBuffer.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioBuffer/NewSoftAudioBuffer.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/DummySourceDataLine.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/DummySourceDataLine.java index 4d9c0bc4b38..69d1abf5e88 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/DummySourceDataLine.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/DummySourceDataLine.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetFormat.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetFormat.java index c066f0471f1..4dc0c3b1c16 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetFormat.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetFormat.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetPropertyInfo.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetPropertyInfo.java index aa1ea2b25b7..217760e18a3 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetPropertyInfo.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/GetPropertyInfo.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/Open.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/Open.java index 9b4bf649f45..1701232bbd7 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/Open.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/Open.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/OpenStream.java b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/OpenStream.java index 7d9e2c56f3d..24aad6c64df 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/OpenStream.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftAudioSynthesizer/OpenStream.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllNotesOff.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllNotesOff.java index 7e656df9b06..312d1defb8c 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllNotesOff.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllNotesOff.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllSoundOff.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllSoundOff.java index 3444242a687..8048363a5f1 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllSoundOff.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/AllSoundOff.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ChannelPressure.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ChannelPressure.java index b9af793d42a..c525777ef28 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ChannelPressure.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ChannelPressure.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Controller.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Controller.java index 588679ab8d7..e9d71302a1e 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Controller.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Controller.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/LocalControl.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/LocalControl.java index 6854663dfd1..b50da281449 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/LocalControl.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/LocalControl.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mono.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mono.java index 54aba6eace2..20fadd9a14e 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mono.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mono.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mute.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mute.java index badefd7da87..c699a0352aa 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mute.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Mute.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff.java index adb8cb9c811..4b74e6bcdc5 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff2.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff2.java index 015178b34c0..48fc37e46f4 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff2.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOff2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOn.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOn.java index 970c00c5763..3cfb55c0ae4 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOn.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOn.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest.java index 392dde27294..78b726806de 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest2.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest2.java index af65174cdc9..fad50bdc739 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest2.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/NoteOverFlowTest2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Omni.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Omni.java index 0247b6e9aa6..963dbfe6025 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Omni.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Omni.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/PitchBend.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/PitchBend.java index 71d39b6663e..46f3e7cb4fb 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/PitchBend.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/PitchBend.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/PolyPressure.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/PolyPressure.java index 72c7bfa7afa..fff782f68fb 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/PolyPressure.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/PolyPressure.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramAndBankChange.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramAndBankChange.java index 68f8f198af5..80d0bd82de7 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramAndBankChange.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramAndBankChange.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramChange.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramChange.java index 29f56cb7661..25040a5efde 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramChange.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ProgramChange.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ResetAllControllers.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ResetAllControllers.java index 28071e4b40f..b2d735fbd4d 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/ResetAllControllers.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/ResetAllControllers.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/SoftTestUtils.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/SoftTestUtils.java index 2e473793519..054e2c10724 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/SoftTestUtils.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/SoftTestUtils.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Solo.java b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Solo.java index c3776bbc6b7..d4951fbf27a 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftChannel/Solo.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftChannel/Solo.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftCubicResampler/Interpolate.java b/jdk/test/javax/sound/midi/Gervill/SoftCubicResampler/Interpolate.java index 7f34b003863..42737ad9c48 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftCubicResampler/Interpolate.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftCubicResampler/Interpolate.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftFilter/TestProcessAudio.java b/jdk/test/javax/sound/midi/Gervill/SoftFilter/TestProcessAudio.java index 24a8600f058..d38686e960b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftFilter/TestProcessAudio.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftFilter/TestProcessAudio.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLanczosResampler/Interpolate.java b/jdk/test/javax/sound/midi/Gervill/SoftLanczosResampler/Interpolate.java index c925c8a7fdf..4b608207eba 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLanczosResampler/Interpolate.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLanczosResampler/Interpolate.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix.java index 499132a807e..341d7f324ca 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono.java index eec1f037c48..91f2384d286 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono_overdrive.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono_overdrive.java index 946a14c07f2..c32d06e64bb 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono_overdrive.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_mono_overdrive.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_overdrive.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_overdrive.java index a605678e06c..b97151e29ed 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_overdrive.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_mix_overdrive.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal.java index cc96a639666..7292ddbbe6c 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal_mono.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal_mono.java index ad80e8e03d3..61e2c017fc5 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal_mono.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_normal_mono.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive.java index 76951b797a5..82f8d616c67 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive_mono.java b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive_mono.java index 4a6646d8d85..b3eb680507a 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive_mono.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLimiter/ProcessAudio_replace_overdrive_mono.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler/Interpolate.java b/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler/Interpolate.java index e8b1c75f50c..a36a0ea073c 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler/Interpolate.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler/Interpolate.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler2/Interpolate.java b/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler2/Interpolate.java index 13f84ea7881..3477dbc0b9a 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler2/Interpolate.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLinearResampler2/Interpolate.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftLowFrequencyOscillator/TestProcessControlLogic.java b/jdk/test/javax/sound/midi/Gervill/SoftLowFrequencyOscillator/TestProcessControlLogic.java index bfa907bc05c..f445c181ff1 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftLowFrequencyOscillator/TestProcessControlLogic.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftLowFrequencyOscillator/TestProcessControlLogic.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftPointResampler/Interpolate.java b/jdk/test/javax/sound/midi/Gervill/SoftPointResampler/Interpolate.java index e99c6132210..ccd87a46b6e 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftPointResampler/Interpolate.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftPointResampler/Interpolate.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftProvider/GetDevice.java b/jdk/test/javax/sound/midi/Gervill/SoftProvider/GetDevice.java index 1203ba500ac..fa38b029f80 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftProvider/GetDevice.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftProvider/GetDevice.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Close.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Close.java index 9c84f91666c..15bb6aa9347 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Close.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Close.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/GetMidiDevice.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/GetMidiDevice.java index 7fe77c6e989..53a0a650e82 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/GetMidiDevice.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/GetMidiDevice.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ActiveSense.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ActiveSense.java index 4d06db7313a..64e4e4ac546 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ActiveSense.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ActiveSense.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllNotesOff.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllNotesOff.java index c96148e16ed..fe618e3d5c6 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllNotesOff.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllNotesOff.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllSoundOff.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllSoundOff.java index 693522aa582..9d43ddf502b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllSoundOff.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_AllSoundOff.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ChannelPressure.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ChannelPressure.java index 1a1b60369ae..3b49de04549 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ChannelPressure.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ChannelPressure.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Controller.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Controller.java index 1d07c05c0da..451a020b444 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Controller.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Controller.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Mono.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Mono.java index 085dafbf192..52bd68d5f79 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Mono.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Mono.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOff.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOff.java index 18f6cc806e8..f89ca351630 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOff.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOff.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn.java index 6599bc3e125..0cc746ebd29 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_AllChannels.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_AllChannels.java index adce7a84602..4114e01ee99 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_AllChannels.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_AllChannels.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Delayed.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Delayed.java index fc2cfcd4c67..24a98da89b0 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Delayed.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Delayed.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Multiple.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Multiple.java index 1664de68fff..af6b1b69ade 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Multiple.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_NoteOn_Multiple.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Omni.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Omni.java index 7cee5c3c20a..6d905e5c005 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Omni.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_Omni.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PitchBend.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PitchBend.java index c3101110391..dc49c2dc32b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PitchBend.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PitchBend.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PolyPressure.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PolyPressure.java index 766dc2841f2..2a7e4b7ccda 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PolyPressure.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_PolyPressure.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ProgramChange.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ProgramChange.java index 2bc5e607a54..3db7533a766 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ProgramChange.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ProgramChange.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ResetAllControllers.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ResetAllControllers.java index 8266af5a042..4fd3180ec18 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ResetAllControllers.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/Send_ResetAllControllers.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/SoftTestUtils.java b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/SoftTestUtils.java index 2e473793519..054e2c10724 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftReceiver/SoftTestUtils.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftReceiver/SoftTestUtils.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSincResampler/Interpolate.java b/jdk/test/javax/sound/midi/Gervill/SoftSincResampler/Interpolate.java index 0232e1c8978..c5215dd3d6b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSincResampler/Interpolate.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSincResampler/Interpolate.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Close.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Close.java index 3f3e04d8a56..8922854cbfa 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Close.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Close.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/DummySourceDataLine.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/DummySourceDataLine.java index 4d9c0bc4b38..69d1abf5e88 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/DummySourceDataLine.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/DummySourceDataLine.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments.java index 1c92123454f..7d02b5cd372 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments2.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments2.java index 20e2360a74e..ebe4569790c 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments2.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetAvailableInstruments2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetChannels.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetChannels.java index c25a916076c..7f5b9ffe979 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetChannels.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetChannels.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDefaultSoundbank.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDefaultSoundbank.java index 719f8886657..413d4551b91 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDefaultSoundbank.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDefaultSoundbank.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDeviceInfo.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDeviceInfo.java index 0755cb2780b..90fde5a335f 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDeviceInfo.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetDeviceInfo.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLatency.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLatency.java index 40e0218563f..fa02ee34103 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLatency.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLatency.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments.java index 28c2e64be33..17af001db19 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments2.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments2.java index 5fa3fb21d86..9a06b3322f9 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments2.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetLoadedInstruments2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxPolyphony.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxPolyphony.java index e72168c615d..35b5e217e52 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxPolyphony.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxPolyphony.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxReceivers.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxReceivers.java index 9b85c07a8c1..6d314f93af3 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxReceivers.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxReceivers.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxTransmitters.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxTransmitters.java index 3865547ce2b..2cfa8997383 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxTransmitters.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMaxTransmitters.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMicrosecondPosition.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMicrosecondPosition.java index 83049993f0f..7d271fdda78 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMicrosecondPosition.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetMicrosecondPosition.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetPropertyInfo.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetPropertyInfo.java index 43c5438bfdd..66f773429d5 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetPropertyInfo.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetPropertyInfo.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver.java index 7959c19b572..f22af997d23 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver2.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver2.java index 09db467ef0e..28c28924f8a 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver2.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceiver2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceivers.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceivers.java index 67927515cd8..c1c9fcce242 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceivers.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetReceivers.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitter.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitter.java index 58dc0002fd3..70e5b6729a8 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitter.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitter.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitters.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitters.java index c765087e6c2..18fbf7567d6 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitters.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetTransmitters.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetVoiceStatus.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetVoiceStatus.java index b26922ff0c8..9dddc7ec472 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetVoiceStatus.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/GetVoiceStatus.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/ImplicitOpenClose.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/ImplicitOpenClose.java index 4c6d7d82305..421c62938e6 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/ImplicitOpenClose.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/ImplicitOpenClose.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsOpen.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsOpen.java index 3b143f6f531..c14be6b6697 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsOpen.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsOpen.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsSoundbankSupported.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsSoundbankSupported.java index 3b73df39f4b..a26f8480abb 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsSoundbankSupported.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/IsSoundbankSupported.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadAllInstruments.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadAllInstruments.java index 0e67c614e5b..0240ef99594 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadAllInstruments.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadAllInstruments.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstrument.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstrument.java index 9333b36bdf8..3b7e9683bd7 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstrument.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstrument.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstruments.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstruments.java index a86f3955dd7..685e53fc212 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstruments.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/LoadInstruments.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Open.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Open.java index 610ce7d278d..6724a3c7c09 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Open.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/Open.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/OpenStream.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/OpenStream.java index 83df50d97db..b10bbc27bbb 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/OpenStream.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/OpenStream.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/RemapInstrument.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/RemapInstrument.java index 64baf2d3f38..c4f08b34b90 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/RemapInstrument.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/RemapInstrument.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestDisableLoadDefaultSoundbank.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestDisableLoadDefaultSoundbank.java index 06c39995398..23b9a696fa3 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestDisableLoadDefaultSoundbank.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestDisableLoadDefaultSoundbank.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestPreciseTimestampRendering.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestPreciseTimestampRendering.java index 26e3e956df1..eee0267fed9 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestPreciseTimestampRendering.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestPreciseTimestampRendering.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestRender1.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestRender1.java index 6ebb9af4752..d7af4bf620b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestRender1.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/TestRender1.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadAllInstruments.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadAllInstruments.java index 70414a251ac..5efdaaf7643 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadAllInstruments.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadAllInstruments.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstrument.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstrument.java index 3a3861cddcd..7f8df6c6338 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstrument.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstrument.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstruments.java b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstruments.java index b34e45a7192..b2b89d8e6f8 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstruments.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftSynthesizer/UnloadInstruments.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetName.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetName.java index ccfcd96f5c0..cb76ccdc182 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetName.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetName.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuning.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuning.java index 0432f391faa..41bdd579a04 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuning.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuning.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuningInt.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuningInt.java index a6f7bc1e5ca..13759f2c3b9 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuningInt.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/GetTuningInt.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load1.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load1.java index ebfd1a18a84..5b5fa3b2e8b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load1.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load1.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load2.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load2.java index f424df62d4c..58e23103014 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load2.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load2.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load4.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load4.java index 7804217adf3..41c194cefdf 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load4.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load4.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load5.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load5.java index c094a145a11..7132a39a7a7 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load5.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load5.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load6.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load6.java index 07ac751b5b7..b53d3a4f835 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load6.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load6.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load7.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load7.java index 4d2cae09ebe..ca90d364072 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load7.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load7.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load8.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load8.java index 0b12b15fa02..731eac0cde3 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load8.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load8.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load9.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load9.java index 1594b33c418..cdbb9e2d31b 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load9.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/Load9.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuning.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuning.java index ba49c1865f1..4b9f0c7dbd6 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuning.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuning.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningByteArray.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningByteArray.java index c8a2bf668a2..b13fff484a4 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningByteArray.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningByteArray.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatch.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatch.java index 8363279a9e5..8fd023fe533 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatch.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatch.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatchByteArray.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatchByteArray.java index 150906240f3..0ae5bc72fef 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatchByteArray.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/NewSoftTuningPatchByteArray.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Gervill/SoftTuning/RealTimeTuning.java b/jdk/test/javax/sound/midi/Gervill/SoftTuning/RealTimeTuning.java index 7b6aaf66d82..df6a7faa235 100644 --- a/jdk/test/javax/sound/midi/Gervill/SoftTuning/RealTimeTuning.java +++ b/jdk/test/javax/sound/midi/Gervill/SoftTuning/RealTimeTuning.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/MidiDeviceConnectors/TestAllDevices.java b/jdk/test/javax/sound/midi/MidiDeviceConnectors/TestAllDevices.java index fa1d964e1df..9155dbb6b32 100644 --- a/jdk/test/javax/sound/midi/MidiDeviceConnectors/TestAllDevices.java +++ b/jdk/test/javax/sound/midi/MidiDeviceConnectors/TestAllDevices.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/midi/Sequencer/SequencerImplicitSynthOpen.java b/jdk/test/javax/sound/midi/Sequencer/SequencerImplicitSynthOpen.java index f305d331bbc..2b7dc16ea1c 100644 --- a/jdk/test/javax/sound/midi/Sequencer/SequencerImplicitSynthOpen.java +++ b/jdk/test/javax/sound/midi/Sequencer/SequencerImplicitSynthOpen.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /** * @test * @bug 6660470 diff --git a/jdk/test/javax/sound/sampled/AudioFormat/Matches_NOT_SPECIFIED.java b/jdk/test/javax/sound/sampled/AudioFormat/Matches_NOT_SPECIFIED.java index 18e53af2d27..98fdce11072 100644 --- a/jdk/test/javax/sound/sampled/AudioFormat/Matches_NOT_SPECIFIED.java +++ b/jdk/test/javax/sound/sampled/AudioFormat/Matches_NOT_SPECIFIED.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/sampled/AudioFormat/PCM_FLOAT_support.java b/jdk/test/javax/sound/sampled/AudioFormat/PCM_FLOAT_support.java index 637a15354bf..43d39fb8ead 100644 --- a/jdk/test/javax/sound/sampled/AudioFormat/PCM_FLOAT_support.java +++ b/jdk/test/javax/sound/sampled/AudioFormat/PCM_FLOAT_support.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/sampled/Clip/ClipSetPos.java b/jdk/test/javax/sound/sampled/Clip/ClipSetPos.java index 715274fe65f..c98032422e2 100644 --- a/jdk/test/javax/sound/sampled/Clip/ClipSetPos.java +++ b/jdk/test/javax/sound/sampled/Clip/ClipSetPos.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/sampled/DataLine/DataLine_ArrayIndexOutOfBounds.java b/jdk/test/javax/sound/sampled/DataLine/DataLine_ArrayIndexOutOfBounds.java index e8dac311ee1..484bf29aefb 100644 --- a/jdk/test/javax/sound/sampled/DataLine/DataLine_ArrayIndexOutOfBounds.java +++ b/jdk/test/javax/sound/sampled/DataLine/DataLine_ArrayIndexOutOfBounds.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /** * @test * @bug 7088367 diff --git a/jdk/test/javax/sound/sampled/DirectAudio/bug6400879.java b/jdk/test/javax/sound/sampled/DirectAudio/bug6400879.java index 6045d41e20e..033015062d1 100644 --- a/jdk/test/javax/sound/sampled/DirectAudio/bug6400879.java +++ b/jdk/test/javax/sound/sampled/DirectAudio/bug6400879.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/sampled/FileWriter/AlawEncoderSync.java b/jdk/test/javax/sound/sampled/FileWriter/AlawEncoderSync.java index a58fa269f69..b207e0b5898 100644 --- a/jdk/test/javax/sound/sampled/FileWriter/AlawEncoderSync.java +++ b/jdk/test/javax/sound/sampled/FileWriter/AlawEncoderSync.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/sound/sampled/FileWriter/WriterCloseInput.java b/jdk/test/javax/sound/sampled/FileWriter/WriterCloseInput.java index b4197892ea8..d54c8f57d90 100644 --- a/jdk/test/javax/sound/sampled/FileWriter/WriterCloseInput.java +++ b/jdk/test/javax/sound/sampled/FileWriter/WriterCloseInput.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /** * @test * @bug 7013521 diff --git a/jdk/test/javax/swing/JCheckBox/4449413/bug4449413.html b/jdk/test/javax/swing/JCheckBox/4449413/bug4449413.html index cec2ce04678..1bfa618f77f 100644 --- a/jdk/test/javax/swing/JCheckBox/4449413/bug4449413.html +++ b/jdk/test/javax/swing/JCheckBox/4449413/bug4449413.html @@ -1,3 +1,26 @@ + + When the applet starts, you'll see eight controls with black backgrounds. diff --git a/jdk/test/javax/swing/JColorChooser/Test4222508.html b/jdk/test/javax/swing/JColorChooser/Test4222508.html index 4614fb7de47..edbc46666fa 100644 --- a/jdk/test/javax/swing/JColorChooser/Test4222508.html +++ b/jdk/test/javax/swing/JColorChooser/Test4222508.html @@ -1,3 +1,26 @@ + + Use the check box above the color chooser to disable it. diff --git a/jdk/test/javax/swing/JColorChooser/Test4759306.html b/jdk/test/javax/swing/JColorChooser/Test4759306.html index 8a4d53f00e9..670ff449e28 100644 --- a/jdk/test/javax/swing/JColorChooser/Test4759306.html +++ b/jdk/test/javax/swing/JColorChooser/Test4759306.html @@ -1,3 +1,26 @@ + + If you see the preview panel, then test failed, otherwise it passed. diff --git a/jdk/test/javax/swing/JColorChooser/Test4759934.html b/jdk/test/javax/swing/JColorChooser/Test4759934.html index 0441b67ac66..0ffc3a19ee6 100644 --- a/jdk/test/javax/swing/JColorChooser/Test4759934.html +++ b/jdk/test/javax/swing/JColorChooser/Test4759934.html @@ -1,3 +1,26 @@ + + 1. Press button "Show Dialog" at the frame "Test" and diff --git a/jdk/test/javax/swing/JColorChooser/Test4887836.html b/jdk/test/javax/swing/JColorChooser/Test4887836.html index 324d5afe368..af623a59fb3 100644 --- a/jdk/test/javax/swing/JColorChooser/Test4887836.html +++ b/jdk/test/javax/swing/JColorChooser/Test4887836.html @@ -1,3 +1,26 @@ + + If you do not see white area under swatches, diff --git a/jdk/test/javax/swing/JColorChooser/Test6348456.html b/jdk/test/javax/swing/JColorChooser/Test6348456.html index 6829c7810c4..c3b5989b416 100644 --- a/jdk/test/javax/swing/JColorChooser/Test6348456.html +++ b/jdk/test/javax/swing/JColorChooser/Test6348456.html @@ -1,3 +1,26 @@ + + When applet starts, you'll see that the preview is white. diff --git a/jdk/test/javax/swing/JColorChooser/Test6977726.html b/jdk/test/javax/swing/JColorChooser/Test6977726.html index 3b7f33d206b..cfe132aff13 100644 --- a/jdk/test/javax/swing/JColorChooser/Test6977726.html +++ b/jdk/test/javax/swing/JColorChooser/Test6977726.html @@ -1,3 +1,26 @@ + + If you don't see the preview panel, then test failed, otherwise it passed. diff --git a/jdk/test/javax/swing/JComponent/4337267/bug4337267.java b/jdk/test/javax/swing/JComponent/4337267/bug4337267.java index a3e3f24b0ad..1a16be2cd09 100644 --- a/jdk/test/javax/swing/JComponent/4337267/bug4337267.java +++ b/jdk/test/javax/swing/JComponent/4337267/bug4337267.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* * @test * @bug 4337267 diff --git a/jdk/test/javax/swing/JComponent/6683775/bug6683775.java b/jdk/test/javax/swing/JComponent/6683775/bug6683775.java index 02cd32b6524..cb41f7be534 100644 --- a/jdk/test/javax/swing/JComponent/6683775/bug6683775.java +++ b/jdk/test/javax/swing/JComponent/6683775/bug6683775.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test @bug 6683775 6794764 @summary Painting artifacts is seen when panel is made setOpaque(false) for a translucent window diff --git a/jdk/test/javax/swing/JEditorPane/4492274/test.html b/jdk/test/javax/swing/JEditorPane/4492274/test.html index 2186cc326c8..93d04b453e2 100644 --- a/jdk/test/javax/swing/JEditorPane/4492274/test.html +++ b/jdk/test/javax/swing/JEditorPane/4492274/test.html @@ -1,3 +1,26 @@ + + top diff --git a/jdk/test/javax/swing/JEditorPane/6917744/test.html b/jdk/test/javax/swing/JEditorPane/6917744/test.html index 7532c9e9e15..4554b5e37c2 100644 --- a/jdk/test/javax/swing/JEditorPane/6917744/test.html +++ b/jdk/test/javax/swing/JEditorPane/6917744/test.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JEditorPane/bug4714674.java b/jdk/test/javax/swing/JEditorPane/bug4714674.java index a3426144330..5b59833826f 100644 --- a/jdk/test/javax/swing/JEditorPane/bug4714674.java +++ b/jdk/test/javax/swing/JEditorPane/bug4714674.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test @bug 4714674 @summary Tests that JEditorPane opens HTTP connection asynchronously diff --git a/jdk/test/javax/swing/JFileChooser/6570445/bug6570445.java b/jdk/test/javax/swing/JFileChooser/6570445/bug6570445.java index f746edaee54..968c3723430 100644 --- a/jdk/test/javax/swing/JFileChooser/6570445/bug6570445.java +++ b/jdk/test/javax/swing/JFileChooser/6570445/bug6570445.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* * @test * @bug 6570445 diff --git a/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.html b/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.html index 8de6fdd0792..489078715c1 100644 --- a/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.html +++ b/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.java b/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.java index ede1533746d..ecabb8f3696 100644 --- a/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.java +++ b/jdk/test/javax/swing/JFileChooser/6698013/bug6698013.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test %W% %E% @bug 6698013 @summary JFileChooser can no longer navigate non-local file systems. diff --git a/jdk/test/javax/swing/JFileChooser/6798062/bug6798062.html b/jdk/test/javax/swing/JFileChooser/6798062/bug6798062.html index 80a3e1c503d..4ba1a838431 100644 --- a/jdk/test/javax/swing/JFileChooser/6798062/bug6798062.html +++ b/jdk/test/javax/swing/JFileChooser/6798062/bug6798062.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.html b/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.html index 7412f74ed7e..4d822df013c 100644 --- a/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.html +++ b/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.java b/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.java index 24b3b4da074..ce9df572edc 100644 --- a/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.java +++ b/jdk/test/javax/swing/JInternalFrame/6726866/bug6726866.java @@ -1,3 +1,26 @@ +/* + * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + /* @test @bug 6726866 @summary Repainting artifacts when resizing or dragging JInternalFrames in non-opaque toplevel diff --git a/jdk/test/javax/swing/JSlider/4987336/bug4987336.html b/jdk/test/javax/swing/JSlider/4987336/bug4987336.html index b5c9a191f56..a454ae0a273 100644 --- a/jdk/test/javax/swing/JSlider/4987336/bug4987336.html +++ b/jdk/test/javax/swing/JSlider/4987336/bug4987336.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JSlider/6524424/bug6524424.html b/jdk/test/javax/swing/JSlider/6524424/bug6524424.html index ecf8f65df04..a9deef283dd 100644 --- a/jdk/test/javax/swing/JSlider/6524424/bug6524424.html +++ b/jdk/test/javax/swing/JSlider/6524424/bug6524424.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JSlider/6587742/bug6587742.html b/jdk/test/javax/swing/JSlider/6587742/bug6587742.html index ceda9f921c7..694ac88baa7 100644 --- a/jdk/test/javax/swing/JSlider/6587742/bug6587742.html +++ b/jdk/test/javax/swing/JSlider/6587742/bug6587742.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JSlider/6742358/bug6742358.html b/jdk/test/javax/swing/JSlider/6742358/bug6742358.html index d004e116c93..3cace4a1143 100644 --- a/jdk/test/javax/swing/JSlider/6742358/bug6742358.html +++ b/jdk/test/javax/swing/JSlider/6742358/bug6742358.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JTabbedPane/4310381/bug4310381.html b/jdk/test/javax/swing/JTabbedPane/4310381/bug4310381.html index d60643e56e4..325bbfdca5d 100644 --- a/jdk/test/javax/swing/JTabbedPane/4310381/bug4310381.html +++ b/jdk/test/javax/swing/JTabbedPane/4310381/bug4310381.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/swing/JTree/4314199/bug4314199.html b/jdk/test/javax/swing/JTree/4314199/bug4314199.html index b1fb60e4896..94249fa3d1d 100644 --- a/jdk/test/javax/swing/JTree/4314199/bug4314199.html +++ b/jdk/test/javax/swing/JTree/4314199/bug4314199.html @@ -1,3 +1,26 @@ + + Select the last tree node (marked "Here") and click on the menu. diff --git a/jdk/test/javax/swing/SwingUtilities/7170657/bug7170657.java b/jdk/test/javax/swing/SwingUtilities/7170657/bug7170657.java index e28ce7ab9b9..8197b7fcb6a 100644 --- a/jdk/test/javax/swing/SwingUtilities/7170657/bug7170657.java +++ b/jdk/test/javax/swing/SwingUtilities/7170657/bug7170657.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/swing/border/Test4129681.html b/jdk/test/javax/swing/border/Test4129681.html index 4985c4de979..4eee263c83c 100644 --- a/jdk/test/javax/swing/border/Test4129681.html +++ b/jdk/test/javax/swing/border/Test4129681.html @@ -1,3 +1,26 @@ + + When applet starts, you'll see a checkbox and a label with a titled border. diff --git a/jdk/test/javax/swing/border/Test4243289.html b/jdk/test/javax/swing/border/Test4243289.html index 9133d99c582..6aac9af7779 100644 --- a/jdk/test/javax/swing/border/Test4243289.html +++ b/jdk/test/javax/swing/border/Test4243289.html @@ -1,3 +1,26 @@ + + When applet starts, you'll see a panel with a TitledBorder with title "Panel Title". diff --git a/jdk/test/javax/swing/border/Test4247606.html b/jdk/test/javax/swing/border/Test4247606.html index d501ab221d6..7091e2f2020 100644 --- a/jdk/test/javax/swing/border/Test4247606.html +++ b/jdk/test/javax/swing/border/Test4247606.html @@ -1,3 +1,26 @@ + + If the button do not fit into the titled border bounds diff --git a/jdk/test/javax/swing/border/Test4252164.html b/jdk/test/javax/swing/border/Test4252164.html index eb436c53fe3..1a9c1c52921 100644 --- a/jdk/test/javax/swing/border/Test4252164.html +++ b/jdk/test/javax/swing/border/Test4252164.html @@ -1,3 +1,26 @@ + + Please, ensure that rounded border is filled completely. diff --git a/jdk/test/javax/swing/border/Test4760089.html b/jdk/test/javax/swing/border/Test4760089.html index 6963333627e..88441b9e14d 100644 --- a/jdk/test/javax/swing/border/Test4760089.html +++ b/jdk/test/javax/swing/border/Test4760089.html @@ -1,3 +1,26 @@ + + When applet starts, you'll see a panel with a compound titled border. diff --git a/jdk/test/javax/swing/border/Test6910490.html b/jdk/test/javax/swing/border/Test6910490.html index 4358cf471f9..019f975a5fd 100644 --- a/jdk/test/javax/swing/border/Test6910490.html +++ b/jdk/test/javax/swing/border/Test6910490.html @@ -1,3 +1,26 @@ + + If the border is painted over scroll bars then test fails. diff --git a/jdk/test/javax/swing/border/Test7022041.java b/jdk/test/javax/swing/border/Test7022041.java index 1a8b12c7c7a..747c1117ee6 100644 --- a/jdk/test/javax/swing/border/Test7022041.java +++ b/jdk/test/javax/swing/border/Test7022041.java @@ -4,9 +4,7 @@ * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. Oracle designates this - * particular file as subject to the "Classpath" exception as provided - * by Oracle in the LICENSE file that accompanied this code. + * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or diff --git a/jdk/test/javax/swing/text/html/TableView/7030332/bug7030332.html b/jdk/test/javax/swing/text/html/TableView/7030332/bug7030332.html index 9a62f793008..cceb31c9088 100644 --- a/jdk/test/javax/swing/text/html/TableView/7030332/bug7030332.html +++ b/jdk/test/javax/swing/text/html/TableView/7030332/bug7030332.html @@ -1,3 +1,26 @@ + + diff --git a/jdk/test/javax/xml/jaxp/parsers/8022548/XOMParserTest.java b/jdk/test/javax/xml/jaxp/parsers/8022548/XOMParserTest.java index ba12d0ddc86..15915d04912 100644 --- a/jdk/test/javax/xml/jaxp/parsers/8022548/XOMParserTest.java +++ b/jdk/test/javax/xml/jaxp/parsers/8022548/XOMParserTest.java @@ -22,7 +22,8 @@ */ /** - * @test @bug 8022548 + * @test + * @bug 8022548 * @summary test that a parser can use DTDConfiguration * @run main XOMParserTest */ @@ -60,30 +61,27 @@ public class XOMParserTest extends TestBase { } public final void testTransform() { + String inFilename = filePath + "/JDK8022548.xml"; + String xslFilename = filePath + "/JDK8022548.xsl"; + String outFilename = "JDK8022548.out"; - try { + try (InputStream xslInput = new FileInputStream(xslFilename); + InputStream xmlInput = new FileInputStream(inFilename); + OutputStream out = new FileOutputStream(outFilename); + ) { - String inFilename = filePath + "/JDK8022548.xml"; - String xslFilename = filePath + "/JDK8022548.xsl"; - String outFilename = "JDK8022548.out"; StringWriter sw = new StringWriter(); // Create transformer factory TransformerFactory factory = TransformerFactory.newInstance(); - // set the translet name -// factory.setAttribute("translet-name", "myTranslet"); - - // set the destination directory -// factory.setAttribute("destination-directory", "c:\\temp"); -// factory.setAttribute("generate-translet", Boolean.TRUE); // Use the factory to create a template containing the xsl file - Templates template = factory.newTemplates(new StreamSource(new FileInputStream(xslFilename))); + Templates template = factory.newTemplates(new StreamSource(xslInput)); // Use the template to create a transformer Transformer xformer = template.newTransformer(); // Prepare the input and output files - Source source = new StreamSource(new FileInputStream(inFilename)); - Result result = new StreamResult(new FileOutputStream(outFilename)); + Source source = new StreamSource(xmlInput); + Result result = new StreamResult(outFilename); //Result result = new StreamResult(sw); // Apply the xsl file to the source file and write the result to the output file xformer.transform(source, result); diff --git a/jdk/test/lib/testlibrary/AssertsTest.java b/jdk/test/lib/testlibrary/AssertsTest.java new file mode 100644 index 00000000000..e59a2521bfe --- /dev/null +++ b/jdk/test/lib/testlibrary/AssertsTest.java @@ -0,0 +1,237 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +import static jdk.testlibrary.Asserts.*; + +/* @test + * @summary Tests the different assertions in the Assert class + * @library /testlibrary + */ +public class AssertsTest { + private static class Foo implements Comparable { + final int id; + public Foo(int id) { + this.id = id; + } + + public int compareTo(Foo f) { + return new Integer(id).compareTo(new Integer(f.id)); + } + } + + public static void main(String[] args) throws Exception { + testLessThan(); + testLessThanOrEqual(); + testEquals(); + testGreaterThanOrEqual(); + testGreaterThan(); + testNotEquals(); + testNull(); + testNotNull(); + testTrue(); + testFalse(); + } + + private static void testLessThan() throws Exception { + expectPass(Assertion.LT, 1, 2); + + expectFail(Assertion.LT, 2, 2); + expectFail(Assertion.LT, 2, 1); + expectFail(Assertion.LT, null, 2); + expectFail(Assertion.LT, 2, null); + } + + private static void testLessThanOrEqual() throws Exception { + expectPass(Assertion.LTE, 1, 2); + expectPass(Assertion.LTE, 2, 2); + + expectFail(Assertion.LTE, 3, 2); + expectFail(Assertion.LTE, null, 2); + expectFail(Assertion.LTE, 2, null); + } + + private static void testEquals() throws Exception { + expectPass(Assertion.EQ, 1, 1); + expectPass(Assertion.EQ, null, null); + + Foo f1 = new Foo(1); + expectPass(Assertion.EQ, f1, f1); + + Foo f2 = new Foo(1); + expectFail(Assertion.EQ, f1, f2); + expectFail(Assertion.LTE, null, 2); + expectFail(Assertion.LTE, 2, null); + } + + private static void testGreaterThanOrEqual() throws Exception { + expectPass(Assertion.GTE, 1, 1); + expectPass(Assertion.GTE, 2, 1); + + expectFail(Assertion.GTE, 1, 2); + expectFail(Assertion.GTE, null, 2); + expectFail(Assertion.GTE, 2, null); + } + + private static void testGreaterThan() throws Exception { + expectPass(Assertion.GT, 2, 1); + + expectFail(Assertion.GT, 1, 1); + expectFail(Assertion.GT, 1, 2); + expectFail(Assertion.GT, null, 2); + expectFail(Assertion.GT, 2, null); + } + + private static void testNotEquals() throws Exception { + expectPass(Assertion.NE, null, 1); + expectPass(Assertion.NE, 1, null); + + Foo f1 = new Foo(1); + Foo f2 = new Foo(1); + expectPass(Assertion.NE, f1, f2); + + expectFail(Assertion.NE, null, null); + expectFail(Assertion.NE, f1, f1); + expectFail(Assertion.NE, 1, 1); + } + + private static void testNull() throws Exception { + expectPass(Assertion.NULL, null); + + expectFail(Assertion.NULL, 1); + } + + private static void testNotNull() throws Exception { + expectPass(Assertion.NOTNULL, 1); + + expectFail(Assertion.NOTNULL, null); + } + + private static void testTrue() throws Exception { + expectPass(Assertion.TRUE, true); + + expectFail(Assertion.TRUE, false); + } + + private static void testFalse() throws Exception { + expectPass(Assertion.FALSE, false); + + expectFail(Assertion.FALSE, true); + } + + private static > void expectPass(Assertion assertion, T ... args) + throws Exception { + Assertion.run(assertion, args); + } + + private static > void expectFail(Assertion assertion, T ... args) + throws Exception { + try { + Assertion.run(assertion, args); + } catch (RuntimeException e) { + return; + } + throw new Exception("Expected " + Assertion.format(assertion, (Object[]) args) + + " to throw a RuntimeException"); + } + +} + +enum Assertion { + LT, LTE, EQ, GTE, GT, NE, NULL, NOTNULL, FALSE, TRUE; + + public static > void run(Assertion assertion, T ... args) { + String msg = "Expected " + format(assertion, args) + " to pass"; + switch (assertion) { + case LT: + assertLessThan(args[0], args[1], msg); + break; + case LTE: + assertLessThanOrEqual(args[0], args[1], msg); + break; + case EQ: + assertEquals(args[0], args[1], msg); + break; + case GTE: + assertGreaterThanOrEqual(args[0], args[1], msg); + break; + case GT: + assertGreaterThan(args[0], args[1], msg); + break; + case NE: + assertNotEquals(args[0], args[1], msg); + break; + case NULL: + assertNull(args == null ? args : args[0], msg); + break; + case NOTNULL: + assertNotNull(args == null ? args : args[0], msg); + break; + case FALSE: + assertFalse((Boolean) args[0], msg); + break; + case TRUE: + assertTrue((Boolean) args[0], msg); + break; + default: + // do nothing + } + } + + public static String format(Assertion assertion, Object ... args) { + switch (assertion) { + case LT: + return asString("assertLessThan", args); + case LTE: + return asString("assertLessThanOrEqual", args); + case EQ: + return asString("assertEquals", args); + case GTE: + return asString("assertGreaterThanOrEquals", args); + case GT: + return asString("assertGreaterThan", args); + case NE: + return asString("assertNotEquals", args); + case NULL: + return asString("assertNull", args); + case NOTNULL: + return asString("assertNotNull", args); + case FALSE: + return asString("assertFalse", args); + case TRUE: + return asString("assertTrue", args); + default: + return ""; + } + } + + private static String asString(String assertion, Object ... args) { + if (args == null) { + return String.format("%s(null)", assertion); + } + if (args.length == 1) { + return String.format("%s(%s)", assertion, args[0]); + } else { + return String.format("%s(%s, %s)", assertion, args[0], args[1]); + } + } +} diff --git a/jdk/test/lib/testlibrary/ClassFileInstaller.java b/jdk/test/lib/testlibrary/ClassFileInstaller.java index 694223e77f3..dd8777b1ff2 100644 --- a/jdk/test/lib/testlibrary/ClassFileInstaller.java +++ b/jdk/test/lib/testlibrary/ClassFileInstaller.java @@ -45,7 +45,10 @@ public class ClassFileInstaller { // Create the class file's package directory Path p = Paths.get(pathName); - Files.createDirectories(p.getParent()); + Path parent = p.getParent(); + if (parent != null) { + Files.createDirectories(parent); + } // Create the class file Files.copy(is, p, StandardCopyOption.REPLACE_EXISTING); } diff --git a/jdk/test/lib/testlibrary/OutputAnalyzerReportingTest.java b/jdk/test/lib/testlibrary/OutputAnalyzerReportingTest.java new file mode 100644 index 00000000000..daf669e620c --- /dev/null +++ b/jdk/test/lib/testlibrary/OutputAnalyzerReportingTest.java @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + + +/* + * @test + * @summary Test the OutputAnalyzer reporting functionality, + * such as printing additional diagnostic info + * (exit code, stdout, stderr, command line, etc.) + * @library /testlibrary + */ + +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; + +import jdk.testlibrary.OutputAnalyzer; + +public class OutputAnalyzerReportingTest { + + public static void main(String[] args) throws Exception { + // Create the output analyzer under test + String stdout = "aaaaaa"; + String stderr = "bbbbbb"; + OutputAnalyzer output = new OutputAnalyzer(stdout, stderr); + + // Expected summary values should be the same for all cases, + // since the outputAnalyzer object is the same + String expectedExitValue = "-1"; + String expectedSummary = + " stdout: [" + stdout + "];\n" + + " stderr: [" + stderr + "]\n" + + " exitValue = " + expectedExitValue + "\n"; + + + DiagnosticSummaryTestRunner testRunner = + new DiagnosticSummaryTestRunner(); + + // should have exit value + testRunner.init(expectedSummary); + int unexpectedExitValue = 2; + try { + output.shouldHaveExitValue(unexpectedExitValue); + } catch (RuntimeException e) { } + testRunner.closeAndCheckResults(); + + // should not contain + testRunner.init(expectedSummary); + try { + output.shouldNotContain(stdout); + } catch (RuntimeException e) { } + testRunner.closeAndCheckResults(); + + // should contain + testRunner.init(expectedSummary); + try { + output.shouldContain("unexpected-stuff"); + } catch (RuntimeException e) { } + testRunner.closeAndCheckResults(); + + // should not match + testRunner.init(expectedSummary); + try { + output.shouldNotMatch("[a]"); + } catch (RuntimeException e) { } + testRunner.closeAndCheckResults(); + + // should match + testRunner.init(expectedSummary); + try { + output.shouldMatch("[qwerty]"); + } catch (RuntimeException e) { } + testRunner.closeAndCheckResults(); + + } + + private static class DiagnosticSummaryTestRunner { + private ByteArrayOutputStream byteStream = + new ByteArrayOutputStream(10000); + + private String expectedSummary = ""; + private PrintStream errStream; + + + public void init(String expectedSummary) { + this.expectedSummary = expectedSummary; + byteStream.reset(); + errStream = new PrintStream(byteStream); + System.setErr(errStream); + } + + public void closeAndCheckResults() { + // check results + errStream.close(); + String stdErrStr = byteStream.toString(); + if (!stdErrStr.contains(expectedSummary)) { + throw new RuntimeException("The output does not contain " + + "the diagnostic message, or the message is incorrect"); + } + } + } + +} diff --git a/jdk/test/lib/testlibrary/jdk/testlibrary/FileUtils.java b/jdk/test/lib/testlibrary/jdk/testlibrary/FileUtils.java new file mode 100644 index 00000000000..161e222ed46 --- /dev/null +++ b/jdk/test/lib/testlibrary/jdk/testlibrary/FileUtils.java @@ -0,0 +1,169 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package jdk.testlibrary; + +import java.io.IOException; +import java.nio.file.DirectoryNotEmptyException; +import java.nio.file.FileVisitResult; +import java.nio.file.Files; +import java.nio.file.NoSuchFileException; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; +import java.util.ArrayList; +import java.util.List; + + +/** + * Common library for various test file utility functions. + */ +public final class FileUtils { + + private static final boolean isWindows = + System.getProperty("os.name").startsWith("Windows"); + private static final int RETRY_DELETE_MILLIS = isWindows ? 500 : 0; + private static final int MAX_RETRY_DELETE_TIMES = isWindows ? 15 : 0; + + /** + * Deletes a file, retrying if necessary. + * + * @param path the file to delete + * + * @throws NoSuchFileException + * if the file does not exist (optional specific exception) + * @throws DirectoryNotEmptyException + * if the file is a directory and could not otherwise be deleted + * because the directory is not empty (optional specific exception) + * @throws IOException + * if an I/O error occurs + */ + public static void deleteFileWithRetry(Path path) + throws IOException + { + try { + deleteFileWithRetry0(path); + } catch (InterruptedException x) { + throw new IOException("Interrupted while deleting.", x); + } + } + + private static void deleteFileWithRetry0(Path path) + throws IOException, InterruptedException + { + int times = 0; + IOException ioe = null; + while (true) { + try { + Files.delete(path); + while (Files.exists(path)) { + times++; + if (times > MAX_RETRY_DELETE_TIMES) + throw new IOException("File still exists after " + times + " waits."); + Thread.sleep(RETRY_DELETE_MILLIS); + } + break; + } catch (NoSuchFileException | DirectoryNotEmptyException x) { + throw x; + } catch (IOException x) { + // Backoff/retry in case another process is accessing the file + times++; + if (ioe == null) + ioe = x; + else + ioe.addSuppressed(x); + + if (times > MAX_RETRY_DELETE_TIMES) + throw ioe; + Thread.sleep(RETRY_DELETE_MILLIS); + } + } + } + + /** + * Deletes a directory and its subdirectories, retrying if necessary. + * + * @param dir the directory to delete + * + * @throws IOException + * If an I/O error occurs. Any such exceptions are caught + * internally. If only one is caught, then it is re-thrown. + * If more than one exception is caught, then the second and + * following exceptions are added as suppressed exceptions of the + * first one caught, which is then re-thrown. + */ + public static void deleteFileTreeWithRetry(Path dir) + throws IOException + { + IOException ioe = null; + final List excs = deleteFileTreeUnchecked(dir); + if (!excs.isEmpty()) { + ioe = excs.remove(0); + for (IOException x : excs) + ioe.addSuppressed(x); + } + if (ioe != null) + throw ioe; + } + + public static List deleteFileTreeUnchecked(Path dir) { + final List excs = new ArrayList<>(); + try { + java.nio.file.Files.walkFileTree(dir, new SimpleFileVisitor() { + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) { + try { + deleteFileWithRetry0(file); + } catch (IOException x) { + excs.add(x); + } catch (InterruptedException x) { + excs.add(new IOException("Interrupted while deleting.", x)); + return FileVisitResult.TERMINATE; + } + return FileVisitResult.CONTINUE; + } + @Override + public FileVisitResult postVisitDirectory(Path dir, IOException exc) { + try { + deleteFileWithRetry0(dir); + } catch (IOException x) { + excs.add(x); + } catch (InterruptedException x) { + excs.add(new IOException("Interrupted while deleting.", x)); + return FileVisitResult.TERMINATE; + } + return FileVisitResult.CONTINUE; + } + @Override + public FileVisitResult visitFileFailed(Path file, IOException exc) { + excs.add(exc); + return FileVisitResult.CONTINUE; + } + }); + } catch (IOException x) { + excs.add(x); + } + return excs; + } +} + diff --git a/jdk/test/lib/testlibrary/jdk/testlibrary/InputArguments.java b/jdk/test/lib/testlibrary/jdk/testlibrary/InputArguments.java new file mode 100644 index 00000000000..a2f0f3fa085 --- /dev/null +++ b/jdk/test/lib/testlibrary/jdk/testlibrary/InputArguments.java @@ -0,0 +1,88 @@ +/* + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package jdk.testlibrary; + +import java.lang.management.RuntimeMXBean; +import java.lang.management.ManagementFactory; +import java.util.List; + +/** + * This class provides access to the input arguments to the VM. + */ +public class InputArguments { + private static final List args; + + static { + RuntimeMXBean runtimeMxBean = ManagementFactory.getRuntimeMXBean(); + args = runtimeMxBean.getInputArguments(); + } + + /** + * Returns true if {@code arg} is an input argument to the VM. + * + * This is useful for checking boolean flags such as -XX:+UseSerialGC or + * -XX:-UsePerfData. + * + * @param arg The name of the argument. + * @return {@code true} if the given argument is an input argument, + * otherwise {@code false}. + */ + public static boolean contains(String arg) { + return args.contains(arg); + } + + /** + * Returns true if {@code prefix} is the start of an input argument to the + * VM. + * + * This is useful for checking if flags describing a quantity, such as + * -XX:+MaxMetaspaceSize=100m, is set without having to know the quantity. + * To check if the flag -XX:MaxMetaspaceSize is set, use + * {@code InputArguments.containsPrefix("-XX:MaxMetaspaceSize")}. + * + * @param prefix The start of the argument. + * @return {@code true} if the given argument is the start of an input + * argument, otherwise {@code false}. + */ + public static boolean containsPrefix(String prefix) { + for (String arg : args) { + if (arg.startsWith(prefix)) { + return true; + } + } + return false; + } + + /** + * Get the string containing input arguments passed to the VM + */ + public static String getInputArguments() { + StringBuilder result = new StringBuilder(); + for (String arg : args) + result.append(arg).append(' '); + + return result.toString(); + } + +} diff --git a/jdk/test/lib/testlibrary/jdk/testlibrary/JcmdBase.java b/jdk/test/lib/testlibrary/jdk/testlibrary/JcmdBase.java index de5807f9bec..14599c998bd 100644 --- a/jdk/test/lib/testlibrary/jdk/testlibrary/JcmdBase.java +++ b/jdk/test/lib/testlibrary/jdk/testlibrary/JcmdBase.java @@ -23,8 +23,11 @@ package jdk.testlibrary; -import java.util.ArrayList; +import java.util.Arrays; +/** + * Super class for tests which need to attach jcmd to the current process. + */ public class JcmdBase { private static ProcessBuilder processBuilder = new ProcessBuilder(); @@ -32,46 +35,24 @@ public class JcmdBase { /** * Attach jcmd to the current process * - * @param commandArgs - * jcmd command line parameters, e.g. JFR.start + * @param toolArgs + * jcmd command line parameters, e.g. VM.flags * @return jcmd output * @throws Exception */ - public final static OutputAnalyzer jcmd(String... commandArgs) + public final static OutputAnalyzer jcmd(String... toolArgs) throws Exception { - ArrayList cmd = new ArrayList(); - String cmdString = ""; - - // jcmd from the jdk to be tested - String jcmdPath = JdkFinder.getTool("jcmd", false); - cmd.add(jcmdPath); - cmdString += jcmdPath; - - String pid = Integer.toString(ProcessTools.getProcessId()); - cmd.add(pid); - cmdString += " " + pid; - - for (int i = 0; i < commandArgs.length; i++) { - cmd.add(commandArgs[i]); - cmdString += " " + commandArgs[i]; + JDKToolLauncher launcher = JDKToolLauncher.createUsingTestJDK("jcmd"); + launcher.addToolArg(Integer.toString(ProcessTools.getProcessId())); + for (String toolArg : toolArgs) { + launcher.addToolArg(toolArg); } - - // Log command line for debugging purpose - System.out.println("Command line:"); - System.out.println(cmdString); - - processBuilder.command(cmd); + processBuilder.command(launcher.getCommand()); + System.out.println(Arrays.toString(processBuilder.command().toArray()).replace(",", "")); OutputAnalyzer output = new OutputAnalyzer(processBuilder.start()); - - // Log output for debugging purpose - System.out.println("Command output:"); System.out.println(output.getOutput()); - if (output.getExitValue() != 0) { - throw new Exception(processBuilder.command() - + " resulted in exit value " + output.getExitValue() - + " , expected to get 0"); - } + output.shouldHaveExitValue(0); return output; } diff --git a/jdk/test/lib/testlibrary/jdk/testlibrary/JdkFinder.java b/jdk/test/lib/testlibrary/jdk/testlibrary/JdkFinder.java deleted file mode 100644 index d109778f22a..00000000000 --- a/jdk/test/lib/testlibrary/jdk/testlibrary/JdkFinder.java +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * This code is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License version 2 only, as - * published by the Free Software Foundation. - * - * This code is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License - * version 2 for more details (a copy is included in the LICENSE file that - * accompanied this code). - * - * You should have received a copy of the GNU General Public License version - * 2 along with this work; if not, write to the Free Software Foundation, - * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. - * - * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA - * or visit www.oracle.com if you need additional information or have any - * questions. - */ - -package jdk.testlibrary; - -import java.io.File; - -public final class JdkFinder { - - private JdkFinder() { - } - - private static String getExecutable(String executable, String property) { - String binPath = System.getProperty(property); - if (binPath == null) { - throw new RuntimeException( - "System property '" + property + "' not set"); - } - - binPath += File.separatorChar + "bin" + File.separatorChar + executable; - - return binPath; - } - - /** - * Returns the full path to a java launcher in jdk/bin based on system - * property. - * - * @param stableJdk - * see {@link #getTool(String, boolean)} - * @return Full path to a java launcher in jdk/bin. - */ - public static String getJavaLauncher(boolean stableJdk) { - return getTool("java", stableJdk); - } - - /** - * Returns the full path to an executable in jdk/bin based on system - * property. Depending on value of {@code stableJdk} the method will look for - * either 'compile.jdk' or 'test.jdk' system properties. - * 'test.jdk' is normally set by jtreg. When running test separately, - * set this property using '-Dtest.jdk=/path/to/jdk'. - * - * @param stableJdk - * If {@code true} the {@code tool} will be retrieved - * from the compile (stable) JDK. - * If {@code false} the {@code tool} will be retrieved - * from the test JDK. - * @return Full path to an executable in jdk/bin. - */ - public static String getTool(String tool, boolean stableJdk) { - if (stableJdk) { - return getExecutable(tool, "compile.jdk"); - } else { - return getExecutable(tool, "test.jdk"); - } - } -} diff --git a/jdk/test/lib/testlibrary/jdk/testlibrary/OutputAnalyzer.java b/jdk/test/lib/testlibrary/jdk/testlibrary/OutputAnalyzer.java index ba02081398a..d4cbd27fa9b 100644 --- a/jdk/test/lib/testlibrary/jdk/testlibrary/OutputAnalyzer.java +++ b/jdk/test/lib/testlibrary/jdk/testlibrary/OutputAnalyzer.java @@ -27,6 +27,9 @@ import java.io.IOException; import java.util.regex.Matcher; import java.util.regex.Pattern; +/** + * Utility class for verifying output and exit value from a {@code Process}. + */ public final class OutputAnalyzer { private final String stdout; @@ -85,9 +88,9 @@ public final class OutputAnalyzer { public void shouldContain(String expectedString) { if (!stdout.contains(expectedString) && !stderr.contains(expectedString)) { + reportDiagnosticSummary(); throw new RuntimeException("'" + expectedString - + "' missing from stdout/stderr: [" + stdout + stderr - + "]\n"); + + "' missing from stdout/stderr \n"); } } @@ -101,8 +104,9 @@ public final class OutputAnalyzer { */ public void stdoutShouldContain(String expectedString) { if (!stdout.contains(expectedString)) { + reportDiagnosticSummary(); throw new RuntimeException("'" + expectedString - + "' missing from stdout: [" + stdout + "]\n"); + + "' missing from stdout \n"); } } @@ -116,8 +120,9 @@ public final class OutputAnalyzer { */ public void stderrShouldContain(String expectedString) { if (!stderr.contains(expectedString)) { + reportDiagnosticSummary(); throw new RuntimeException("'" + expectedString - + "' missing from stderr: [" + stderr + "]\n"); + + "' missing from stderr \n"); } } @@ -132,12 +137,14 @@ public final class OutputAnalyzer { */ public void shouldNotContain(String notExpectedString) { if (stdout.contains(notExpectedString)) { + reportDiagnosticSummary(); throw new RuntimeException("'" + notExpectedString - + "' found in stdout: [" + stdout + "]\n"); + + "' found in stdout \n"); } if (stderr.contains(notExpectedString)) { + reportDiagnosticSummary(); throw new RuntimeException("'" + notExpectedString - + "' found in stderr: [" + stderr + "]\n"); + + "' found in stderr \n"); } } @@ -152,8 +159,9 @@ public final class OutputAnalyzer { */ public void stdoutShouldNotContain(String notExpectedString) { if (stdout.contains(notExpectedString)) { + reportDiagnosticSummary(); throw new RuntimeException("'" + notExpectedString - + "' found in stdout: [" + stdout + "]\n"); + + "' found in stdout \n"); } } @@ -168,55 +176,63 @@ public final class OutputAnalyzer { */ public void stderrShouldNotContain(String notExpectedString) { if (stderr.contains(notExpectedString)) { + reportDiagnosticSummary(); throw new RuntimeException("'" + notExpectedString - + "' found in stderr: [" + stderr + "]\n"); + + "' found in stderr \n"); } } /** - * Verify that the stdout and stderr contents of output buffer matches - * the pattern + * Verify that the stdout and stderr contents of output buffer matches the + * pattern * * @param pattern - * @throws RuntimeException If the pattern was not found + * @throws RuntimeException + * If the pattern was not found */ public void shouldMatch(String pattern) { - Matcher stdoutMatcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stdout); - Matcher stderrMatcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stderr); + Matcher stdoutMatcher = Pattern.compile(pattern, Pattern.MULTILINE) + .matcher(stdout); + Matcher stderrMatcher = Pattern.compile(pattern, Pattern.MULTILINE) + .matcher(stderr); if (!stdoutMatcher.find() && !stderrMatcher.find()) { + reportDiagnosticSummary(); throw new RuntimeException("'" + pattern - + "' missing from stdout/stderr: [" + stdout + stderr - + "]\n"); + + "' missing from stdout/stderr \n"); } } /** - * Verify that the stdout contents of output buffer matches the - * pattern + * Verify that the stdout contents of output buffer matches the pattern * * @param pattern - * @throws RuntimeException If the pattern was not found + * @throws RuntimeException + * If the pattern was not found */ public void stdoutShouldMatch(String pattern) { - Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stdout); + Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher( + stdout); if (!matcher.find()) { + reportDiagnosticSummary(); throw new RuntimeException("'" + pattern - + "' missing from stdout: [" + stdout + "]\n"); + + "' missing from stdout \n"); } } /** - * Verify that the stderr contents of output buffer matches the - * pattern + * Verify that the stderr contents of output buffer matches the pattern * * @param pattern - * @throws RuntimeException If the pattern was not found + * @throws RuntimeException + * If the pattern was not found */ public void stderrShouldMatch(String pattern) { - Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stderr); + Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher( + stderr); if (!matcher.find()) { + reportDiagnosticSummary(); throw new RuntimeException("'" + pattern - + "' missing from stderr: [" + stderr + "]\n"); + + "' missing from stderr \n"); } } @@ -225,18 +241,22 @@ public final class OutputAnalyzer { * match the pattern * * @param pattern - * @throws RuntimeException If the pattern was found + * @throws RuntimeException + * If the pattern was found */ public void shouldNotMatch(String pattern) { - Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stdout); + Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher( + stdout); if (matcher.find()) { - throw new RuntimeException("'" + pattern - + "' found in stdout: [" + stdout + "]\n"); + reportDiagnosticSummary(); + throw new RuntimeException("'" + pattern + "' found in stdout: '" + + matcher.group() + "' \n"); } matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stderr); if (matcher.find()) { - throw new RuntimeException("'" + pattern - + "' found in stderr: [" + stderr + "]\n"); + reportDiagnosticSummary(); + throw new RuntimeException("'" + pattern + "' found in stderr: '" + + matcher.group() + "' \n"); } } @@ -245,13 +265,15 @@ public final class OutputAnalyzer { * pattern * * @param pattern - * @throws RuntimeException If the pattern was found + * @throws RuntimeException + * If the pattern was found */ public void stdoutShouldNotMatch(String pattern) { - Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stdout); + Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher( + stdout); if (matcher.find()) { - throw new RuntimeException("'" + pattern - + "' found in stdout: [" + stdout + "]\n"); + reportDiagnosticSummary(); + throw new RuntimeException("'" + pattern + "' found in stdout \n"); } } @@ -260,18 +282,56 @@ public final class OutputAnalyzer { * pattern * * @param pattern - * @throws RuntimeException If the pattern was found + * @throws RuntimeException + * If the pattern was found */ public void stderrShouldNotMatch(String pattern) { - Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher(stderr); + Matcher matcher = Pattern.compile(pattern, Pattern.MULTILINE).matcher( + stderr); if (matcher.find()) { - throw new RuntimeException("'" + pattern - + "' found in stderr: [" + stderr + "]\n"); + reportDiagnosticSummary(); + throw new RuntimeException("'" + pattern + "' found in stderr \n"); } } /** - * Verifiy the exit value of the process + * Get the captured group of the first string matching the pattern. stderr + * is searched before stdout. + * + * @param pattern + * The multi-line pattern to match + * @param group + * The group to capture + * @return The matched string or null if no match was found + */ + public String firstMatch(String pattern, int group) { + Matcher stderrMatcher = Pattern.compile(pattern, Pattern.MULTILINE) + .matcher(stderr); + Matcher stdoutMatcher = Pattern.compile(pattern, Pattern.MULTILINE) + .matcher(stdout); + if (stderrMatcher.find()) { + return stderrMatcher.group(group); + } + if (stdoutMatcher.find()) { + return stdoutMatcher.group(group); + } + return null; + } + + /** + * Get the first string matching the pattern. stderr is searched before + * stdout. + * + * @param pattern + * The multi-line pattern to match + * @return The matched string or null if no match was found + */ + public String firstMatch(String pattern) { + return firstMatch(pattern, 0); + } + + /** + * Verify the exit value of the process * * @param expectedExitValue * Expected exit value from process @@ -281,11 +341,24 @@ public final class OutputAnalyzer { */ public void shouldHaveExitValue(int expectedExitValue) { if (getExitValue() != expectedExitValue) { - throw new RuntimeException("Exit value " + getExitValue() - + " , expected to get " + expectedExitValue); + reportDiagnosticSummary(); + throw new RuntimeException("Expected to get exit value of [" + + expectedExitValue + "]\n"); } } + /** + * Report summary that will help to diagnose the problem Currently includes: + * - standard input produced by the process under test - standard output - + * exit code Note: the command line is printed by the ProcessTools + */ + private void reportDiagnosticSummary() { + String msg = " stdout: [" + stdout + "];\n" + " stderr: [" + stderr + + "]\n" + " exitValue = " + getExitValue() + "\n"; + + System.err.println(msg); + } + /** * Get the contents of the output buffer (stdout and stderr) * diff --git a/jdk/test/lib/testlibrary/jdk/testlibrary/ProcessTools.java b/jdk/test/lib/testlibrary/jdk/testlibrary/ProcessTools.java index 29b4e38b1f6..6ed9f30d711 100644 --- a/jdk/test/lib/testlibrary/jdk/testlibrary/ProcessTools.java +++ b/jdk/test/lib/testlibrary/jdk/testlibrary/ProcessTools.java @@ -25,10 +25,7 @@ package jdk.testlibrary; import java.io.ByteArrayOutputStream; import java.io.IOException; -import java.io.OutputStream; -import java.io.OutputStreamWriter; import java.io.PrintStream; -import java.io.PrintWriter; import java.lang.management.ManagementFactory; import java.lang.management.RuntimeMXBean; import java.lang.reflect.Field; @@ -237,15 +234,20 @@ public final class ProcessTools { */ public static ProcessBuilder createJavaProcessBuilder(String... command) throws Exception { - String javapath = JdkFinder.getJavaLauncher(false); + String javapath = JDKToolFinder.getJDKTool("java"); ArrayList args = new ArrayList<>(); args.add(javapath); Collections.addAll(args, getPlatformSpecificVMArgs()); Collections.addAll(args, command); - return new ProcessBuilder(args.toArray(new String[args.size()])); + // Reporting + StringBuilder cmdLine = new StringBuilder(); + for (String cmd : args) + cmdLine.append(cmd).append(' '); + System.out.println("Command line: [" + cmdLine.toString() + "]"); + return new ProcessBuilder(args.toArray(new String[args.size()])); } } diff --git a/jdk/test/sun/java2d/cmm/ColorConvertOp/ConstructorsNullTest/ConstructorsNullTest.html b/jdk/test/sun/java2d/cmm/ColorConvertOp/ConstructorsNullTest/ConstructorsNullTest.html index 88f81f1e9e2..e874bad4607 100644 --- a/jdk/test/sun/java2d/cmm/ColorConvertOp/ConstructorsNullTest/ConstructorsNullTest.html +++ b/jdk/test/sun/java2d/cmm/ColorConvertOp/ConstructorsNullTest/ConstructorsNullTest.html @@ -1,3 +1,26 @@ + +